Package software.amazon.awscdk.services.apigateway

Class AwsIntegrationProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.AwsIntegrationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsIntegrationProps>

Enclosing interface:

AwsIntegrationProps

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

A builder for AwsIntegrationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AwsIntegrationProps.Builder	action(String action)	Sets the value of AwsIntegrationProps.getAction()
AwsIntegrationProps.Builder	actionParameters(Map<String,String> actionParameters)	Sets the value of AwsIntegrationProps.getActionParameters()
AwsIntegrationProps	build()	Builds the configured instance.
AwsIntegrationProps.Builder	integrationHttpMethod(String integrationHttpMethod)	Sets the value of AwsIntegrationProps.getIntegrationHttpMethod()
AwsIntegrationProps.Builder	options(IntegrationOptions options)	Sets the value of AwsIntegrationProps.getOptions()
AwsIntegrationProps.Builder	path(String path)	Sets the value of AwsIntegrationProps.getPath()
AwsIntegrationProps.Builder	proxy(Boolean proxy)	Sets the value of AwsIntegrationProps.getProxy()
AwsIntegrationProps.Builder	region(String region)	Sets the value of AwsIntegrationProps.getRegion()
AwsIntegrationProps.Builder	service(String service)	Sets the value of AwsIntegrationProps.getService()
AwsIntegrationProps.Builder	subdomain(String subdomain)	Sets the value of AwsIntegrationProps.getSubdomain()

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

service

@Stability(Stable)
public AwsIntegrationProps.Builder service(String service)

Sets the value of AwsIntegrationProps.getService()

Parameters:

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

Returns:

this

action

@Stability(Stable)
public AwsIntegrationProps.Builder action(String action)

Sets the value of AwsIntegrationProps.getAction()

Parameters:

action - The AWS action to perform in the integration. Use actionParams to specify key-value params for the action.

Mutually exclusive with path.

Returns:

this

actionParameters

@Stability(Stable)
public AwsIntegrationProps.Builder actionParameters(Map<String,String> actionParameters)

Sets the value of AwsIntegrationProps.getActionParameters()

Parameters:

actionParameters - Parameters for the action. action must be set, and path must be undefined. The action params will be URL encoded.

Returns:

this

integrationHttpMethod

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

Sets the value of AwsIntegrationProps.getIntegrationHttpMethod()

Parameters:

integrationHttpMethod - The integration's HTTP method type.

Returns:

this

options

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

Sets the value of AwsIntegrationProps.getOptions()

Parameters:

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

Returns:

this

path

@Stability(Stable)
public AwsIntegrationProps.Builder path(String path)

Sets the value of AwsIntegrationProps.getPath()

Parameters:

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.

Returns:

this

proxy

@Stability(Stable)
public AwsIntegrationProps.Builder proxy(Boolean proxy)

Sets the value of AwsIntegrationProps.getProxy()

Parameters:

proxy - Use AWS_PROXY integration.

Returns:

this

region

@Stability(Stable)
public AwsIntegrationProps.Builder region(String region)

Sets the value of AwsIntegrationProps.getRegion()

Parameters:

region - The region of the integrated AWS service.

Returns:

this

subdomain

@Stability(Stable)
public AwsIntegrationProps.Builder subdomain(String subdomain)

Sets the value of AwsIntegrationProps.getSubdomain()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public AwsIntegrationProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AwsIntegrationProps

Throws:

NullPointerException - if any required attribute was not provided