AmazonCreateLightsailInstanceSnapshotsParameters Object

Description

Parameters for the Amazon Create Lightsail Instance Snapshots action.

Properties

consistencyMethod

Consistency method to use when creating the snapshots.

Type: string

Valid Values:

• none

• stop-instance

Required: Yes

credentialIds

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

Type: Array of string

Required: Yes

instanceIdentificationMethod

Method to use to identify the instances for which snapshots will be created.

Type: string

Valid Values:

• all-instances

• by-instance-name

Required: Yes

instanceNameComparison

Comparison to use when comparing instance names. Required when instanceIdentificationMethod is by-instance-name.

Type: LightsailInstanceNameComparison object

Required: Conditional

regionNames

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

Type: Array of string

Required: Yes

snapshotName

Name of the snapshots to be created.

Type: string

Required: Yes

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],
    
    "instanceIdentificationMethod": "by-instance-name",
    "instanceNameComparison": {
        "compareType": "starts-with",
        "instanceName": "prod-"
    },
    
    "snapshotName": "$(INSTANCENAME)-$(DATE)",
    "consistencyMethod": "stop-instance"
}