interface RuleProps

Language	Type name
.NET	Amazon.CDK.AWS.Config.RuleProps
Java	software.amazon.awscdk.services.config.RuleProps
Python	aws_cdk.aws_config.RuleProps
TypeScript (source)	@aws-cdk/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 * as config from '@aws-cdk/aws-config';

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

Name	Type	Description
configRuleName?	string	A name for the AWS Config rule.
description?	string	A description about this AWS Config rule.
inputParameters?	{ [string]: any }	Input parameter values that are passed to the AWS Config rule.
maximumExecutionFrequency?	MaximumExecutionFrequency	The maximum frequency at which the AWS Config rule runs evaluations.
ruleScope?	RuleScope	Defines 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.