CloudFormationStackDriftDetectionCheckProps

class aws_cdk.aws_config.CloudFormationStackDriftDetectionCheckProps(*, config_rule_name=None, description=None, input_parameters=None, maximum_execution_frequency=None, own_stack_only=None, role=None)

Bases: aws_cdk.aws_config.RuleProps

Construction properties for a CloudFormationStackDriftDetectionCheck.

Parameters

  • config_rule_name (Optional[str]) – A name for the AWS Config rule. Default: - CloudFormation generated name

  • description (Optional[str]) – A description about this AWS Config rule. Default: - No description

  • input_parameters (Optional[Mapping[str, Any]]) – Input parameter values that are passed to the AWS Config rule. Default: - No input parameters

  • maximum_execution_frequency (Optional[MaximumExecutionFrequency]) – The maximum frequency at which the AWS Config rule runs evaluations. Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS

  • own_stack_only (Optional[bool]) – Whether to check only the stack where this rule is deployed. Default: false

  • role (Optional[IRole]) – 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

stability :stability: experimental

Attributes

config_rule_name

A name for the AWS Config rule.

default :default: - CloudFormation generated name

stability :stability: experimental

Return type

Optional[str]

description

A description about this AWS Config rule.

default :default: - No description

stability :stability: experimental

Return type

Optional[str]

input_parameters

Input parameter values that are passed to the AWS Config rule.

default :default: - No input parameters

stability :stability: experimental

Return type

Optional[Mapping[str, Any]]

maximum_execution_frequency

The maximum frequency at which the AWS Config rule runs evaluations.

default :default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS

stability :stability: experimental

Return type

Optional[MaximumExecutionFrequency]

own_stack_only

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

default :default: false

stability :stability: experimental

Return type

Optional[bool]

role

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 :default: - A role will be created

stability :stability: experimental

Return type

Optional[IRole]