AmazonDeleteEbsVolumesParameters Object

Description

Parameters for the Amazon Delete EBS Volumes action.

Properties

createEbsSnapshot

Indicates that EBS snapshots should be created for volumes before they are deleted.

Type: CreateEbsSnapshot object

Required: No

credentialIds

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

Type: Array of string

Required: Yes

daysDetached

Indicates that detach tracking should be used for the volumes.

Type: DaysDetached object

Required: No

isTest

Indicates whether "Test Mode" should be enabled.

Type: boolean

Required: No

Default: 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 volumes by resource tag. Required when volumeIdentificationMethod is by-resource-tag.

Type: ResourceTagComparison 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

volumeIdentificationMethod

Method of identifying the EBS volumes.

Type: string

Valid Values:

• all-volumes

• by-volume-id

• by-resource-tag

Required: Yes

volumeIds

Volume IDs of the EBS volumes to backup. Required when volumeIdentificationMethod is by-volume-id.

Type: Array of string

Required: Conditional

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1",
        "us-east-2"
    ],
    "volumeIdentificationMethod": "by-volume-id",
    "volumeIds": [
        "vol-11111111",
        "vol-22222222"
    ],

    "daysDetached": {
        "NumDays": 7,
        "ResourceTagName": "tagName"
    },
    "createEbsSnapshot": {
        "description": "desc1",
        "snapshotName": "name1",
        "tags": [
            {
                "key": "tagName", 
                "value": "tagValue"
            }
        ]
    },

    "targetType": "email",
    "targetEmails": [
        "[email protected]"
    ],
    "ReportFormat": "email",

    "isTest": true
}