Create AMI Image Actions
Matt Houser avatar
Written by Matt Houser
Updated over a week ago

Description

The Create AMI Image action will create a AMI image of an EC2 instance.

For example, an AMI image can be created every day at 1am.

Important Note

By default, EC2 instances will be stopped before the AMI image is created. This is to ensure that the EBS volume is in a consistent state. This can be overridden, but it is not recommended. After the image creation has begun, the instance is restarted.

Settings

Please see Common Action Settings for a description of settings common to all action types.

Instance Identification Method

Indicate the method in which the instance is to be identified. Valid options are:

  • Instance ID - Identify the instance by it's unique instance ID value.

  • Instance Name - Identify the instance by it's "Name" tag.

Instance ID

Indicate the instance id of your EC2 instance. This value usually looks like "i-84a3dc7b". This instance must reside in the region specified. Required only if Instance Identification Method is set to "Instance ID".

Instance Name

Indicate the value of the "Name" tag of the EC2 instance. This instance must reside in the region specified. Required only if Instance Identification Method is set to "Instance Name".

Image Name

Specify the name of the image. Macros can be used to include run-time data.

Description

Optional. The image can have a description saved with it. Macros can be used to include run-time data. 

No Reboot

Enable this option if the image should be created without rebooting.

Set Name Tag Method

After the image is complete, the resulting AMI image can have it's Name tag assigned.. The following values are permitted:

  • None - do not set the name tag of the image.

  • Same as image name - Set the name tag of the image the same as the AMI image name.

  • Custom - Set the name tag of the AMI image using a custom value. See Name Tag below.

Name Tag

When "Set Name Tag Method" is set to "Custom", specify the custom value to set. Macros can be used to include run-time data.

Set Snapshot Name Method

After the image is complete, the resulting EBS snapshots can be given names. The following values are permitted:

  • None - do not name the snapshots.

  • Same as image name - name the snapshots the same as the AMI image name.

  • Same as image name tag - name the snapshots the same as the AMI image name tag.

  • Custom - name the snapshots using a custom value. See Snapshot Name below.

Snapshot Name

When "Set Snapshot Name Method" is set to "Custom", specify the custom value to set. Macros can be used to include run-time data.

Target Region to Copy AMI

Once the image is complete, it can be copied to a different region. If the image should be copied, select the target region. Otherwise, leave as "None".

Target Credential

Specify the AWS credential to which the image should be copied. To copy the image using the same AWS account, leave as "Same Credentials".

Target KMS Key Override

Optional. To override the default KMS key used to encrypt the copy, specify the KMS key's ID, ARN, or alias. The key must exist in the target region.

Amazon Commands Used

The following Amazon AWS commands are used. The access key should have permission to execute all of them.

  • ec2:CreateImage

  • ec2:CreateTags

  • ec2:DescribeImages

  • ec2:DescribeInstances

  • ec2:DescribeSnapshots

  • ec2:DescribeVolumes

Did this answer your question?