software.amazon.awscdk.services.config

Interface RuleProps

All Known Subinterfaces:

AccessKeysRotatedProps, CloudFormationStackDriftDetectionCheckProps, CloudFormationStackNotificationCheckProps, CustomRuleProps, ManagedRuleProps

All Known Implementing Classes:

AccessKeysRotatedProps.Jsii$Proxy, CloudFormationStackDriftDetectionCheckProps.Jsii$Proxy, CloudFormationStackNotificationCheckProps.Jsii$Proxy, CustomRuleProps.Jsii$Proxy, ManagedRuleProps.Jsii$Proxy, RuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:11.820Z")
public interface RuleProps

Construction properties for a new rule.

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;
 RuleScope ruleScope;
 RuleProps ruleProps = RuleProps.builder()
         .configRuleName("configRuleName")
         .description("description")
         .inputParameters(Map.of(
                 "inputParametersKey", inputParameters))
         .maximumExecutionFrequency(MaximumExecutionFrequency.ONE_HOUR)
         .ruleScope(ruleScope)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RuleProps.Builder	builder()
default java.lang.String	getConfigRuleName() A name for the AWS Config rule.
default java.lang.String	getDescription() A description about this AWS Config rule.
default java.util.Map<java.lang.String,java.lang.Object>	getInputParameters() Input parameter values that are passed to the AWS Config rule.
default MaximumExecutionFrequency	getMaximumExecutionFrequency() The maximum frequency at which the AWS Config rule runs evaluations.
default RuleScope	getRuleScope() Defines which resources trigger an evaluation for an AWS Config rule.

Method Detail

getConfigRuleName

default java.lang.String getConfigRuleName()

A name for the AWS Config rule.

Default: - CloudFormation generated name

getDescription

default java.lang.String getDescription()

A description about this AWS Config rule.

Default: - No description

getInputParameters

default java.util.Map<java.lang.String,java.lang.Object> getInputParameters()

Input parameter values that are passed to the AWS Config rule.

Default: - No input parameters

getMaximumExecutionFrequency

default MaximumExecutionFrequency getMaximumExecutionFrequency()

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

Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS

getRuleScope

default RuleScope getRuleScope()

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.

builder

static RuleProps.Builder builder()

Returns:

a RuleProps.Builder of RuleProps