interface ManagedRuleProps

Language	Type name
.NET	Amazon.CDK.AWS.Config.ManagedRuleProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsconfig#ManagedRuleProps
Java	software.amazon.awscdk.services.config.ManagedRuleProps
Python	aws_cdk.aws_config.ManagedRuleProps
TypeScript (source)	aws-cdk-lib » aws_config » ManagedRuleProps

Construction properties for a ManagedRule.

Example

declare const fn: lambda.Function;
declare const samplePolicyText: string;

new config.ManagedRule(this, 'ManagedRule', {
  identifier: config.ManagedRuleIdentifiers.API_GW_XRAY_ENABLED,
  evaluationModes: config.EvaluationMode.DETECTIVE_AND_PROACTIVE,
});

new config.CustomRule(this, 'CustomRule', {
  lambdaFunction: fn,
  evaluationModes: config.EvaluationMode.PROACTIVE,
});

new config.CustomPolicy(this, 'CustomPolicy', {
  policyText: samplePolicyText,
  evaluationModes: config.EvaluationMode.DETECTIVE,
});

Properties

Name	Type	Description
identifier	string	The identifier of the AWS managed rule.
configRuleName?	string	A name for the AWS Config rule.
description?	string	A description about this AWS Config rule.
evaluationModes?	EvaluationMode	The modes the AWS Config rule can be evaluated in.
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.

---

identifier

Type: string

The identifier of the AWS managed rule.

See also: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html

---

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.

---

evaluationModes?

Type: EvaluationMode (optional, default: Detective evaluation mode only)

The modes the AWS Config rule can be evaluated in.

The valid values are distinct objects.

---

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.