Package software.amazon.awscdk.services.apigateway

Class Integration.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.Integration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Integration>

Enclosing class:

Integration

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

A fluent builder for Integration.

Method Summary

Modifier and Type	Method	Description
Integration	build()
static Integration.Builder	create()
Integration.Builder	integrationHttpMethod(String integrationHttpMethod)	The integration's HTTP method type.
Integration.Builder	options(IntegrationOptions options)	Integration options.
Integration.Builder	type(IntegrationType type)	Specifies an API method integration type.
Integration.Builder	uri(Object uri)	The Uniform Resource Identifier (URI) for the integration.

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 Integration.Builder create()

Returns:

a new instance of Integration.Builder.

type

@Stability(Stable)
public Integration.Builder type(IntegrationType type)

Specifies an API method integration type.

Parameters:

type - Specifies an API method integration type. This parameter is required.

Returns:

this

integrationHttpMethod

@Stability(Stable)
public Integration.Builder integrationHttpMethod(String integrationHttpMethod)

The integration's HTTP method type.

Required unless you use a MOCK integration.

Parameters:

integrationHttpMethod - The integration's HTTP method type. This parameter is required.

Returns:

this

options

@Stability(Stable)
public Integration.Builder options(IntegrationOptions options)

Integration options.

Parameters:

options - Integration options. This parameter is required.

Returns:

this

uri

@Stability(Stable)
public Integration.Builder uri(Object uri)

The Uniform Resource Identifier (URI) for the integration.

• If you specify HTTP for the type property, specify the API endpoint URL.
• If you specify MOCK for the type property, don't specify this property.
• If you specify AWS for the type property, specify an AWS service that follows this form: arn:partition:apigateway:region:subdomain.service|service:path|action/service_api. For example, a Lambda function URI follows this form: arn:partition:apigateway:region:lambda:path/path. The path is usually in the form /2015-03-31/functions/LambdaFunctionARN/invocations.

Parameters:

uri - The Uniform Resource Identifier (URI) for the integration. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri

build

@Stability(Stable)
public Integration build()

Specified by:

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

Returns:

a newly built instance of Integration.