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,
});
python
# fn: lambda.Function
# sample_policy_text: str
config.ManagedRule(self, "ManagedRule",
identifier=config.ManagedRuleIdentifiers.API_GW_XRAY_ENABLED,
evaluation_modes=config.EvaluationMode.DETECTIVE_AND_PROACTIVE
)
config.CustomRule(self, "CustomRule",
lambda_function=fn,
evaluation_modes=config.EvaluationMode.PROACTIVE
)
config.CustomPolicy(self, "CustomPolicy",
policy_text=sample_policy_text,
evaluation_modes=config.EvaluationMode.DETECTIVE
)
java
Function fn;
String samplePolicyText;
ManagedRule.Builder.create(this, "ManagedRule")
.identifier(ManagedRuleIdentifiers.API_GW_XRAY_ENABLED)
.evaluationModes(EvaluationMode.DETECTIVE_AND_PROACTIVE)
.build();
CustomRule.Builder.create(this, "CustomRule")
.lambdaFunction(fn)
.evaluationModes(EvaluationMode.PROACTIVE)
.build();
CustomPolicy.Builder.create(this, "CustomPolicy")
.policyText(samplePolicyText)
.evaluationModes(EvaluationMode.DETECTIVE)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
Function fn;
string samplePolicyText;
new ManagedRule(this, "ManagedRule", new ManagedRuleProps {
Identifier = ManagedRuleIdentifiers.API_GW_XRAY_ENABLED,
EvaluationModes = EvaluationMode.DETECTIVE_AND_PROACTIVE
});
new CustomRule(this, "CustomRule", new CustomRuleProps {
LambdaFunction = fn,
EvaluationModes = EvaluationMode.PROACTIVE
});
new CustomPolicy(this, "CustomPolicy", new CustomPolicyProps {
PolicyText = samplePolicyText,
EvaluationModes = EvaluationMode.DETECTIVE
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var fn Function
var samplePolicyText string
config.NewManagedRule(this, jsii.String("ManagedRule"), &ManagedRuleProps{
Identifier: config.ManagedRuleIdentifiers_API_GW_XRAY_ENABLED(),
EvaluationModes: config.EvaluationMode_DETECTIVE_AND_PROACTIVE(),
})
config.NewCustomRule(this, jsii.String("CustomRule"), &CustomRuleProps{
LambdaFunction: fn,
EvaluationModes: config.EvaluationMode_PROACTIVE(),
})
config.NewCustomPolicy(this, jsii.String("CustomPolicy"), &CustomPolicyProps{
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.
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