ec2_create_image: Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped

Description

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

See https://www.paws-r-sdk.com/docs/ec2_create_image/ for full documentation.

Usage

ec2_create_image(
  BlockDeviceMappings = NULL,
  Description = NULL,
  DryRun = NULL,
  InstanceId,
  Name,
  NoReboot = NULL,
  TagSpecifications = NULL
)

Arguments

BlockDeviceMappings

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 copy_image action.

Description

A description for the new image.

DryRun

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.

InstanceId

[required] The ID of the instance.

Name

[required] 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

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 to true 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 to true 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)

TagSpecifications

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 be image.
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 be 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 create_tags.