interface CfnApiDestinationProps

Language	Type name
.NET	`Amazon.CDK.AWS.Events.CfnApiDestinationProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnApiDestinationProps`
Java	`software.amazon.awscdk.services.events.CfnApiDestinationProps`
Python	`aws_cdk.aws_events.CfnApiDestinationProps`
TypeScript	`aws-cdk-lib` » `aws_events` » `CfnApiDestinationProps`

Properties for defining a CfnApiDestination.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html

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

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.