Package software.amazon.awscdk.services.config

Interface CloudFormationStackDriftDetectionCheckProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, RuleProps

All Known Implementing Classes:

CloudFormationStackDriftDetectionCheckProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.596Z")
@Stability(Stable)
public interface CloudFormationStackDriftDetectionCheckProps
extends software.amazon.jsii.JsiiSerializable, RuleProps

Construction properties for a CloudFormationStackDriftDetectionCheck.

Example:

 // compliant if stack's status is 'IN_SYNC'
 // non-compliant if the stack's drift status is 'DRIFTED'
 // compliant if stack's status is 'IN_SYNC'
 // non-compliant if the stack's drift status is 'DRIFTED'
 CloudFormationStackDriftDetectionCheck.Builder.create(this, "Drift")
         .ownStackOnly(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CloudFormationStackDriftDetectionCheckProps.Builder	A builder for CloudFormationStackDriftDetectionCheckProps
static final class	CloudFormationStackDriftDetectionCheckProps.Jsii$Proxy	An implementation for CloudFormationStackDriftDetectionCheckProps

Method Summary

Modifier and Type	Method	Description
static CloudFormationStackDriftDetectionCheckProps.Builder	builder()
default Boolean	getOwnStackOnly()	Whether to check only the stack where this rule is deployed.
default IRole	getRole()	The IAM role to use for this rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.config.RuleProps

getConfigRuleName, getDescription, getInputParameters, getMaximumExecutionFrequency, getRuleScope

Method Details

getOwnStackOnly

@Stability(Stable)
@Nullable
default Boolean getOwnStackOnly()

Whether to check only the stack where this rule is deployed.

Default: false

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

The IAM role to use for this rule.

It must have permissions to detect drift for AWS CloudFormation stacks. Ensure to attach config.amazonaws.com trusted permissions and ReadOnlyAccess policy permissions. For specific policy permissions, refer to https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html.

Default: - A role will be created

builder

@Stability(Stable)
static CloudFormationStackDriftDetectionCheckProps.Builder builder()

Returns:

a CloudFormationStackDriftDetectionCheckProps.Builder of CloudFormationStackDriftDetectionCheckProps