Interface CfnApiDestinationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApiDestinationProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:36.937Z")
@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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnApiDestinationProps
static final class
An implementation forCfnApiDestinationProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The ARN of the connection to use for the API destination.default String
A description for the API destination to create.The method to use for the request to the HTTP invocation endpoint.The URL to the HTTP invocation endpoint for the API destination.default Number
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
The ARN of the connection to use for the API destination.The destination endpoint must support the authorization type specified for the connection.
-
getHttpMethod
The method to use for the request to the HTTP invocation endpoint. -
getInvocationEndpoint
The URL to the HTTP invocation endpoint for the API destination. -
getDescription
A description for the API destination to create. -
getInvocationRateLimitPerSecond
The maximum number of requests per second to send to the HTTP invocation endpoint. -
getName
The name for the API destination to create. -
builder
- Returns:
- a
CfnApiDestinationProps.Builder
ofCfnApiDestinationProps
-