AmazonDeleteRdsSnapshotsParameters Object

Description

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

deleteScheme

Delete scheme to use to determine the snapshots to delete or preserve.

Type: string

Valid Values:

• none

• first-in-first-out

• grandfather-father-son

Required: Yes

firstInFirstOutParameters

Parameters to use when using a first-in-first-out delete scheme. Required when deleteScheme is first-in-first-out.

Type: FirstInFirstOutDeleteSchemeParameters​ object

Required: Conditional

grandfatherFatherSonParameters

Parameters to use when using a grandfather-father-son delete scheme. Required when deleteScheme is grandfather-father-son.

Type: GrandfatherFatherSonDeleteSchemeParameters​ object

Required: Conditional

groupingMethod

Method in which to group snapshots when deleting.

Type: string

Valid Values:

• none

• by-source-id

• by-resource-tag

Required: Yes

groupingResourceTagName

Name of the resource tag to use to group snapshots. Required when groupingMethod is by-resource-tag.

Type: string

Required: Conditional

isIncludeClusterSnapshots

Indicates whether RDS cluster snapshots (ie. Aurora) should be included as well as db snapshots.

Type: boolean

Default: true

Required: No

isTest

Determines if "Test Mode" is enabled on the action. Snapshots will not be deleted when "Test Mode" is enabled.

Type: boolean

Required: No

Default Value: false

regionNames

Regions to use with the action. Omit (or specify null) to include "all regions".

Type: Array of string

Required: No

reportFormat

Format of the final report. Required when targetType is email.

Type: string

Valid Values:

• email

• email-html-attachment

• email-csv-attachment

Required: Conditional

resourceTagComparison

Comparison to use when identifying snapshots by resource tag. Required when snapshotIdentificationMethod is by-resource-tag.

Type: ResourceTagComparison object.

Required: Conditional

snapshotIdComparison

Comparison to use when matching snapshots by their ID. Required when snapshotIdentificationMethod is by-snapshot-id.

Type: RdsSnapshotIdComparison object

Required: Conditional

snapshotIdentificationMethod

Method to use to identify snapshots to be deleted.

Type: string

Valid Values:

• all-snapshots

• by-snapshot-id

• by-source-id

• by-resource-tag

Required: Yes

sourceIdComparison

Comparison to use when matching snapshots by their source (instance or cluster) ID. Required when snapshotIdentificationMethod is by-source-id.

Type: RdsSourceIdComparison object

Required: Conditional

targetEmails

The target email addresses to send the final report.

Type: array of string

Required: No

targetType

Indicates whether a report should be generated with the execution results.

Type: string

Valid Values:

• none

• email

Required: No

Default: none

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],

    "snapshotIdentificationMethod": "by-resource-tag",
    "resourceTagComparison": {
        "tagName": "skeddly:retention",
        "compareType": "equals",
        "tagValue": "7"
    },

    "deleteScheme": "first-in-first-out",
    "firstInFirstOutParameters": {
        "olderThanDays": 30,
        "minimumToKeep": 2
    },

    "groupingMethod": "by-resource-tag",
    "groupingResourceTagName": "skeddly:volume-id",

    "isIncludeClusterSnapshots": true,

    "targetType": "email",
    "targetEmails": [
        "[email protected]"
    ],
    "ReportFormat": "email",
    
    "isTest": false
}