AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Events::Connection

CfnConnection

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. For more information, see [Connections for endpoint targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection.html) in the *Amazon EventBridge User Guide* .

Import

import { CfnConnection } from 'aws-cdk-lib/aws-events';

Or use the module namespace:

import * as events from 'aws-cdk-lib/aws-events';
// events.CfnConnection

Properties

Configuration passed to the constructor as CfnConnectionProps.

authorizationTypeOptional
string

The type of authorization to use for the connection. > OAUTH tokens are refreshed when a 401 or 407 response is returned.

authParametersOptional
IResolvable | AuthParametersProperty

The authorization parameters to use to authorize with the endpoint. You must include only authorization parameters for the `AuthorizationType` you specify.

descriptionOptional
string

A description for the connection to create.

invocationConnectivityParametersOptional
IResolvable | InvocationConnectivityParametersProperty

For connections to private APIs, the parameters to use for invoking the API. For more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the **Amazon EventBridge User Guide** .

kmsKeyIdentifierOptional
string

The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the connection. For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the *AWS Key Management Service Developer Guide* .

nameOptional
string

The name for the connection to create.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Events::ConnectionView in CloudFormation Explorer

Get the Amazon EventBridge Cheat Sheet

Everything you need to know about Amazon EventBridge on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-events
CFN TypeAWS::Events::Connection
Properties6

Related Constructs

Explore This Service

External Links