class ManagedRule (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Config.ManagedRule |
Java | software.amazon.awscdk.services.config.ManagedRule |
Python | aws_cdk.aws_config.ManagedRule |
TypeScript (source) | @aws-cdk/aws-config » ManagedRule |
Implements
IConstruct
, IConstruct
, IDependable
, IResource
, IRule
A new managed rule.
Example
// https://docs.aws.amazon.com/config/latest/developerguide/access-keys-rotated.html
new config.ManagedRule(this, 'AccessKeysRotated', {
identifier: config.ManagedRuleIdentifiers.ACCESS_KEYS_ROTATED,
inputParameters: {
maxAccessKeyAge: 60, // default is 90 days
},
// default is 24 hours
maximumExecutionFrequency: config.MaximumExecutionFrequency.TWELVE_HOURS,
});
Initializer
new ManagedRule(scope: Construct, id: string, props: ManagedRuleProps)
Parameters
- scope
Construct
- id
string
- props
Managed
Rule Props
Construct Props
Name | Type | Description |
---|---|---|
identifier | string | The identifier of the AWS managed rule. |
config | string | A name for the AWS Config rule. |
description? | string | A description about this AWS Config rule. |
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. |
identifier
Type:
string
The identifier of the AWS managed rule.
See also: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html
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.
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 | Construct | The construct tree node associated with this construct. |
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:
Construct
The construct tree node associated with this construct.
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. |
RemovalPolicy(policy)
applypublic 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
).
ComplianceChange(id, options?)
onpublic 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.
Event(id, options?)
onpublic 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.
ReEvaluationStatus(id, options?)
onpublic 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.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
ConfigRuleName(scope, id, configRuleName)
static frompublic 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.