class Connection (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Events.Connection
Java	software.amazon.awscdk.services.events.Connection
Python	aws_cdk.aws_events.Connection
TypeScript (source)	@aws-cdk/aws-events » Connection

Implements IConstruct, IConstruct, IDependable, IResource, IConnection

Define an EventBridge Connection.

Example

const connection = new events.Connection(this, 'Connection', {
  authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),
  description: 'Connection with API Key x-api-key',
});

const destination = new events.ApiDestination(this, 'Destination', {
  connection,
  endpoint: 'https://example.com',
  description: 'Calling example.com with API key x-api-key',
});

const rule = new events.Rule(this, 'Rule', {
  schedule: events.Schedule.rate(cdk.Duration.minutes(1)),
  targets: [new targets.ApiDestination(destination)],
});

Initializer

new Connection(scope: Construct, id: string, props: ConnectionProps)

Parameters

• scope Construct
• id string
• props ConnectionProps

Construct Props

Name	Type	Description
authorization	Authorization	The authorization type for the connection.
bodyParameters?	{ [string]: HttpParameter }	Additional string parameters to add to the invocation bodies.
connectionName?	string	The name of the connection.
description?	string	The name of the connection.
headerParameters?	{ [string]: HttpParameter }	Additional string parameters to add to the invocation headers.
queryStringParameters?	{ [string]: HttpParameter }	Additional string parameters to add to the invocation query strings.

---

authorization

Type: Authorization

The authorization type for the connection.

---

bodyParameters?

Type: { [string]: HttpParameter } (optional, default: No additional parameters)

Additional string parameters to add to the invocation bodies.

---

connectionName?

Type: string (optional, default: A name is automatically generated)

The name of the connection.

---

description?

Type: string (optional, default: none)

The name of the connection.

---

headerParameters?

Type: { [string]: HttpParameter } (optional, default: No additional parameters)

Additional string parameters to add to the invocation headers.

---

queryStringParameters?

Type: { [string]: HttpParameter } (optional, default: No additional parameters)

Additional string parameters to add to the invocation query strings.

Properties

Name	Type	Description
connectionArn	string	The ARN of the connection created.
connectionName	string	The Name for the connection.
connectionSecretArn	string	The ARN for the secret created for the connection.
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The 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: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromConnectionAttributes(scope, id, attrs)	Import an existing connection resource.
static fromEventBusArn(scope, id, connectionArn, connectionSecretArn)	Import an existing connection 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).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromConnectionAttributes(scope, id, attrs)

public static fromConnectionAttributes(scope: Construct, id: string, attrs: ConnectionAttributes): IConnection

Parameters

• scope Construct — Parent construct.
• id string — Construct ID.
• attrs ConnectionAttributes — Imported connection properties.

Returns

• IConnection

Import an existing connection resource.

---

static fromEventBusArn(scope, id, connectionArn, connectionSecretArn)

public static fromEventBusArn(scope: Construct, id: string, connectionArn: string, connectionSecretArn: string): IConnection

Parameters

• scope Construct — Parent construct.
• id string — Construct ID.
• connectionArn string — ARN of imported connection.
• connectionSecretArn string

Returns

• IConnection

Import an existing connection resource.