class CustomPolicy (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Config.CustomPolicy |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsconfig#CustomPolicy |
![]() | software.amazon.awscdk.services.config.CustomPolicy |
![]() | aws_cdk.aws_config.CustomPolicy |
![]() | aws-cdk-lib » aws_config » CustomPolicy |
Implements
IConstruct
, IDependable
, IResource
, IRule
A new custom policy.
Example
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,
]),
});
Initializer
new CustomPolicy(scope: Construct, id: string, props: CustomPolicyProps)
Parameters
- scope
Construct
- id
string
- props
Custom
Policy Props
Construct Props
Name | Type | Description |
---|---|---|
policy | string | The policy definition containing the logic for your AWS Config Custom Policy rule. |
config | string | A name for the AWS Config rule. |
description? | string | A description about this AWS Config rule. |
enable | boolean | The boolean expression for enabling debug logging for your AWS Config Custom Policy 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. |
rule | Rule | Defines which resources trigger an evaluation for an AWS Config rule. |
policyText
Type:
string
The policy definition containing the logic for your AWS Config Custom Policy rule.
configRuleName?
Type:
string
(optional, default: CloudFormation generated name)
A name for the AWS Config rule.
description?
Type:
string
(optional, default: No description)
A description about this AWS Config rule.
enableDebugLog?
Type:
boolean
(optional, default: false)
The boolean expression for enabling debug logging for your AWS Config Custom Policy 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.
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.
Properties
Name | Type | Description |
---|---|---|
config | string | The arn of the rule. |
config | string | The compliance status of the rule. |
config | string | The id of the rule. |
config | string | The name of the rule. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
is | boolean | |
is | boolean | |
rule | Rule |
configRuleArn
Type:
string
The arn of the rule.
configRuleComplianceType
Type:
string
The compliance status of the rule.
configRuleId
Type:
string
The id of the rule.
configRuleName
Type:
string
The name of the rule.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
isCustomWithChanges?
Type:
boolean
(optional)
isManaged?
Type:
boolean
(optional)
ruleScope?
Type:
Rule
(optional)
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
on | Defines an EventBridge event rule which triggers for rule compliance events. |
on | Defines an EventBridge event rule which triggers for rule events. |
on | Defines an EventBridge event rule which triggers for rule re-evaluation status events. |
to | Returns a string representation of this construct. |
static from | Imports an existing rule. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
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
).
onComplianceChange(id, options?)
public onComplianceChange(id: string, options?: OnEventOptions): Rule
Parameters
- id
string
- options
On
Event Options
Returns
Defines an EventBridge event rule which triggers for rule compliance events.
onEvent(id, options?)
public onEvent(id: string, options?: OnEventOptions): Rule
Parameters
- id
string
- options
On
Event Options
Returns
Defines an EventBridge event rule which triggers for rule events.
Use
rule.addEventPattern(pattern)
to specify a filter.
onReEvaluationStatus(id, options?)
public onReEvaluationStatus(id: string, options?: OnEventOptions): Rule
Parameters
- id
string
- options
On
Event Options
Returns
Defines an EventBridge event rule which triggers for rule re-evaluation status events.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromConfigRuleName(scope, id, configRuleName)
public static fromConfigRuleName(scope: Construct, id: string, configRuleName: string): IRule
Parameters
- scope
Construct
- id
string
- configRuleName
string
— the name of the rule.
Returns
Imports an existing rule.