CustomPolicy L2 construct
A new custom policy.
Example
ts
const samplePolicyText = `
# This rule checks if point in time recovery (PITR) is enabled on active Amazon DynamoDB tables
let status = ['ACTIVE']
rule tableisactive when
resourceType == "AWS::DynamoDB::Table" {
configuration.tableStatus == %status
}
rule checkcompliance when
resourceType == "AWS::DynamoDB::Table"
tableisactive {
let pitr = supplementaryConfiguration.ContinuousBackupsDescription.pointInTimeRecoveryDescription.pointInTimeRecoveryStatus
%pitr == "ENABLED"
}
`;
new config.CustomPolicy(this, "Custom", {
policyText: samplePolicyText,
enableDebugLog: true,
ruleScope: config.RuleScope.fromResources([
config.ResourceType.DYNAMODB_TABLE,
]),
});
python
sample_policy_text = """
# This rule checks if point in time recovery (PITR) is enabled on active Amazon DynamoDB tables
let status = ['ACTIVE']
rule tableisactive when
resourceType == "AWS::DynamoDB::Table" {
configuration.tableStatus == %status
}
rule checkcompliance when
resourceType == "AWS::DynamoDB::Table"
tableisactive {
let pitr = supplementaryConfiguration.ContinuousBackupsDescription.pointInTimeRecoveryDescription.pointInTimeRecoveryStatus
%pitr == "ENABLED"
}
"""
config.CustomPolicy(self, "Custom",
policy_text=sample_policy_text,
enable_debug_log=True,
rule_scope=config.RuleScope.from_resources([config.ResourceType.DYNAMODB_TABLE
])
)
java
String samplePolicyText = "\n# This rule checks if point in time recovery (PITR) is enabled on active Amazon DynamoDB tables\nlet status = ['ACTIVE']\n\nrule tableisactive when\n resourceType == \"AWS::DynamoDB::Table\" {\n configuration.tableStatus == %status\n}\n\nrule checkcompliance when\n resourceType == \"AWS::DynamoDB::Table\"\n tableisactive {\n let pitr = supplementaryConfiguration.ContinuousBackupsDescription.pointInTimeRecoveryDescription.pointInTimeRecoveryStatus\n %pitr == \"ENABLED\"\n}\n";
CustomPolicy.Builder.create(this, "Custom")
.policyText(samplePolicyText)
.enableDebugLog(true)
.ruleScope(RuleScope.fromResources(List.of(ResourceType.DYNAMODB_TABLE)))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var samplePolicyText = @"
# This rule checks if point in time recovery (PITR) is enabled on active Amazon DynamoDB tables
let status = ['ACTIVE']
rule tableisactive when
resourceType == ""AWS::DynamoDB::Table"" {
configuration.tableStatus == %status
}
rule checkcompliance when
resourceType == ""AWS::DynamoDB::Table""
tableisactive {
let pitr = supplementaryConfiguration.ContinuousBackupsDescription.pointInTimeRecoveryDescription.pointInTimeRecoveryStatus
%pitr == ""ENABLED""
}
";
new CustomPolicy(this, "Custom", new CustomPolicyProps {
PolicyText = samplePolicyText,
EnableDebugLog = true,
RuleScope = RuleScope.FromResources(new [] { ResourceType.DYNAMODB_TABLE })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
samplePolicyText := `
# This rule checks if point in time recovery (PITR) is enabled on active Amazon DynamoDB tables
let status = ['ACTIVE']
rule tableisactive when
resourceType == "AWS::DynamoDB::Table" {
configuration.tableStatus == %status
}
rule checkcompliance when
resourceType == "AWS::DynamoDB::Table"
tableisactive {
let pitr = supplementaryConfiguration.ContinuousBackupsDescription.pointInTimeRecoveryDescription.pointInTimeRecoveryStatus
%pitr == "ENABLED"
}
`
config.NewCustomPolicy(this, jsii.String("Custom"), &CustomPolicyProps{
PolicyText: samplePolicyText,
EnableDebugLog: jsii.Boolean(true),
RuleScope: config.RuleScope_FromResources([]ResourceType{
config.ResourceType_DYNAMODB_TABLE(),
}),
})
Initializer
ts
new CustomPolicy(scope: Construct, id: string, props: CustomPolicyProps)
python
CustomPolicy(scope: Construct, id: str, props: CustomPolicyProps)
java
new CustomPolicy(Construct scope, String id, CustomPolicyProps props)
csharp
new CustomPolicy(Construct scope, string id, CustomPolicyProps props)
go
NewCustomPolicy(Scope Construct, Id *string, Props CustomPolicyProps)
Construct Props
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
enableDebugLogoptionalbooleanenable_debug_logoptionalboolenableDebugLogoptionalBooleanEnableDebugLogoptionalboolEnableDebugLogoptional*bool= false#The boolean expression for enabling debug logging for your AWS Config Custom Policy rule.
evaluationModesoptionalEvaluationModeevaluation_modesoptionalEvaluationModeevaluationModesoptionalEvaluationModeEvaluationModesoptionalEvaluationModeEvaluationModesoptionalEvaluationMode#The modes the AWS Config rule can be evaluated in.
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{}#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
The policy definition containing the logic for your AWS Config Custom Policy rule.
Properties
configRuleArnstringconfig_rule_arnstrconfigRuleArnStringConfigRuleArnstringConfigRuleArn*stringrequired#The arn of the rule.
configRuleComplianceTypestringconfig_rule_compliance_typestrconfigRuleComplianceTypeStringConfigRuleComplianceTypestringConfigRuleComplianceType*stringrequired#The compliance status of the rule.
The id of the rule.
configRuleNamestringconfig_rule_namestrconfigRuleNameStringConfigRuleNamestringConfigRuleName*stringrequired#The name of the rule.
configRuleRefConfigRuleReferenceconfig_rule_refConfigRuleReferenceconfigRuleRefConfigRuleReferenceConfigRuleRefConfigRuleReferenceConfigRuleRefConfigRuleReferencerequired#A reference to a ConfigRule resource.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
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#Uniquely identifies this class.
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)#Override the cross-stack reference strength for this resource.
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)#Apply the given removal policy to this resource.
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#Imports an existing rule.
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#Checks if `x` is a construct.
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#Returns true if the construct was created by CDK, and false otherwise.
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#Check whether the given construct is a Resource.
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#Defines an EventBridge event rule which triggers for rule compliance events.
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#Defines an EventBridge event rule which triggers for rule events.
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#Defines an EventBridge event rule which triggers for rule re-evaluation status events.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
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.