interface RuleProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Config.RuleProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsconfig#RuleProps |
![]() | software.amazon.awscdk.services.config.RuleProps |
![]() | aws_cdk.aws_config.RuleProps |
![]() | 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 evaluationMode: config.EvaluationMode;
declare const inputParameters: any;
declare const ruleScope: config.RuleScope;
const ruleProps: config.RuleProps = {
configRuleName: 'configRuleName',
description: 'description',
evaluationModes: evaluationMode,
inputParameters: {
inputParametersKey: inputParameters,
},
maximumExecutionFrequency: config.MaximumExecutionFrequency.ONE_HOUR,
ruleScope: ruleScope,
};
Properties
Name | Type | Description |
---|---|---|
config | string | A name for the AWS Config rule. |
description? | string | A description about this AWS Config rule. |
evaluation | Evaluation | The modes the AWS Config rule can be evaluated in. |
input | { [string]: any } | Input parameter values that are passed to the AWS Config rule. |
maximum | Maximum | The maximum frequency at which the AWS Config rule runs evaluations. |
rule | Rule | 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.
evaluationModes?
Type:
Evaluation
(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:
Maximum
(optional, default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS)
The maximum frequency at which the AWS Config rule runs evaluations.
ruleScope?
Type:
Rule
(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.