AmazonCreateRedshiftSnapshotParameters Object

Description

Parameters for the Amazon Create Redshift Snapshot action.

Properties

credentialIds

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

Type: Array of string

Required: Yes

clusterId

ID of the Redshift cluster to backup. Required when clusterIdentificationMethod is by-cluster-id.

Type: Array of string

Required: Conditional

clusterIdentificationMethod

Method of identifying the Redshift cluster from which the snapshot will be created.

Type: string

Valid Values:

  • by-cluster-id

Required: Yes

regionNames

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

Type: Array of string

Required: Yes

snapshotId

ID of the snapshot that will be created.

Type: string

Required: Yes

tags

Resource tags to add to the snapshot.

Type: Array of Tag object.

Required: No

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],
    
    "clusterIdentificationMethod": "by-cluster-id",
    "clusterId": "my-cluster"

    "snapshotId": "$(CLUSTERID)-$(DATE)",
    "tags": [
        {
            "key": "skeddly:cluster-id",
            "value": "$(CLUSTERID)"
        }
    ]
}

Last updated