CfnConfigRuleProps

class aws_cdk.aws_config.CfnConfigRuleProps(*, config_rule_name=None, description=None, input_parameters=None, maximum_execution_frequency=None, scope=None, source)

Bases: object

Properties for defining a AWS::Config::ConfigRule.

Parameters
  • config_rule_name (Optional[str]) – AWS::Config::ConfigRule.ConfigRuleName.

  • description (Optional[str]) – AWS::Config::ConfigRule.Description.

  • input_parameters (Optional[Any]) – AWS::Config::ConfigRule.InputParameters.

  • maximum_execution_frequency (Optional[str]) – AWS::Config::ConfigRule.MaximumExecutionFrequency.

  • scope (Union[IResolvable, ScopeProperty, None]) – AWS::Config::ConfigRule.Scope.

  • source (Union[SourceProperty, IResolvable]) – AWS::Config::ConfigRule.Source.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html

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

cfn_config_rule_props = config.CfnConfigRuleProps(
    source=config.CfnConfigRule.SourceProperty(
        owner="owner",
        source_identifier="sourceIdentifier",

        # the properties below are optional
        source_details=[config.CfnConfigRule.SourceDetailProperty(
            event_source="eventSource",
            message_type="messageType",

            # the properties below are optional
            maximum_execution_frequency="maximumExecutionFrequency"
        )]
    ),

    # the properties below are optional
    config_rule_name="configRuleName",
    description="description",
    input_parameters=input_parameters,
    maximum_execution_frequency="maximumExecutionFrequency",
    scope=config.CfnConfigRule.ScopeProperty(
        compliance_resource_id="complianceResourceId",
        compliance_resource_types=["complianceResourceTypes"],
        tag_key="tagKey",
        tag_value="tagValue"
    )
)

Attributes

config_rule_name

AWS::Config::ConfigRule.ConfigRuleName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-configrulename

Return type

Optional[str]

description

AWS::Config::ConfigRule.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-description

Return type

Optional[str]

input_parameters

AWS::Config::ConfigRule.InputParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-inputparameters

Return type

Any

maximum_execution_frequency

AWS::Config::ConfigRule.MaximumExecutionFrequency.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-maximumexecutionfrequency

Return type

Optional[str]

scope

AWS::Config::ConfigRule.Scope.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-scope

Return type

Union[IResolvable, ScopeProperty, None]

source

AWS::Config::ConfigRule.Source.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-source

Return type

Union[SourceProperty, IResolvable]