aws-cdk-lib.aws_events.CfnApiDestinationProps

interface CfnApiDestinationProps

LanguageType name
.NETAmazon.CDK.AWS.Events.CfnApiDestinationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnApiDestinationProps
Javasoftware.amazon.awscdk.services.events.CfnApiDestinationProps
Pythonaws_cdk.aws_events.CfnApiDestinationProps
TypeScript aws-cdk-lib » 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 { aws_events as events } from 'aws-cdk-lib';
const cfnApiDestinationProps: events.CfnApiDestinationProps = {
  connectionArn: 'connectionArn',
  httpMethod: 'httpMethod',
  invocationEndpoint: 'invocationEndpoint',

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

Properties

NameTypeDescription
connectionArnstringThe ARN of the connection to use for the API destination.
httpMethodstringThe method to use for the request to the HTTP invocation endpoint.
invocationEndpointstringThe URL to the HTTP invocation endpoint for the API destination.
description?stringA description for the API destination to create.
invocationRateLimitPerSecond?numberThe maximum number of requests per second to send to the HTTP invocation endpoint.
name?stringThe 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.