create_image¶
Operation¶
async
¶
create_image(input: CreateImageInput, plugins: list[Plugin] | None = None) -> CreateImageOutput
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.
The location of the source instance determines where you can create the snapshots of the AMI:
-
If the source instance is in a Region, you must create the snapshots in the same Region as the instance.
-
If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Region.
-
If the source instance is on an Outpost that supports local snapshots, you can create the snapshots on the same Outpost or in the parent Region of that Outpost. In this case, you must use the
SnapshotLocationparameter to specify where to create the snapshots.
For more information, see Create an Amazon EBS-backed AMI in the Amazon Elastic Compute Cloud User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateImageInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateImageOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateImageInput structure.
Attributes¶
class-attribute
instance-attribute
¶
block_device_mappings: list[BlockDeviceMapping] | None = ...
The block device mappings.
When using the CreateImage action:
-
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
-
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), copy the image instead.
-
The only option that can be changed for existing mappings or snapshots is
DeleteOnTermination.
class-attribute
instance-attribute
¶
boot_mode_override: str | None = ...
The boot mode of the new image, which overrides the default boot mode.
By default, if you do not specify this parameter, the new image inherits
the boot-mode from the source instance.
A value of uefi indicates that the image only supports UEFI boot mode.
You can specify this parameter only if the current-instance-boot-mode
of the source instance is uefi. To find the boot-mode or
current-instance-boot-mode of an instance, see
DescribeInstances.
Note
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the new image.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
instance_id: str | None = ...
The ID of the instance.
class-attribute
instance-attribute
¶
name: str | None = ...
A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
class-attribute
instance-attribute
¶
no_reboot: bool | None = ...
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.
Default: false
class-attribute
instance-attribute
¶
snapshot_location: str | None = ...
Note
Only supported for instances in Local Zones and for instances on Outposts that support local snapshots. If the source instance is not in one of these locations, omit this parameter.
The Amazon S3 location where the snapshots will be stored.
-
To create local snapshots in the same Local Zone or on the same Outpost as the source instance, specify
local. -
To create regional snapshots in the parent Region of the Local Zone or Outpost, specify
regional.
If the source instance is in a Local Zone and you omit this parameter, regional snapshots are created in the parent Region of the Local Zone.
If the source instance is on an Outpost that supports local snapshots,
this parameter is required. If you omit it, the request fails with an
InvalidParameterValue error.
Default: regional (for instances in Local Zones only)
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
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
ResourceTypemust 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
ResourceTypemust 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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateImageOutput structure.