AmazonCreateAmiImageParameters Object

Description

Parameters for the Amazon Create AMI Image action.

Properties

credentialIds

Registered credentials to use with the action. One and only one credential must be specified.

Type: Array of string

Required: Yes

consistencyMethod

Method used to ensure the AMI image is consistent.

Type: string

Valid Values:

• none

• reboot-instance

Required: Yes

customImageNameTag

Custom Name tag value to apply to the new AMI image. Required when setImageNameTagMethod is custom.

Type: string

Required: Conditional

customSnapshotNameTag

Custom Name tag value to apply to the new EBS snapshots. Required when setSnapshotNameTagMethod is custom.

Type: string

Required: Conditional

description

Description for the new AMI image.

Type: string

Required: No

imageName

Name for the new AMI image.

Type: string

Required: No

instanceId

ID of the EC2 instance that will have an AMI image created. Required when instanceIdentificationMethod is by-instance-id.

Type: string

Required: Conditional

instanceName

Comparison to use when identifying the EC2 instance by Name tag. Required when instanceIdentificationMethod is by-instance-name-tag.

Type: string

Required: Conditional

instanceIdentificationMethod

Method of identifying the EC2 instance.

Type: string

Valid Values:

• by-instance-id

• by-instance-name-tag

Required: Yes

regionNames

Regions to use with the action. One and only one region must be specified.

Type: Array of string

Required: Yes

setImageNameTagMethod

Method to use when setting the Name tag of the new AMI image.

Type: string

Valid Values:

• none

• same-as-image-name

• custom

Required: No

Default: none

setSnapshotNameTagMethod

Method to use when setting the Name tag of the new EBS snapshots.

Type: string

Valid Values:

• none

• same-as-image-name

• same-as-image-name-tag

• custom

Required: No

Default: none

tags

Resource tags to apply to the new AMI image and EBS snapshots.

Type: Array of AmiImageTag objects

Required: No

targetCredentialId

Credential ID of the AWS credentials to copy the the resulting AMI image. Eg. cred-12345678. When setting this field, also set the targetRegionName field.

Type: string

Required: No

targetRegionName

Name of a secondary region to copy the resulting AMI image. Must be a valid region. Eg. us-east-1

Type: string

Required: No

volumeChanges

Changes to make to the volumes for the AMI image.

Type: AmiImageVolumeChanges object

Required: No

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],
    "instanceIdentificationMethod": "by-instance-id",
    "instanceId": "i-11111111",

    "imageName": "$(INSTANCEID)-$(DATE)",
    "description": "Created from $(INSTANCEID)",
    "consistencyMethod": "reboot-instance",

    "setImageNameTagMethod": "same-as-image-name",
    "setSnapshotNameTagMethod": "same-as-image-name",

    "tags": [
        {
            "key": "skeddly:instance-id",
            "value": "$(INSTANCEID)",
            "addToImage": true,
            "addToSnapshots": true
        },
        {
            "key": "skeddly:source-image-id",
            "value": "$(IMAGEID)",
            "addToImage": true,
            "addToSnapshots": true
        }
    ],

    "targetRegionName": "ca-central-1"
}