CustomRuleProps

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

Bases: aws_cdk.aws_config.RuleProps

__init__(*, config_rule_name=None, description=None, input_parameters=None, maximum_execution_frequency=None, lambda_function, configuration_changes=None, periodic=None)

Consruction properties for a CustomRule.

Parameters
  • config_rule_name (Optional[str]) – A name for the AWS Config rule. Default: a 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: 24 hours

  • 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

stability :stability: experimental

Return type

None

Attributes

config_rule_name

A name for the AWS Config rule.

default :default: a CloudFormation generated name

stability :stability: experimental

Return type

Optional[str]

configuration_changes

Whether to run the rule on configuration changes.

default :default: false

stability :stability: experimental

Return type

Optional[bool]

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

lambda_function

The Lambda function to run.

stability :stability: experimental

Return type

IFunction

maximum_execution_frequency

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

default :default: 24 hours

stability :stability: experimental

Return type

Optional[MaximumExecutionFrequency]

periodic

Whether to run the rule on a fixed frequency.

default :default: false

stability :stability: experimental

Return type

Optional[bool]