AWS::Events::Connection - AWS CloudFormation

AWS::Events::Connection

Creates a connection that contains the authorization information to use to connect to an API destination HTTP endpoint.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Events::Connection", "Properties" : { "AuthorizationType" : String, "AuthParameters" : Json, "Description" : String, "Name" : String } }

YAML

Type: AWS::Events::Connection Properties: AuthorizationType: String AuthParameters: Json Description: String Name: String

Properties

AuthorizationType

The type of authorization to use for the connection. Valid Values: BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY

Required: Yes

Type: String

Update requires: No interruption

AuthParameters

Contains the authorization parameters to use to authorize with the endpoint. It must include one of the following: BasicAuthParameters, ApiKeyAuthParameters, or OAuthParameters.

Required: Yes

Type: Json

Update requires: No interruption

Description

A description for the connection to create.

Required: No

Type: String

Update requires: No interruption

Name

The name for the connection to create.

Required: No

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the connection that was created by the request.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the connection that was created by the request.

SecretArn

The ARN for the secret created for the connection.