software.amazon.awscdk.services.events

Class ApiDestination.Builder

java.lang.Object

software.amazon.awscdk.services.events.ApiDestination.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiDestination>

Enclosing class:

ApiDestination

@Stability(value=Stable)
public static final class ApiDestination.Builder
extends Object
implements software.amazon.jsii.Builder<ApiDestination>

A fluent builder for ApiDestination.

Method Summary

Modifier and Type	Method and Description
ApiDestination.Builder	apiDestinationName(String apiDestinationName) The name for the API destination.
ApiDestination	build()
ApiDestination.Builder	connection(IConnection connection) The ARN of the connection to use for the API destination.
static ApiDestination.Builder	create(software.constructs.Construct scope, String id)
ApiDestination.Builder	description(String description) A description for the API destination.
ApiDestination.Builder	endpoint(String endpoint) The URL to the HTTP invocation endpoint for the API destination..
ApiDestination.Builder	httpMethod(HttpMethod httpMethod) The method to use for the request to the HTTP invocation endpoint.
ApiDestination.Builder	rateLimitPerSecond(Number rateLimitPerSecond) The maximum number of requests per second to send to the HTTP invocation endpoint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static ApiDestination.Builder create(software.constructs.Construct scope,
                                                                     String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ApiDestination.Builder.

connection

@Stability(value=Stable)
public ApiDestination.Builder connection(IConnection connection)

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

Parameters:

connection - The ARN of the connection to use for the API destination. This parameter is required.

Returns:

this

endpoint

@Stability(value=Stable)
public ApiDestination.Builder endpoint(String endpoint)

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

Parameters:

endpoint - The URL to the HTTP invocation endpoint for the API destination.. This parameter is required.

Returns:

this

apiDestinationName

@Stability(value=Stable)
public ApiDestination.Builder apiDestinationName(String apiDestinationName)

The name for the API destination.

Default: - A unique name will be generated

Parameters:

apiDestinationName - The name for the API destination. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public ApiDestination.Builder description(String description)

A description for the API destination.

Default: - none

Parameters:

description - A description for the API destination. This parameter is required.

Returns:

this

httpMethod

@Stability(value=Stable)
public ApiDestination.Builder httpMethod(HttpMethod httpMethod)

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

Default: HttpMethod.POST

Parameters:

httpMethod - The method to use for the request to the HTTP invocation endpoint. This parameter is required.

Returns:

this

rateLimitPerSecond

@Stability(value=Stable)
public ApiDestination.Builder rateLimitPerSecond(Number rateLimitPerSecond)

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

Default: - Not rate limited

Parameters:

rateLimitPerSecond - The maximum number of requests per second to send to the HTTP invocation endpoint. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ApiDestination build()

Specified by:

build in interface software.amazon.jsii.Builder<ApiDestination>