AWSEC2ReplicateImageRequest
Objective-C
@interface AWSEC2ReplicateImageRequest
Swift
class AWSEC2ReplicateImageRequest
Contains the parameters for CopyImage.
Required parameters: [Name, SourceImageId, SourceRegion]
-
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable clientToken;
Swift
var clientToken: String? { get set }
-
A description for the new AMI in the destination Region.
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 AMI. Only specify this parameter when copying an AMI from an AWS Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable destinationOutpostArn;
Swift
var destinationOutpostArn: 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 isUnauthorizedOperation
.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable dryRun;
Swift
var dryRun: NSNumber? { get set }
-
Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using
KmsKeyId
. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable encrypted;
Swift
var encrypted: NSNumber? { get set }
-
The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to
true
.You can specify a CMK 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.
AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified CMK must exist in the destination Region.
Amazon EBS does not support asymmetric CMKs.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable kmsKeyId;
Swift
var kmsKeyId: String? { get set }
-
The name of the new AMI in the destination Region.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable name;
Swift
var name: String? { get set }
-
The ID of the AMI to copy.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable sourceImageId;
Swift
var sourceImageId: String? { get set }
-
The name of the Region that contains the AMI to copy.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable sourceRegion;
Swift
var sourceRegion: String? { get set }