aws-cdk-lib.aws_config.RuleProps

interface RuleProps

LanguageType name
.NETAmazon.CDK.AWS.Config.RuleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsconfig#RuleProps
Javasoftware.amazon.awscdk.services.config.RuleProps
Pythonaws_cdk.aws_config.RuleProps
TypeScript (source)aws-cdk-lib » aws_config » 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 { aws_config as config } from 'aws-cdk-lib';

declare const inputParameters: any;
declare const ruleScope: config.RuleScope;
const ruleProps: config.RuleProps = {
  configRuleName: 'configRuleName',
  description: 'description',
  inputParameters: {
    inputParametersKey: inputParameters,
  },
  maximumExecutionFrequency: config.MaximumExecutionFrequency.ONE_HOUR,
  ruleScope: ruleScope,
};

Properties

NameTypeDescription
configRuleName?stringA name for the AWS Config rule.
description?stringA description about this AWS Config rule.
inputParameters?{ [string]: any }Input parameter values that are passed to the AWS Config rule.
maximumExecutionFrequency?MaximumExecutionFrequencyThe maximum frequency at which the AWS Config rule runs evaluations.
ruleScope?RuleScopeDefines which resources trigger an evaluation for an AWS Config rule.

configRuleName?

Type: string (optional, default: CloudFormation generated name)

A name for the AWS Config rule.


description?

Type: string (optional, default: No description)

A description about this AWS Config rule.


inputParameters?

Type: { [string]: any } (optional, default: No input parameters)

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


maximumExecutionFrequency?

Type: MaximumExecutionFrequency (optional, default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS)

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


ruleScope?

Type: RuleScope (optional, default: evaluations for the rule are triggered when any resource in the recording group changes.)

Defines which resources trigger an evaluation for an AWS Config rule.