Instance / Action / create_image
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Create an Amazon EBS-backed Linux AMI in the Amazon Elastic Compute Cloud User Guide.
See also: AWS API Documentation
BlockDeviceMappings (list) –
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.
Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.
DeviceName (string) –
The device name (for example,
VirtualName (string) –
The virtual device name (
ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0and
ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) –
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) –
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
Iops (integer) –
The number of I/O operations per second (IOPS). For
io2volumes, this represents the number of IOPS that are provisioned for the volume. For
gp2volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
io2volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for
io2volumes. The default for
gp3volumes is 3,000 IOPS. This parameter is not supported for
SnapshotId (string) –
The ID of the snapshot.
VolumeSize (integer) –
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) –
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide. If the volume type is
io2, you must specify the IOPS that the volume supports.
KmsKeyId (string) –
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
Throughput (integer) –
The throughput that the volume supports, in MiB/s.
This parameter is valid only for
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) –
The ARN of the Outpost on which the snapshot is stored.
This parameter is not supported when using CreateImage.
Encrypted (boolean) –
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to
truedepends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either
truefor an encrypted volume, or
falsefor an unencrypted volume. If you omit this parameter, it defaults to
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify
false. If you specify
true, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either
false. However, if you specify
false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
NoDevice (string) –
To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
Description (string) – A description for the new image.
DryRun (boolean) – 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
Name (string) –
A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets (), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (‘), at-signs (@), or underscores(_)
NoReboot (boolean) –
Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:
true- The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots.
false- The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.
TagSpecifications (list) –
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
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
snapshot. 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.
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
Valid Valueslists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
ResourceType (string) –
The type of resource to tag on creation.
Tags (list) –
The tags to apply to the resource.
Describes a tag.
Key (string) –
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
Value (string) –
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- Return type: