software.amazon.awscdk.services.apigateway

Class AwsIntegration.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.AwsIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsIntegration>

Enclosing class:

AwsIntegration

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

A fluent builder for AwsIntegration.

Method Summary

Modifier and Type	Method and Description
AwsIntegration.Builder	action(String action) The AWS action to perform in the integration.
AwsIntegration.Builder	actionParameters(Map<String,String> actionParameters) Parameters for the action.
AwsIntegration	build()
static AwsIntegration.Builder	create()
AwsIntegration.Builder	integrationHttpMethod(String integrationHttpMethod) The integration's HTTP method type.
AwsIntegration.Builder	options(IntegrationOptions options) Integration options, such as content handling, request/response mapping, etc.
AwsIntegration.Builder	path(String path) The path to use for path-base APIs.
AwsIntegration.Builder	proxy(Boolean proxy) Use AWS_PROXY integration.
AwsIntegration.Builder	region(String region) The region of the integrated AWS service.
AwsIntegration.Builder	service(String service) The name of the integrated AWS service (e.g.
AwsIntegration.Builder	subdomain(String subdomain) A designated subdomain supported by certain AWS service for fast host-name lookup.

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

Returns:

a new instance of AwsIntegration.Builder.

service

@Stability(value=Stable)
public AwsIntegration.Builder service(String service)

The name of the integrated AWS service (e.g. `s3`).

Parameters:

service - The name of the integrated AWS service (e.g. `s3`). This parameter is required.

Returns:

this

action

@Stability(value=Stable)
public AwsIntegration.Builder action(String action)

The AWS action to perform in the integration.

Use actionParams to specify key-value params for the action.

Mutually exclusive with path.

Parameters:

action - The AWS action to perform in the integration. This parameter is required.

Returns:

this

actionParameters

@Stability(value=Stable)
public AwsIntegration.Builder actionParameters(Map<String,String> actionParameters)

Parameters for the action.

action must be set, and path must be undefined. The action params will be URL encoded.

Parameters:

actionParameters - Parameters for the action. This parameter is required.

Returns:

this

integrationHttpMethod

@Stability(value=Stable)
public AwsIntegration.Builder integrationHttpMethod(String integrationHttpMethod)

The integration's HTTP method type.

Default: POST

Parameters:

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

Returns:

this

options

@Stability(value=Stable)
public AwsIntegration.Builder options(IntegrationOptions options)

Integration options, such as content handling, request/response mapping, etc.

Parameters:

options - Integration options, such as content handling, request/response mapping, etc. This parameter is required.

Returns:

this

path

@Stability(value=Stable)
public AwsIntegration.Builder path(String path)

The path to use for path-base APIs.

For example, for S3 GET, you can set path to bucket/key. For lambda, you can set path to 2015-03-31/functions/${function-arn}/invocations

Mutually exclusive with the action options.

Parameters:

path - The path to use for path-base APIs. This parameter is required.

Returns:

this

proxy

@Stability(value=Stable)
public AwsIntegration.Builder proxy(Boolean proxy)

Use AWS_PROXY integration.

Default: false

Parameters:

proxy - Use AWS_PROXY integration. This parameter is required.

Returns:

this

region

@Stability(value=Stable)
public AwsIntegration.Builder region(String region)

The region of the integrated AWS service.

Default: - same region as the stack

Parameters:

region - The region of the integrated AWS service. This parameter is required.

Returns:

this

subdomain

@Stability(value=Stable)
public AwsIntegration.Builder subdomain(String subdomain)

A designated subdomain supported by certain AWS service for fast host-name lookup.

Parameters:

subdomain - A designated subdomain supported by certain AWS service for fast host-name lookup. This parameter is required.

Returns:

this

build

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

Specified by:

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