AWSEC2ReplicateSnapshotRequest

Objective-C

@interface AWSEC2ReplicateSnapshotRequest

Swift

class AWSEC2ReplicateSnapshotRequest
  • A description for the EBS snapshot.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }
  • The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

    For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable destinationOutpostArn;

    Swift

    var destinationOutpostArn: String? { get set }
  • The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

    The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable destinationRegion;

    Swift

    var destinationRegion: String? { get set }
  • Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable dryRun;

    Swift

    var dryRun: NSNumber? { get set }
  • To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable encrypted;

    Swift

    var encrypted: NSNumber? { get set }
  • The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

    You can specify the KMS key using any of the following:

    • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

    • Key alias. For example, alias/ExampleAlias.

    • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

    Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable kmsKeyId;

    Swift

    var kmsKeyId: String? { get set }
  • When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.

    The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable presignedUrl;

    Swift

    var presignedUrl: String? { get set }
  • The ID of the Region that contains the snapshot to be copied.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sourceRegion;

    Swift

    var sourceRegion: String? { get set }
  • The ID of the EBS snapshot to copy.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sourceSnapshotId;

    Swift

    var sourceSnapshotId: String? { get set }
  • The tags to apply to the new snapshot.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2TagSpecification *> *_Nullable tagSpecifications;

    Swift

    var tagSpecifications: [AWSEC2TagSpecification]? { get set }