Class CfnApiDestination.Builder
java.lang.Object
software.amazon.awscdk.services.events.CfnApiDestination.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnApiDestination>
- Enclosing class:
CfnApiDestination
@Stability(Stable)
public static final class CfnApiDestination.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApiDestination>
A fluent builder for
CfnApiDestination
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
connectionArn
(String connectionArn) The ARN of the connection to use for the API destination.static CfnApiDestination.Builder
description
(String description) A description for the API destination to create.httpMethod
(String httpMethod) The method to use for the request to the HTTP invocation endpoint.invocationEndpoint
(String invocationEndpoint) The URL to the HTTP invocation endpoint for the API destination.invocationRateLimitPerSecond
(Number invocationRateLimitPerSecond) The maximum number of requests per second to send to the HTTP invocation endpoint.The name for the API destination to create.
-
Method Details
-
create
@Stability(Stable) public static CfnApiDestination.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnApiDestination.Builder
.
-
connectionArn
The ARN of the connection to use for the API destination.The destination endpoint must support the authorization type specified for the connection.
- Parameters:
connectionArn
- The ARN of the connection to use for the API destination. This parameter is required.- Returns:
this
- See Also:
-
httpMethod
The method to use for the request to the HTTP invocation endpoint.- Parameters:
httpMethod
- The method to use for the request to the HTTP invocation endpoint. This parameter is required.- Returns:
this
- See Also:
-
invocationEndpoint
The URL to the HTTP invocation endpoint for the API destination.- Parameters:
invocationEndpoint
- The URL to the HTTP invocation endpoint for the API destination. This parameter is required.- Returns:
this
- See Also:
-
description
A description for the API destination to create.- Parameters:
description
- A description for the API destination to create. This parameter is required.- Returns:
this
- See Also:
-
invocationRateLimitPerSecond
@Stability(Stable) public CfnApiDestination.Builder invocationRateLimitPerSecond(Number invocationRateLimitPerSecond) The maximum number of requests per second to send to the HTTP invocation endpoint.- Parameters:
invocationRateLimitPerSecond
- The maximum number of requests per second to send to the HTTP invocation endpoint. This parameter is required.- Returns:
this
- See Also:
-
name
The name for the API destination to create.- Parameters:
name
- The name for the API destination to create. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnApiDestination>
- Returns:
- a newly built instance of
CfnApiDestination
.
-