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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.534Z")
@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
         .configRuleName("configRuleName")
         .description("description")
         .inputParameters(inputParameters)
         .maximumExecutionFrequency("maximumExecutionFrequency")
         .scope(ScopeProperty.builder()
                 .complianceResourceId("complianceResourceId")
                 .complianceResourceTypes(List.of("complianceResourceTypes"))
                 .tagKey("tagKey")
                 .tagValue("tagValue")
                 .build())
         .build();
 

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 String	getConfigRuleName()	A name for the AWS Config rule.
default String	getDescription()	The description that you provide for the AWS Config rule.
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.

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 .

getDescription

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

The description that you provide for the AWS Config rule.

getInputParameters

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

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

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.

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.

builder

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

Returns:

a CfnConfigRuleProps.Builder of CfnConfigRuleProps