interface CustomRuleProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Config.CustomRuleProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsconfig#CustomRuleProps |
![]() | software.amazon.awscdk.services.config.CustomRuleProps |
![]() | aws_cdk.aws_config.CustomRuleProps |
![]() | aws-cdk-lib » aws_config » CustomRuleProps |
Construction properties for a CustomRule.
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 |
---|---|---|
lambda | IFunction | The Lambda function to run. |
config | string | A name for the AWS Config rule. |
configuration | boolean | Whether to run the rule on configuration changes. |
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. |
periodic? | boolean | Whether to run the rule on a fixed frequency. |
rule | Rule | Defines which resources trigger an evaluation for an AWS Config rule. |
lambdaFunction
Type:
IFunction
The Lambda function to run.
configRuleName?
Type:
string
(optional, default: CloudFormation generated name)
A name for the AWS Config rule.
configurationChanges?
Type:
boolean
(optional, default: false)
Whether to run the rule on configuration changes.
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.
periodic?
Type:
boolean
(optional, default: false)
Whether to run the rule on a fixed frequency.
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.