interface CfnApiDestinationProps

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

Properties for defining a CfnApiDestination.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as events from '@aws-cdk/aws-events';
const cfnApiDestinationProps: events.CfnApiDestinationProps = {
  connectionArn: 'connectionArn',
  httpMethod: 'httpMethod',
  invocationEndpoint: 'invocationEndpoint',

  // the properties below are optional
  description: 'description',
  invocationRateLimitPerSecond: 123,
  name: 'name',
};

Properties

Name	Type	Description
connectionArn	string	The ARN of the connection to use for the API destination.
httpMethod	string	The method to use for the request to the HTTP invocation endpoint.
invocationEndpoint	string	The URL to the HTTP invocation endpoint for the API destination.
description?	string	A description for the API destination to create.
invocationRateLimitPerSecond?	number	The maximum number of requests per second to send to the HTTP invocation endpoint.
name?	string	The name for the API destination to create.

---

connectionArn

Type: string

The ARN of the connection to use for the API destination.

The destination endpoint must support the authorization type specified for the connection.

---

httpMethod

Type: string

The method to use for the request to the HTTP invocation endpoint.

---

invocationEndpoint

Type: string

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

---

description?

Type: string (optional)

A description for the API destination to create.

---

invocationRateLimitPerSecond?

Type: number (optional)

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

---

name?

Type: string (optional)

The name for the API destination to create.