RuleProps

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

Bases: object

Construction properties for a new rule.

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.

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_config as config

# input_parameters is of type object
# rule_scope is of type RuleScope

rule_props = config.RuleProps(
    config_rule_name="configRuleName",
    description="description",
    input_parameters={
        "input_parameters_key": input_parameters
    },
    maximum_execution_frequency=config.MaximumExecutionFrequency.ONE_HOUR,
    rule_scope=rule_scope
)

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]