aws-cdk-lib.aws_config.ManagedRuleProps

interface ManagedRuleProps

LanguageType name
.NETAmazon.CDK.AWS.Config.ManagedRuleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsconfig#ManagedRuleProps
Javasoftware.amazon.awscdk.services.config.ManagedRuleProps
Pythonaws_cdk.aws_config.ManagedRuleProps
TypeScript (source)aws-cdk-lib » aws_config » ManagedRuleProps

Construction properties for a ManagedRule.

Example

// https://docs.aws.amazon.com/config/latest/developerguide/access-keys-rotated.html
new config.ManagedRule(this, 'AccessKeysRotated', {
  identifier: config.ManagedRuleIdentifiers.ACCESS_KEYS_ROTATED,
  inputParameters: {
    maxAccessKeyAge: 60, // default is 90 days
  },

  // default is 24 hours
  maximumExecutionFrequency: config.MaximumExecutionFrequency.TWELVE_HOURS,
});

Properties

NameTypeDescription
identifierstringThe identifier of the AWS managed rule.
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.

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.


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.