AmazonCreateDirectoryServiceSnapshotsParameters Object

Description

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

directoryIdentificationMethod

Method to use to identify the directories for which snapshots will be created.

Type: string

Valid Values:

• all-directories

• by-directory-id

• by-directory-name

Required: Yes

directoryIds

IDs of the directories for which snapshots will be created. One and only one ID must be specified. Required when directoryIdentificationMethod is by-directory-id.

Type: Array of string

Required: Conditional

directoryNames

Names of the directories for which snapshots will be created. One and only one name must be specified. Required when directoryIdentificationMethod is by-directory-name.

Type: Array of string

Required: Conditional

regionNames

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

Type: Array of string

Required: Yes

snapshotName

Name of the snapshots to create.

Type: string

Required: No

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],
    
    "directoryIdentificationMethod": "all-directories",
    
    "snapshotName": "$(DIRECTORYNAME)-$(DATE)"
}