Package software.amazon.awscdk.services.config

Interface CfnConfigRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:27.585Z")
@Stability(Stable)
public interface CfnConfigRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConfigRule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 Object inputParameters;
 CfnConfigRuleProps cfnConfigRuleProps = CfnConfigRuleProps.builder()
         .source(SourceProperty.builder()
                 .owner("owner")
                 // the properties below are optional
                 .customPolicyDetails(CustomPolicyDetailsProperty.builder()
                         .enableDebugLogDelivery(false)
                         .policyRuntime("policyRuntime")
                         .policyText("policyText")
                         .build())
                 .sourceDetails(List.of(SourceDetailProperty.builder()
                         .eventSource("eventSource")
                         .messageType("messageType")
                         // the properties below are optional
                         .maximumExecutionFrequency("maximumExecutionFrequency")
                         .build()))
                 .sourceIdentifier("sourceIdentifier")
                 .build())
         // the properties below are optional
         .compliance(ComplianceProperty.builder()
                 .type("type")
                 .build())
         .configRuleName("configRuleName")
         .description("description")
         .evaluationModes(List.of(EvaluationModeConfigurationProperty.builder()
                 .mode("mode")
                 .build()))
         .inputParameters(inputParameters)
         .maximumExecutionFrequency("maximumExecutionFrequency")
         .scope(ScopeProperty.builder()
                 .complianceResourceId("complianceResourceId")
                 .complianceResourceTypes(List.of("complianceResourceTypes"))
                 .tagKey("tagKey")
                 .tagValue("tagValue")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigRuleProps.Builder	A builder for CfnConfigRuleProps
static final class	CfnConfigRuleProps.Jsii$Proxy	An implementation for CfnConfigRuleProps

Method Summary

Modifier and Type	Method	Description
static CfnConfigRuleProps.Builder	builder()
default Object	getCompliance()	Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.
default String	getConfigRuleName()	A name for the AWS Config rule.
default String	getDescription()	The description that you provide for the AWS Config rule.
default Object	getEvaluationModes()	The modes the AWS Config rule can be evaluated in.
default Object	getInputParameters()	A string, in JSON format, that is passed to the AWS Config rule Lambda function.
default String	getMaximumExecutionFrequency()	The maximum frequency with which AWS Config runs evaluations for a rule.
default Object	getScope()	Defines which resources can trigger an evaluation for the rule.
Object	getSource()	Provides the rule owner ( AWS for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSource

@Stability(Stable)
@NotNull
Object getSource()

Provides the rule owner ( AWS for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

See Also:

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

getCompliance

@Stability(Stable)
@Nullable
default Object getCompliance()

Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.

See Also:

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

getConfigRuleName

@Stability(Stable)
@Nullable
default String getConfigRuleName()

A name for the AWS Config rule.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type .

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description that you provide for the AWS Config rule.

See Also:

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

getEvaluationModes

@Stability(Stable)
@Nullable
default Object getEvaluationModes()

The modes the AWS Config rule can be evaluated in.

The valid values are distinct objects. By default, the value is Detective evaluation mode only.

See Also:

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

getInputParameters

@Stability(Stable)
@Nullable
default Object getInputParameters()

A string, in JSON format, that is passed to the AWS Config rule Lambda function.

See Also:

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

getMaximumExecutionFrequency

@Stability(Stable)
@Nullable
default String getMaximumExecutionFrequency()

The maximum frequency with which AWS Config runs evaluations for a rule.

You can specify a value for MaximumExecutionFrequency when:

• You are using an AWS managed rule that is triggered at a periodic frequency.
• Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

See Also:

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

getScope

@Stability(Stable)
@Nullable
default Object getScope()

Defines which resources can trigger an evaluation for the rule.

The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

The scope can be empty.

See Also:

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

builder

@Stability(Stable)
static CfnConfigRuleProps.Builder builder()

Returns:

a CfnConfigRuleProps.Builder of CfnConfigRuleProps