CustomRule L2 construct
A new custom rule.
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,
});
# 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
)
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();
// 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
});
// 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(),
})
Initializer
new CustomRule(scope: Construct, id: string, props: CustomRuleProps)
CustomRule(scope: Construct, id: str, props: CustomRuleProps)
new CustomRule(Construct scope, String id, CustomRuleProps props)
new CustomRule(Construct scope, string id, CustomRuleProps props)
NewCustomRule(Scope Construct, Id *string, Props CustomRuleProps)
Construct Props
configRuleNameoptionalstringconfig_rule_nameoptionalstrconfigRuleNameoptionalStringConfigRuleNameoptionalstringConfigRuleNameoptional*string#Default: CloudFormation generated name
configurationChangesoptionalbooleanconfiguration_changesoptionalboolconfigurationChangesoptionalBooleanConfigurationChangesoptionalboolConfigurationChangesoptional*bool= false#descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: No description
evaluationModesoptionalEvaluationModeevaluation_modesoptionalEvaluationModeevaluationModesoptionalEvaluationModeEvaluationModesoptionalEvaluationModeEvaluationModesoptionalEvaluationMode#Default: Detective evaluation mode only
The valid values are distinct objects.
inputParametersoptional{ [key: string]: any }input_parametersoptionaltyping.Mapping[str, Any]inputParametersoptionalMap<String, Object>InputParametersoptionalIDictionary<string, object>InputParametersoptional*map[string]interface{}#Default: No input parameters
lambdaFunctionIFunctionlambda_functionIFunctionlambdaFunctionIFunctionLambdaFunctionIFunctionLambdaFunctionIFunctionrequired#maximumExecutionFrequencyoptionalMaximumExecutionFrequencymaximum_execution_frequencyoptionalMaximumExecutionFrequencymaximumExecutionFrequencyoptionalMaximumExecutionFrequencyMaximumExecutionFrequencyoptionalMaximumExecutionFrequencyMaximumExecutionFrequencyoptionalMaximumExecutionFrequency#Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS
periodicoptionalbooleanperiodicoptionalboolperiodicoptionalBooleanPeriodicoptionalboolPeriodicoptional*bool= false#Properties
configRuleArnstringconfig_rule_arnstrconfigRuleArnStringConfigRuleArnstringConfigRuleArn*stringrequired#configRuleComplianceTypestringconfig_rule_compliance_typestrconfigRuleComplianceTypeStringConfigRuleComplianceTypestringConfigRuleComplianceType*stringrequired#configRuleNamestringconfig_rule_namestrconfigRuleNameStringConfigRuleNamestringConfigRuleName*stringrequired#configRuleRefConfigRuleReferenceconfig_rule_refConfigRuleReferenceconfigRuleRefConfigRuleReferenceConfigRuleRefConfigRuleReferenceConfigRuleRefConfigRuleReferencerequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromConfigRuleName(scope: Construct, id: string, configRuleName: string): IRule@staticmethod def from_config_rule_name(scope: Construct, id: str, config_rule_name: str) -> IRulepublic static IRule fromConfigRuleName(Construct scope, String id, String configRuleName)public static IRule FromConfigRuleName(Construct scope, string id, string configRuleName)func FromConfigRuleName(Scope Construct, Id *string, ConfigRuleName *string) IRulestatic#1 parameter
Parameters
configRuleNameconfig_rule_nameconfigRuleNameconfigRuleNameConfigRuleName— the name of the rule.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#onComplianceChange(id: string, options?: OnEventOptions): Ruledef on_compliance_change(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onComplianceChange(String id, OnEventOptions options)public Rule OnComplianceChange(string id, OnEventOptions? options = null)func OnComplianceChange(Id *string, Options OnEventOptions) Rule#onEvent(id: string, options?: OnEventOptions): Ruledef on_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onEvent(String id, OnEventOptions options)public Rule OnEvent(string id, OnEventOptions? options = null)func OnEvent(Id *string, Options OnEventOptions) Rule#Use rule.addEventPattern(pattern) to specify a filter.
onReEvaluationStatus(id: string, options?: OnEventOptions): Ruledef on_re_evaluation_status(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onReEvaluationStatus(String id, OnEventOptions options)public Rule OnReEvaluationStatus(string id, OnEventOptions? options = null)func OnReEvaluationStatus(Id *string, Options OnEventOptions) Rule#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.