# AmazonCreateRdsSnapshotsParameters Object

## Description

Parameters for the Amazon Create RDS Snapshots action.

## Properties

### credentialIds

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

Type: Array of `string`

Required: Yes

### instanceIdComparison

Comparison to use when identifying instances by ID. Required when `instanceIdentificationMethod` is `by-instance-id`.

Type: [RdsInstanceIdComparison](https://docs.skeddly.com/data-types/rdsinstanceidcomparison-object) object.

Required: Conditional

### instanceIdentificationMethod

Method of identifying the RDS instances from which the snapshots will be created.

Type: `string`

Valid Values:

* `all-instances`
* `by-instance-id`
* `by-resource-tag`

Required: Yes

### regionNames

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

Type: Array of `string`

Required: Yes

### resourceTagComparison

Comparison to use when identifying instances by resource tag. Required when `instanceIdentificationMethod` is `by-resource-tag`.

Type: [ResourceTagComparison](https://docs.skeddly.com/data-types/resourcetagcomparison-object-1) object.

Required: Conditional

### snapshotId

ID of the snapshots that will be created.

Type: `string`

Required: Yes

### tags

Resource tags to add to the RDS snapshot.

Type: Array of [Tag](https://docs.skeddly.com/data-types/tag-object) 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

### targetKmsKeyOverride

ID or alias of the KMS key used to encrypt the RDS snapshot when copied to a secondary region.

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

```javascript
{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],
    
    "instanceIdentificationMethod": "by-instance-id",
    "instanceIdComparison": {
        "compareType": "starts-with",
        "dbInstanceId": "prod-"
    },

    "snapshotId": "$(INSTANCEID)-$(DATE)",
    "tags": [
        {
            "key": "skeddly:instance-id",
            "value": "$(INSTANCEID)"
        }
    ],
    
    "targetRegionName": "us-west-2",
    "targetCredentialId": "cred-00000002",
    "targetKmsKeyOverride": "prodKey"
}
```