Data Types

AmazonCreateRdsSnapshotParameters Object

Description

Parameters for the Amazon Create RDS 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

dbInstanceId

ID of the RDS instance to backup. Required when instanceIdentificationMethod is by-instance-id.

Type: Array of string

Required: Conditional

instanceIdentificationMethod

Method of identifying the RDS instance from which the snapshot will be created.

Type: string

Valid Values:

  • by-instance-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 RDS snapshot.

Type: Array of Tag object.

Required: No

targetCredentialId

Credential ID of the AWS credentials to copy the the resulting RDS snapshot. 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 RDS snapshot. Must be a valid region. Eg. us-east-1

Type: string

Required: No

Sample JSON

{
"credentialIds": [
"cred-00000001"
],
"regionNames": [
"us-east-1"
],
"instanceIdentificationMethod": "by-instance-id",
"dbInstanceId": "my-rds-instance"
"snapshotId": "$(INSTANCEID)-$(DATE)",
"tags": [
{
"key": "skeddly:instance-id",
"value": "$(INSTANCEID)"
}
],
"targetRegionName": "us-west-2",
"targetCredentialId": "cred-00000002"
}