AmazonCloudFormationStackDriftReportParameters Object

Description

Parameters for the Amazon CloudFormation Stack Drift Report action.

Properties

credentialIds

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

Type: Array of string

Required: Yes

stackIdentificationMethod

Method to use to identify stacks to be checked for drift.

Type: string

Valid Values:

  • all-stacks

  • by-stack-name

  • by-resource-tag

Required: Yes

stackNameComparison

Comparison to use when matching stacks by their name. Required when stackIdentificationMethod is by-stack-name.

Type: CloudFormationStackNameComparison object

Required: Conditional

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 stacks by resource tag. Required when stackIdentificationMethod 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

Sample JSON

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

    "stackIdentificationMethod": "all-stacks",

    "targetType": "email",
    "targetEmails": [
        "foo@example.com"
    ],
    "ReportFormat": "email"
}

Last updated