Package software.amazon.awscdk.services.events

Interface CfnApiDestinationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiDestinationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-26T23:01:05.303Z")
@Stability(Stable)
public interface CfnApiDestinationProps
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApiDestinationProps.Builder	A builder for CfnApiDestinationProps
static final class	CfnApiDestinationProps.Jsii$Proxy	An implementation for CfnApiDestinationProps

Method Summary

Modifier and Type	Method	Description
static CfnApiDestinationProps.Builder	builder()
String	getConnectionArn()	The ARN of the connection to use for the API destination.
default String	getDescription()	A description for the API destination to create.
String	getHttpMethod()	The method to use for the request to the HTTP invocation endpoint.
String	getInvocationEndpoint()	The URL to the HTTP invocation endpoint for the API destination.
default Number	getInvocationRateLimitPerSecond()	The maximum number of requests per second to send to the HTTP invocation endpoint.
default String	getName()	The name for the API destination to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectionArn

@Stability(Stable)
@NotNull
String getConnectionArn()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn

getHttpMethod

@Stability(Stable)
@NotNull
String getHttpMethod()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod

getInvocationEndpoint

@Stability(Stable)
@NotNull
String getInvocationEndpoint()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the API destination to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description

getInvocationRateLimitPerSecond

@Stability(Stable)
@Nullable
default Number getInvocationRateLimitPerSecond()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond

getName

@Stability(Stable)
@Nullable
default String getName()

The name for the API destination to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name

builder

@Stability(Stable)
static CfnApiDestinationProps.Builder builder()

Returns:

a CfnApiDestinationProps.Builder of CfnApiDestinationProps