Parameters for the Amazon Create EBS Snapshot action.
Consistency method to use when creating the EBS snapshot.
Type: string
Valid Values:
none
stop-instance
Required: Yes
Registered credentials to use with the action. One and only one credential must be specified.
Type: Array of string
Required: Yes
Indicates whether to deregister from load balancers when stopping the EC2 instance. Required when consistencyMethod
is stop-instance
.
Type: string
Valid Values:
none
all-load-balancers
Required: Conditional
Description to assign to the EBS snapshots that are created.
Type: string
Required: No
Regions to use with the action. One and only one region must be specified.
Type: Array of string
Required: Yes
Value to assign to the Name
tag of the EBS snapshot that are created.
Type: string
Required: No
Resource tags to add to the EBS snapshot.
Type: Array of Tag object.
Required: No
Credential ID of the AWS credentials to copy the the resulting EBS snapshot. Eg. cred-12345678
. When setting this field, also set the targetRegionName
field.
Type: string
Required: No
Name of a secondary region to copy the resulting EBS snapshot. Must be a valid region. Eg. us-east-1
Type: string
Required: No
Method of identifying the EBS volumes.
Type: string
Valid Values:
by-volume-id
Required: Yes
Volume ID of the EBS volume to backup. Required when volumeIdentificationMethod
is by-volume-id
.
Type: Array of string
Required: Conditional
{"credentialIds": ["cred-00000001"],"regionNames": ["us-east-1"],"volumeIdentificationMethod": "by-volume-id","volumeId": "vol-11111111"​"consistencyMethod": "stop-instance","deregisterFromLoadBalancers": "none",​"snapshotName": "$(INSTANCEID)-$(DEVICE)-$(DATE)","description": "Created by Skeddly for $(INSTANCEID) ($(INSTANCENAME))","tags": [{"key": "skeddly:instance-id","value": "$(INSTANCEID)"},{"key": "skeddly:volume-id","value": "$(VOLUMEID)"},{"key": "skeddly:device","value": "$(DEVICE)"}]}
​