AWSEC2CreateImageRequest
Objective-C
@interface AWSEC2CreateImageRequest
Swift
class AWSEC2CreateImageRequest
-
The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<AWSEC2BlockDeviceMapping *> *_Nullable blockDeviceMappings;
Swift
var blockDeviceMappings: [AWSEC2BlockDeviceMapping]? { get set }
-
A description for the new image.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable detail;
Swift
var detail: 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 }
-
The ID of the instance.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable instanceId;
Swift
var instanceId: String? { get set }
-
A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (‘), at-signs (@), or underscores(_)
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable name;
Swift
var name: String? { get set }
-
By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the
NoReboot
parameter totrue
in the API request, or use the--no-reboot
option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.If you choose to bypass the shutdown and reboot process by setting the
NoReboot
parameter totrue
in the API request, or by using the--no-reboot
option in the CLI, we can’t guarantee the file system integrity of the created image.Default:
false
(follow standard reboot process)Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable noReboot;
Swift
var noReboot: NSNumber? { get set }
-
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for
ResourceType
must beimage
.To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for
ResourceType
must besnapshot
. The same tag is applied to all of the snapshots that are created.
If you specify other values for
ResourceType
, the request fails.To tag an AMI or snapshot after it has been created, see CreateTags.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<AWSEC2TagSpecification *> *_Nullable tagSpecifications;
Swift
var tagSpecifications: [AWSEC2TagSpecification]? { get set }