CfnApiDestinationProps Struct
Properties for defining a CfnApiDestination.
| Source |
|---|
Example
ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_events as events
cfn_api_destination_props = events.CfnApiDestinationProps(
connection_arn="connectionArn",
http_method="httpMethod",
invocation_endpoint="invocationEndpoint",
# the properties below are optional
description="description",
invocation_rate_limit_per_second=123,
name="name"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.events.*;
CfnApiDestinationProps cfnApiDestinationProps = CfnApiDestinationProps.builder()
.connectionArn("connectionArn")
.httpMethod("httpMethod")
.invocationEndpoint("invocationEndpoint")
// the properties below are optional
.description("description")
.invocationRateLimitPerSecond(123)
.name("name")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var cfnApiDestinationProps = new CfnApiDestinationProps {
ConnectionArn = "connectionArn",
HttpMethod = "httpMethod",
InvocationEndpoint = "invocationEndpoint",
// the properties below are optional
Description = "description",
InvocationRateLimitPerSecond = 123,
Name = "name"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnApiDestinationProps := &CfnApiDestinationProps{
ConnectionArn: jsii.String("connectionArn"),
HttpMethod: jsii.String("httpMethod"),
InvocationEndpoint: jsii.String("invocationEndpoint"),
// the properties below are optional
Description: jsii.String("description"),
InvocationRateLimitPerSecond: jsii.Number(123),
Name: jsii.String("name"),
}
Properties
connectionArnstringconnection_arnstrconnectionArnStringConnectionArnstringConnectionArn*string required #The ARN of the connection to use for the API destination.
The destination endpoint must support the authorization type specified for the connection.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #A description for the API destination to create.
The method to use for the request to the HTTP invocation endpoint.
invocationEndpointstringinvocation_endpointstrinvocationEndpointStringInvocationEndpointstringInvocationEndpoint*string required #The URL to the HTTP invocation endpoint for the API destination.
invocationRateLimitPerSecondoptionalnumberinvocation_rate_limit_per_secondoptionalint | floatinvocationRateLimitPerSecondoptionalNumberInvocationRateLimitPerSecondoptionaldoubleInvocationRateLimitPerSecondoptional*float64 #The maximum number of requests per second to send to the HTTP invocation endpoint.
The name for the API destination to create.