CustomRuleProps

class aws_cdk.aws_config.CustomRuleProps(*, config_rule_name=None, description=None, input_parameters=None, maximum_execution_frequency=None, rule_scope=None, lambda_function, configuration_changes=None, periodic=None)

Bases: aws_cdk.aws_config.RuleProps

Construction properties for a CustomRule.

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.

  • lambda_function (IFunction) – The Lambda function to run.

  • configuration_changes (Optional[bool]) – Whether to run the rule on configuration changes. Default: false

  • periodic (Optional[bool]) – Whether to run the rule on a fixed frequency. Default: false

Attributes

config_rule_name

A name for the AWS Config rule.

Default
  • CloudFormation generated name

Return type

Optional[str]

configuration_changes

Whether to run the rule on configuration changes.

Default

false

Return type

Optional[bool]

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]]

lambda_function

The Lambda function to run.

Return type

IFunction

maximum_execution_frequency

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

Default

MaximumExecutionFrequency.TWENTY_FOUR_HOURS

Return type

Optional[MaximumExecutionFrequency]

periodic

Whether to run the rule on a fixed frequency.

Default

false

Return type

Optional[bool]

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]