CloudFormationStackNotificationCheckProps

class aws_cdk.aws_config.CloudFormationStackNotificationCheckProps(*, config_rule_name=None, description=None, input_parameters=None, maximum_execution_frequency=None, rule_scope=None, topics=None)

Bases: aws_cdk.aws_config.RuleProps

Construction properties for a CloudFormationStackNotificationCheck.

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

  • rule_scope (Optional[RuleScope]) – Defines which resources trigger an evaluation for an AWS Config rule. Default: - evaluations for the rule are triggered when any resource in the recording group changes.

  • topics (Optional[Sequence[ITopic]]) – A list of allowed topics. At most 5 topics. Default: - No topics.

Example:

# Example automatically generated from non-compiling source. May contain errors.
import aws_cdk.aws_config as config
import aws_cdk.aws_cdk as cdk

# topics to which CloudFormation stacks may send event notifications
topic1 = sns.Topic(stack, "AllowedTopic1")
topic2 = sns.Topic(stack, "AllowedTopic2")

# non-compliant if CloudFormation stack does not send notifications to 'topic1' or 'topic2'
config.CloudFormationStackNotificationCheck(self, "NotificationCheck",
    topics=[topic1, topic2]
)

Attributes

config_rule_name

A name for the AWS Config rule.

Default

  • CloudFormation generated name

Return type

Optional[str]

description

A description about this AWS Config rule.

Default

  • No description

Return type

Optional[str]

input_parameters

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

Default

  • No input parameters

Return type

Optional[Mapping[str, Any]]

maximum_execution_frequency

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

Default

MaximumExecutionFrequency.TWENTY_FOUR_HOURS

Return type

Optional[MaximumExecutionFrequency]

rule_scope

Defines which resources trigger an evaluation for an AWS Config rule.

Default

  • evaluations for the rule are triggered when any resource in the recording group changes.

Return type

Optional[RuleScope]

topics

A list of allowed topics.

At most 5 topics.

Default

  • No topics.

Return type

Optional[List[ITopic]]