Skip to content
v2.275.0

ManagedRuleProps Struct ​

Construction properties for a ManagedRule.

Example ​

ts
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 ​

configRuleNameoptionalstringconfig_rule_nameoptionalstrconfigRuleNameoptionalStringConfigRuleNameoptionalstringConfigRuleNameoptional*string#
A name for the AWS Config rule.

Default: CloudFormation generated name

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description about this AWS Config rule.

Default: No description

evaluationModesoptionalEvaluationModeevaluation_modesoptionalEvaluationModeevaluationModesoptionalEvaluationModeEvaluationModesoptionalEvaluationModeEvaluationModesoptionalEvaluationMode#
The modes the AWS Config rule can be evaluated in.

Default: Detective evaluation mode only

The valid values are distinct objects.

identifierstringidentifierstridentifierStringIdentifierstringIdentifier*stringrequired#
The identifier of the AWS managed rule.
inputParametersoptional{ [key: string]: any }input_parametersoptionaltyping.Mapping[str, Any]inputParametersoptionalMap<String, Object>InputParametersoptionalIDictionary<string, object>InputParametersoptional*map[string]interface{}#
Input parameter values that are passed to the AWS Config rule.

Default: No input parameters

maximumExecutionFrequencyoptionalMaximumExecutionFrequencymaximum_execution_frequencyoptionalMaximumExecutionFrequencymaximumExecutionFrequencyoptionalMaximumExecutionFrequencyMaximumExecutionFrequencyoptionalMaximumExecutionFrequencyMaximumExecutionFrequencyoptionalMaximumExecutionFrequency#
The maximum frequency at which the AWS Config rule runs evaluations.

Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS

ruleScopeoptionalRuleScoperule_scopeoptionalRuleScoperuleScopeoptionalRuleScopeRuleScopeoptionalRuleScopeRuleScopeoptionalRuleScope#
Defines which resources trigger an evaluation for an AWS Config rule.

Default: evaluations for the rule are triggered when any resource in the recording group changes.