Package software.amazon.awscdk.services.events

Class ApiDestinationProps.Builder

java.lang.Object

software.amazon.awscdk.services.events.ApiDestinationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiDestinationProps>

Enclosing interface:

ApiDestinationProps

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

A builder for ApiDestinationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiDestinationProps.Builder	apiDestinationName(String apiDestinationName)	Sets the value of ApiDestinationProps.getApiDestinationName()
ApiDestinationProps	build()	Builds the configured instance.
ApiDestinationProps.Builder	connection(IConnection connection)	Sets the value of ApiDestinationProps.getConnection()
ApiDestinationProps.Builder	description(String description)	Sets the value of ApiDestinationProps.getDescription()
ApiDestinationProps.Builder	endpoint(String endpoint)	Sets the value of ApiDestinationProps.getEndpoint()
ApiDestinationProps.Builder	httpMethod(HttpMethod httpMethod)	Sets the value of ApiDestinationProps.getHttpMethod()
ApiDestinationProps.Builder	rateLimitPerSecond(Number rateLimitPerSecond)	Sets the value of ApiDestinationProps.getRateLimitPerSecond()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

connection

@Stability(Stable)
public ApiDestinationProps.Builder connection(IConnection connection)

Sets the value of ApiDestinationProps.getConnection()

Parameters:

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

Returns:

this

endpoint

@Stability(Stable)
public ApiDestinationProps.Builder endpoint(String endpoint)

Sets the value of ApiDestinationProps.getEndpoint()

Parameters:

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

Returns:

this

apiDestinationName

@Stability(Stable)
public ApiDestinationProps.Builder apiDestinationName(String apiDestinationName)

Sets the value of ApiDestinationProps.getApiDestinationName()

Parameters:

apiDestinationName - The name for the API destination.

Returns:

this

description

@Stability(Stable)
public ApiDestinationProps.Builder description(String description)

Sets the value of ApiDestinationProps.getDescription()

Parameters:

description - A description for the API destination.

Returns:

this

httpMethod

@Stability(Stable)
public ApiDestinationProps.Builder httpMethod(HttpMethod httpMethod)

Sets the value of ApiDestinationProps.getHttpMethod()

Parameters:

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

Returns:

this

rateLimitPerSecond

@Stability(Stable)
public ApiDestinationProps.Builder rateLimitPerSecond(Number rateLimitPerSecond)

Sets the value of ApiDestinationProps.getRateLimitPerSecond()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public ApiDestinationProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApiDestinationProps

Throws:

NullPointerException - if any required attribute was not provided