Package software.amazon.awscdk.services.events

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 Type	Method	Description
CfnApiDestination	build()
CfnApiDestination.Builder	connectionArn(String connectionArn)	The ARN of the connection to use for the API destination.
static CfnApiDestination.Builder	create(software.constructs.Construct scope, String id)
CfnApiDestination.Builder	description(String description)	A description for the API destination to create.
CfnApiDestination.Builder	httpMethod(String httpMethod)	The method to use for the request to the HTTP invocation endpoint.
CfnApiDestination.Builder	invocationEndpoint(String invocationEndpoint)	The URL to the HTTP invocation endpoint for the API destination.
CfnApiDestination.Builder	invocationRateLimitPerSecond(Number invocationRateLimitPerSecond)	The maximum number of requests per second to send to the HTTP invocation endpoint.
CfnApiDestination.Builder	name(String name)	The name for the API destination to create.

Methods inherited from class java.lang.Object

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

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

@Stability(Stable)
public CfnApiDestination.Builder connectionArn(String 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:

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

httpMethod

@Stability(Stable)
public CfnApiDestination.Builder httpMethod(String 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:

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

invocationEndpoint

@Stability(Stable)
public CfnApiDestination.Builder invocationEndpoint(String 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:

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

description

@Stability(Stable)
public CfnApiDestination.Builder description(String 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:

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

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:

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

name

@Stability(Stable)
public CfnApiDestination.Builder name(String 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:

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

build

@Stability(Stable)
public CfnApiDestination build()

Specified by:

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

Returns:

a newly built instance of CfnApiDestination.