API.md

API Reference

Constructs

CreatedAccountByOrganizationsRule

A rule for matching events from CloudTrail where Organizations created a new account.

Initializers

import { CreatedAccountByOrganizationsRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new CreatedAccountByOrganizationsRule(scope: Construct, id: string, props: BaseRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	BaseRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: BaseRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { CreatedAccountByOrganizationsRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

CreatedAccountByOrganizationsRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { CreatedAccountByOrganizationsRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

CreatedAccountByOrganizationsRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { CreatedAccountByOrganizationsRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

CreatedAccountByOrganizationsRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { CreatedAccountByOrganizationsRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

CreatedAccountByOrganizationsRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

CreatedAccountRule

A rule for matching events from CloudTrail where Control Tower created a new account.

Initializers

import { CreatedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new CreatedAccountRule(scope: Construct, id: string, props: OuRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	OuRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: OuRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { CreatedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

CreatedAccountRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { CreatedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

CreatedAccountRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { CreatedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

CreatedAccountRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { CreatedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

CreatedAccountRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

DeregisteredOrganizationalUnitRule

A rule for matching events from CloudTrail where Control Tower deregistered an Organizational Unit.

Initializers

import { DeregisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new DeregisteredOrganizationalUnitRule(scope: Construct, id: string, props: OuRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	OuRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: OuRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { DeregisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

DeregisteredOrganizationalUnitRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { DeregisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

DeregisteredOrganizationalUnitRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { DeregisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

DeregisteredOrganizationalUnitRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { DeregisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

DeregisteredOrganizationalUnitRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

DisabledGuardrailRule

A rule for matching events from CloudTrail where a guard rail was disabled via Control Tower for an Organizational Unit.

Initializers

import { DisabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new DisabledGuardrailRule(scope: Construct, id: string, props: GuardrailRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	GuardrailRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: GuardrailRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { DisabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

DisabledGuardrailRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { DisabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

DisabledGuardrailRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { DisabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

DisabledGuardrailRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { DisabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

DisabledGuardrailRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

EnabledGuardrailRule

A rule for matching events from CloudTrail where a guardrail was enabled via Control Tower for an Organizational Unit.

Initializers

import { EnabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new EnabledGuardrailRule(scope: Construct, id: string, props: GuardrailRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	GuardrailRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: GuardrailRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { EnabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

EnabledGuardrailRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { EnabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

EnabledGuardrailRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { EnabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

EnabledGuardrailRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { EnabledGuardrailRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

EnabledGuardrailRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

RegisteredOrganizationalUnitRule

A rule for matching events from CloudTrail where Control Tower registered a new Organizational Unit.

Initializers

import { RegisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new RegisteredOrganizationalUnitRule(scope: Construct, id: string, props: BaseRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	BaseRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: BaseRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { RegisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

RegisteredOrganizationalUnitRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { RegisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

RegisteredOrganizationalUnitRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { RegisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

RegisteredOrganizationalUnitRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { RegisteredOrganizationalUnitRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

RegisteredOrganizationalUnitRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

SetupLandingZoneRule

A rule for matching events from CloudTrail where a landing zone was setup via Control Tower.

Initializers

import { SetupLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new SetupLandingZoneRule(scope: Construct, id: string, props: BaseRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	BaseRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: BaseRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { SetupLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

SetupLandingZoneRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { SetupLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

SetupLandingZoneRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { SetupLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

SetupLandingZoneRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { SetupLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

SetupLandingZoneRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

UpdatedLandingZoneRule

A rule for matching events from CloudTrail where a landing zone was updated via Control Tower.

Initializers

import { UpdatedLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new UpdatedLandingZoneRule(scope: Construct, id: string, props: BaseRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	BaseRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: BaseRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { UpdatedLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

UpdatedLandingZoneRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { UpdatedLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

UpdatedLandingZoneRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { UpdatedLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

UpdatedLandingZoneRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { UpdatedLandingZoneRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

UpdatedLandingZoneRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

UpdatedManagedAccountRule

A rule for matching events from CloudTrail where Control Tower updated a managed account.

Initializers

import { UpdatedManagedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

new UpdatedManagedAccountRule(scope: Construct, id: string, props: AccountRuleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	AccountRuleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: AccountRuleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.
addEventPattern	Adds an event pattern filter to this rule.
addTarget	Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

addEventPattern

public addEventPattern(eventPattern?: EventPattern): void

Adds an event pattern filter to this rule.

If a pattern was already specified, these values are merged into the existing pattern.

For example, if the rule already contains the pattern:

{ "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

And addEventPattern is called with the pattern:

{ "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

The resulting event pattern will be:

{ "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

eventPattern^Optional

• Type: aws-cdk-lib.aws_events.EventPattern

---

addTarget

public addTarget(target?: IRuleTarget): void

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

No-op if target is undefined.

target^Optional

• Type: aws-cdk-lib.aws_events.IRuleTarget

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isOwnedResource	Returns true if the construct was created by CDK, and false otherwise.
isResource	Check whether the given construct is a Resource.
fromEventRuleArn	Import an existing EventBridge Rule provided an ARN.

---

isConstruct

import { UpdatedManagedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

UpdatedManagedAccountRule.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isOwnedResource

import { UpdatedManagedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

UpdatedManagedAccountRule.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

construct^Required

• Type: constructs.IConstruct

---

isResource

import { UpdatedManagedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

UpdatedManagedAccountRule.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

construct^Required

• Type: constructs.IConstruct

---

fromEventRuleArn

import { UpdatedManagedAccountRule } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

UpdatedManagedAccountRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)

Import an existing EventBridge Rule provided an ARN.

scope^Required

• Type: constructs.Construct

The parent creating construct (usually this).

---

id^Required

• Type: string

The construct's name.

---

eventRuleArn^Required

• Type: string

Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.
ruleArn	string	The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
ruleName	string	The name event rule.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.ResourceEnvironment

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.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ruleArn^Required

public readonly ruleArn: string;

• Type: string

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.

---

ruleName^Required

public readonly ruleName: string;

• Type: string

The name event rule.

---

Constants

Name	Type	Description
PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

PROPERTY_INJECTION_ID^Required

public readonly PROPERTY_INJECTION_ID: string;

• Type: string

Uniquely identifies this class.

---

Structs

AccountRuleProps

Initializer

import { AccountRuleProps } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

const accountRuleProps: AccountRuleProps = { ... }

Properties

Name	Type	Description
description	string	A description of the rule's purpose.
enabled	boolean	Indicates whether the rule is enabled.
eventBus	aws-cdk-lib.aws_events.IEventBus	The event bus to associate with this rule.
eventState	EventStates	Which event state should this rule trigger for.
ruleName	string	A name for the rule.
targets	aws-cdk-lib.aws_events.IRuleTarget[]	Targets to invoke when this rule matches an event.
accountId	string	The account ID to match.
accountName	string	The account name to match.
ouId	string	The OU ID to match.
ouName	string	The OU name to match.

---

description^Optional

public readonly description: string;

• Type: string
• Default: A rule for new account creation in Organizations

A description of the rule's purpose.

---

enabled^Optional

public readonly enabled: boolean;

• Type: boolean
• Default: true

Indicates whether the rule is enabled.

---

eventBus^Optional

public readonly eventBus: IEventBus;

• Type: aws-cdk-lib.aws_events.IEventBus
• Default: The default event bus.

The event bus to associate with this rule.

---

eventState^Optional

public readonly eventState: EventStates;

• Type: EventStates
• Default: EventStates.SUCCEEDED

Which event state should this rule trigger for.

---

ruleName^Optional

public readonly ruleName: string;

• Type: string
• Default: AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

A name for the rule.

---

targets^Optional

public readonly targets: IRuleTarget[];

• Type: aws-cdk-lib.aws_events.IRuleTarget[]
• Default: No targets.

Targets to invoke when this rule matches an event.

---

accountId^Optional

public readonly accountId: string;

• Type: string

The account ID to match.

---

accountName^Optional

public readonly accountName: string;

• Type: string

The account name to match.

---

ouId^Optional

public readonly ouId: string;

• Type: string

The OU ID to match.

---

ouName^Optional

public readonly ouName: string;

• Type: string

The OU name to match.

---

BaseRuleProps

Initializer

import { BaseRuleProps } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

const baseRuleProps: BaseRuleProps = { ... }

Properties

Name	Type	Description
description	string	A description of the rule's purpose.
enabled	boolean	Indicates whether the rule is enabled.
eventBus	aws-cdk-lib.aws_events.IEventBus	The event bus to associate with this rule.
eventState	EventStates	Which event state should this rule trigger for.
ruleName	string	A name for the rule.
targets	aws-cdk-lib.aws_events.IRuleTarget[]	Targets to invoke when this rule matches an event.

---

description^Optional

public readonly description: string;

• Type: string
• Default: A rule for new account creation in Organizations

A description of the rule's purpose.

---

enabled^Optional

public readonly enabled: boolean;

• Type: boolean
• Default: true

Indicates whether the rule is enabled.

---

eventBus^Optional

public readonly eventBus: IEventBus;

• Type: aws-cdk-lib.aws_events.IEventBus
• Default: The default event bus.

The event bus to associate with this rule.

---

eventState^Optional

public readonly eventState: EventStates;

• Type: EventStates
• Default: EventStates.SUCCEEDED

Which event state should this rule trigger for.

---

ruleName^Optional

public readonly ruleName: string;

• Type: string
• Default: AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

A name for the rule.

---

targets^Optional

public readonly targets: IRuleTarget[];

• Type: aws-cdk-lib.aws_events.IRuleTarget[]
• Default: No targets.

Targets to invoke when this rule matches an event.

---

GuardrailRuleProps

Initializer

import { GuardrailRuleProps } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

const guardrailRuleProps: GuardrailRuleProps = { ... }

Properties

Name	Type	Description
description	string	A description of the rule's purpose.
enabled	boolean	Indicates whether the rule is enabled.
eventBus	aws-cdk-lib.aws_events.IEventBus	The event bus to associate with this rule.
eventState	EventStates	Which event state should this rule trigger for.
ruleName	string	A name for the rule.
targets	aws-cdk-lib.aws_events.IRuleTarget[]	Targets to invoke when this rule matches an event.
guardrailBehavior	GuardrailBehaviors	The guardrail behavior to match.
guardrailId	string	The guardrail ID to match.
ouId	string	The OU ID to match.
ouName	string	The OU name to match.

---

description^Optional

public readonly description: string;

• Type: string
• Default: A rule for new account creation in Organizations

A description of the rule's purpose.

---

enabled^Optional

public readonly enabled: boolean;

• Type: boolean
• Default: true

Indicates whether the rule is enabled.

---

eventBus^Optional

public readonly eventBus: IEventBus;

• Type: aws-cdk-lib.aws_events.IEventBus
• Default: The default event bus.

The event bus to associate with this rule.

---

eventState^Optional

public readonly eventState: EventStates;

• Type: EventStates
• Default: EventStates.SUCCEEDED

Which event state should this rule trigger for.

---

ruleName^Optional

public readonly ruleName: string;

• Type: string
• Default: AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

A name for the rule.

---

targets^Optional

public readonly targets: IRuleTarget[];

• Type: aws-cdk-lib.aws_events.IRuleTarget[]
• Default: No targets.

Targets to invoke when this rule matches an event.

---

guardrailBehavior^Optional

public readonly guardrailBehavior: GuardrailBehaviors;

• Type: GuardrailBehaviors

The guardrail behavior to match.

---

guardrailId^Optional

public readonly guardrailId: string;

• Type: string

The guardrail ID to match.

---

ouId^Optional

public readonly ouId: string;

• Type: string

The OU ID to match.

---

ouName^Optional

public readonly ouName: string;

• Type: string

The OU name to match.

---

OuRuleProps

Initializer

import { OuRuleProps } from '@renovosolutions/cdk-library-control-tower-lifecycle-events'

const ouRuleProps: OuRuleProps = { ... }

Properties

Name	Type	Description
description	string	A description of the rule's purpose.
enabled	boolean	Indicates whether the rule is enabled.
eventBus	aws-cdk-lib.aws_events.IEventBus	The event bus to associate with this rule.
eventState	EventStates	Which event state should this rule trigger for.
ruleName	string	A name for the rule.
targets	aws-cdk-lib.aws_events.IRuleTarget[]	Targets to invoke when this rule matches an event.
ouId	string	The OU ID to match.
ouName	string	The OU name to match.

---

description^Optional

public readonly description: string;

• Type: string
• Default: A rule for new account creation in Organizations

A description of the rule's purpose.

---

enabled^Optional

public readonly enabled: boolean;

• Type: boolean
• Default: true

Indicates whether the rule is enabled.

---

eventBus^Optional

public readonly eventBus: IEventBus;

• Type: aws-cdk-lib.aws_events.IEventBus
• Default: The default event bus.

The event bus to associate with this rule.

---

eventState^Optional

public readonly eventState: EventStates;

• Type: EventStates
• Default: EventStates.SUCCEEDED

Which event state should this rule trigger for.

---

ruleName^Optional

public readonly ruleName: string;

• Type: string
• Default: AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

A name for the rule.

---

targets^Optional

public readonly targets: IRuleTarget[];

• Type: aws-cdk-lib.aws_events.IRuleTarget[]
• Default: No targets.

Targets to invoke when this rule matches an event.

---

ouId^Optional

public readonly ouId: string;

• Type: string

The OU ID to match.

---

ouName^Optional

public readonly ouName: string;

• Type: string

The OU name to match.

---

Enums

EventStates

Members

Name	Description
SUCCEEDED	No description.
FAILED	No description.

---

SUCCEEDED

---

FAILED

---

GuardrailBehaviors

Members

Name	Description
DETECTIVE	No description.
PREVENTATIVE	No description.

---

DETECTIVE

---

PREVENTATIVE

---