Data Types

AmazonCreateLightsailInstancesFromSnapshotsParameters Object

Description

Parameters for the Amazon Create Lightsail Instances from Snapshots action.

Properties

availabilityZone

Availability zone to create the new instances in.

Type: string

Required: Yes

bundleId

ID of the Lightsail bundle to use to create the new instances. If omitted, the bundle saved in the snapshot will be used.

Type: string

Required: No

credentialIds

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

Type: Array of string

Required: Yes

deleteTimeInSeconds

Indicates the amount of time (in seconds) after which the new instances will be deleted.

Type: integer

Required: No

duplicateInstanceResolutionMethod

Method to use when an existing instance is found with the desired instance name.

Type: string

Valid Values:

  • none

  • use-existing-instance

Required: Yes

finalSnapshotName

Name of the final snapshot when deleting the instances.

Type: string

Required: No

instanceNameComparison

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

Type: LightsailInstanceNameComparison object

Required: Conditional

instances

List of instances to create.

Type: Array of CreateLightsailInstancesInstance objects.

Required: Yes

keyPairName

Name of the key pair to assign to the new instances.

Type: string

Required: No

regionNames

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

Type: Array of string

Required: Yes

snapshotIdentificationMethod

Method to use to identify the snapshot used to create the new instances. If more than one snapshot is found, the most recent snapshot found will be used.

Type: string

Valid Values:

  • all-instance-snapshots

  • by-instance-name

  • by-instance-snapshot-name

Required: Yes

snapshotNameComparison

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

Type: LightsailInstanceNameComparison object

Required: Conditional

Sample JSON

{
"credentialIds": [
"cred-00000001"
],
"regionNames": [
"us-east-1"
],
"instances": [
{
"instanceName": "instance-$(DATE)",
"staticIpName": "my-static-ip"
}
],
"duplicateInstanceResolutionMethod": "none",
"snapshotIdentificationMethod": "by-instance-name",
"instanceNameComparison": {
"compareType": "starts-with",
"instanceName": "instance-"
},
"availabilityZone": "us-east-1a",
"keyPairName": "my-key-pair",
"deleteTimeInSeconds": 3600,
"finalSnapshotName": "$(INSTANCENAME)-final-$(DATE)"
}