aws-cdk-lib.aws_events.IConnection

interface IConnection

LanguageType name
.NETAmazon.CDK.AWS.Events.IConnection
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#IConnection
Javasoftware.amazon.awscdk.services.events.IConnection
Pythonaws_cdk.aws_events.IConnection
TypeScript (source)aws-cdk-lib » aws_events » IConnection

Implemented by Connection

Obtainable from Connection.fromConnectionAttributes(), Connection.fromEventBusArn()

Interface for EventBus Connections.

Properties

NameTypeDescription
connectionArnstringThe ARN of the connection created.
connectionNamestringThe Name for the connection.
connectionSecretArnstringThe ARN for the secret created for the connection.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

connectionArn

Type: string

The ARN of the connection created.


connectionName

Type: string

The Name for the connection.


connectionSecretArn

Type: string

The ARN for the secret created for the connection.


env

Type: 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.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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