Skeddly API
Search
K

AmazonTagEbsSnapshotsParameters Object

Description

Parameters for the Amazon Tag EBS Snapshots action.

Properties

copyVolumeTagsMethod

Indicates whether tags on the original EBS volumes will be copied to the EBS snapshots.
Type: string
Valid Values:
  • none
  • copy-all-tags
  • copy-existing-tags-only
  • copy-missing-tags-only
Required: Yes

credentialIds

Registered credentials to use with the action. One and only one credential must be specified.
Type: Array of string
Required: Yes

descriptionComparison

Comparison to use when identifying snapshots by comparing descriptions. Required whensnapshotIdentificationMethod is by-description.
Required: Conditional

isTest

Indicates whether Test Mode is enabled on the action.
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

resourceTagComparison

Comparison to use when identifying snapshots by resource tag. Required whensnapshotIdentificationMethod is by-resource-tag.
Type: ResourceTagComparison object.
Required: Conditional

setTagsMethod

Method used to set new tags on the EBS snapshots.
Type: string
Valid Values:
  • set-all-tags
  • add-missing-tags-only
  • replace-existing-tags-only
Required: Yes

snapshotIdentificationMethod

Method of identifying the EBS snapshots.
Type: string
Valid Values:
  • all-snapshots
  • by-snapshot-id
  • by-volume-id
  • by-description
  • by-resource-tag
Required: Yes

snapshotIds

List of snapshot IDs to tag. Required when snapshotIdentificationMethod is by-snapshot-id.
Type: Array of string
Required: Conditional

tags

List of tags to add to the EBS snapshots
Type: Array of Tag objects.
Required: No

volumeIds

List of volume IDs whose snapshots are to be tagged. Required when snapshotIdentificationMethod is by-volume-id.
Type: Array of string
Required: Conditional

Sample JSON

{
"credentialIds": [
"cred-00000001"
],
"regionNames": [
"us-east-1"
],
"snapshotIdentificationMethod": "all-snapshots"
"copyVolumeTagsMethod": "copy-all-tags",
"tags": [
{
"key": "volume-id",
"value": "$(VOLUMEID)"
}
],
"setTagsMethod": "set-all-tags",
"isTest": false
}