AWS::Events::ApiDestination - AWS CloudFormation

AWS::Events::ApiDestination

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

Syntax

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

JSON

{ "Type" : "AWS::Events::ApiDestination", "Properties" : { "ConnectionArn" : String, "Description" : String, "HttpMethod" : String, "InvocationEndpoint" : String, "InvocationRateLimitPerSecond" : Integer, "Name" : String } }

YAML

Type: AWS::Events::ApiDestination Properties: ConnectionArn: String Description: String HttpMethod: String InvocationEndpoint: String InvocationRateLimitPerSecond: Integer Name: String

Properties

ConnectionArn

The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

Required: Yes

Type: String

Update requires: No interruption

Description

A description for the API destination to create. Maximum length of 512 characters.

Required: No

Type: String

Update requires: No interruption

HttpMethod

The method to use for the request to the HTTP invocation endpoint. One of POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE.

Required: Yes

Type: String

Update requires: No interruption

InvocationEndpoint

The URL to the HTTP invocation endpoint for the API destination.

Required: Yes

Type: String

Update requires: No interruption

InvocationRateLimitPerSecond

The maximum number of requests per second to send to the HTTP invocation endpoint.

Required: No

Type: Integer

Update requires: No interruption

Name

The name for the API destination 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 API destination 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 API destination that was created by the request.