Package software.amazon.awscdk.services.apigateway

Class StepFunctionsExecutionIntegrationOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.StepFunctionsExecutionIntegrationOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StepFunctionsExecutionIntegrationOptions>

Enclosing interface:

StepFunctionsExecutionIntegrationOptions

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

A builder for StepFunctionsExecutionIntegrationOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StepFunctionsExecutionIntegrationOptions.Builder	authorizer(Boolean authorizer)	Sets the value of StepFunctionsExecutionIntegrationOptions.getAuthorizer()
StepFunctionsExecutionIntegrationOptions	build()	Builds the configured instance.
StepFunctionsExecutionIntegrationOptions.Builder	cacheKeyParameters(List<String> cacheKeyParameters)	Sets the value of IntegrationOptions.getCacheKeyParameters()
StepFunctionsExecutionIntegrationOptions.Builder	cacheNamespace(String cacheNamespace)	Sets the value of IntegrationOptions.getCacheNamespace()
StepFunctionsExecutionIntegrationOptions.Builder	connectionType(ConnectionType connectionType)	Sets the value of IntegrationOptions.getConnectionType()
StepFunctionsExecutionIntegrationOptions.Builder	contentHandling(ContentHandling contentHandling)	Sets the value of IntegrationOptions.getContentHandling()
StepFunctionsExecutionIntegrationOptions.Builder	credentialsPassthrough(Boolean credentialsPassthrough)	Sets the value of IntegrationOptions.getCredentialsPassthrough()
StepFunctionsExecutionIntegrationOptions.Builder	credentialsRole(IRole credentialsRole)	Sets the value of IntegrationOptions.getCredentialsRole()
StepFunctionsExecutionIntegrationOptions.Builder	headers(Boolean headers)	Sets the value of StepFunctionsExecutionIntegrationOptions.getHeaders()
StepFunctionsExecutionIntegrationOptions.Builder	integrationResponses(List<? extends IntegrationResponse> integrationResponses)	Sets the value of IntegrationOptions.getIntegrationResponses()
StepFunctionsExecutionIntegrationOptions.Builder	passthroughBehavior(PassthroughBehavior passthroughBehavior)	Sets the value of IntegrationOptions.getPassthroughBehavior()
StepFunctionsExecutionIntegrationOptions.Builder	path(Boolean path)	Sets the value of StepFunctionsExecutionIntegrationOptions.getPath()
StepFunctionsExecutionIntegrationOptions.Builder	querystring(Boolean querystring)	Sets the value of StepFunctionsExecutionIntegrationOptions.getQuerystring()
StepFunctionsExecutionIntegrationOptions.Builder	requestContext(RequestContext requestContext)	Sets the value of StepFunctionsExecutionIntegrationOptions.getRequestContext()
StepFunctionsExecutionIntegrationOptions.Builder	requestParameters(Map<String,String> requestParameters)	Sets the value of IntegrationOptions.getRequestParameters()
StepFunctionsExecutionIntegrationOptions.Builder	requestTemplates(Map<String,String> requestTemplates)	Sets the value of IntegrationOptions.getRequestTemplates()
StepFunctionsExecutionIntegrationOptions.Builder	timeout(Duration timeout)	Sets the value of IntegrationOptions.getTimeout()
StepFunctionsExecutionIntegrationOptions.Builder	useDefaultMethodResponses(Boolean useDefaultMethodResponses)	Sets the value of StepFunctionsExecutionIntegrationOptions.getUseDefaultMethodResponses()
StepFunctionsExecutionIntegrationOptions.Builder	vpcLink(IVpcLink vpcLink)	Sets the value of IntegrationOptions.getVpcLink()

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

authorizer

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder authorizer(Boolean authorizer)

Sets the value of StepFunctionsExecutionIntegrationOptions.getAuthorizer()

Parameters:

authorizer - If the whole authorizer object, including custom context values should be in the execution input. The execution input will include a new key authorizer:

{ "body": {}, "authorizer": { "key": "value" } }

Returns:

this

headers

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder headers(Boolean headers)

Sets the value of StepFunctionsExecutionIntegrationOptions.getHeaders()

Parameters:

headers - Check if header is to be included inside the execution input. The execution input will include a new key headers:

{ "body": {}, "headers": { "header1": "value", "header2": "value" } }

Returns:

this

path

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder path(Boolean path)

Sets the value of StepFunctionsExecutionIntegrationOptions.getPath()

Parameters:

path - Check if path is to be included inside the execution input. The execution input will include a new key path:

{ "body": {}, "path": { "resourceName": "resourceValue" } }

Returns:

this

querystring

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder querystring(Boolean querystring)

Sets the value of StepFunctionsExecutionIntegrationOptions.getQuerystring()

Parameters:

querystring - Check if querystring is to be included inside the execution input. The execution input will include a new key queryString:

{ "body": {}, "querystring": { "key": "value" } }

Returns:

this

requestContext

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder requestContext(RequestContext requestContext)

Sets the value of StepFunctionsExecutionIntegrationOptions.getRequestContext()

Parameters:

requestContext - Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc. The execution input will include a new key requestContext:

{ "body": {}, "requestContext": { "key": "value" } }

Returns:

this

useDefaultMethodResponses

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder useDefaultMethodResponses(Boolean useDefaultMethodResponses)

Sets the value of StepFunctionsExecutionIntegrationOptions.getUseDefaultMethodResponses()

Parameters:

useDefaultMethodResponses - Whether to add default response models with 200, 400, and 500 status codes to the method.

Returns:

this

cacheKeyParameters

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder cacheKeyParameters(List<String> cacheKeyParameters)

Sets the value of IntegrationOptions.getCacheKeyParameters()

Parameters:

cacheKeyParameters - A list of request parameters whose values are to be cached. It determines request parameters that will make it into the cache key.

Returns:

this

cacheNamespace

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder cacheNamespace(String cacheNamespace)

Sets the value of IntegrationOptions.getCacheNamespace()

Parameters:

cacheNamespace - An API-specific tag group of related cached parameters.

Returns:

this

connectionType

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder connectionType(ConnectionType connectionType)

Sets the value of IntegrationOptions.getConnectionType()

Parameters:

connectionType - The type of network connection to the integration endpoint.

Returns:

this

contentHandling

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder contentHandling(ContentHandling contentHandling)

Sets the value of IntegrationOptions.getContentHandling()

Parameters:

contentHandling - Specifies how to handle request payload content type conversions.

Returns:

this

credentialsPassthrough

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder credentialsPassthrough(Boolean credentialsPassthrough)

Sets the value of IntegrationOptions.getCredentialsPassthrough()

Parameters:

credentialsPassthrough - Requires that the caller's identity be passed through from the request.

Returns:

this

credentialsRole

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder credentialsRole(IRole credentialsRole)

Sets the value of IntegrationOptions.getCredentialsRole()

Parameters:

credentialsRole - An IAM role that API Gateway assumes. Mutually exclusive with credentialsPassThrough.

Returns:

this

integrationResponses

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder integrationResponses(List<? extends IntegrationResponse> integrationResponses)

Sets the value of IntegrationOptions.getIntegrationResponses()

Parameters:

integrationResponses - The response that API Gateway provides after a method's backend completes processing a request. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.

Returns:

this

passthroughBehavior

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder passthroughBehavior(PassthroughBehavior passthroughBehavior)

Sets the value of IntegrationOptions.getPassthroughBehavior()

Parameters:

passthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

Returns:

this

requestParameters

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder requestParameters(Map<String,String> requestParameters)

Sets the value of IntegrationOptions.getRequestParameters()

Parameters:

requestParameters - The request parameters that API Gateway sends with the backend request. Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.

Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name.

The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.

Returns:

this

requestTemplates

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder requestTemplates(Map<String,String> requestTemplates)

Sets the value of IntegrationOptions.getRequestTemplates()

Parameters:

requestTemplates - A map of Apache Velocity templates that are applied on the request payload. The template that API Gateway uses is based on the value of the Content-Type header that's sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:

                           { "application/json": "{ \"statusCode\": 200 }" }
                         

Returns:

this

timeout

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder timeout(Duration timeout)

Sets the value of IntegrationOptions.getTimeout()

Parameters:

timeout - The maximum amount of time an integration will run before it returns without a response. By default, the value must be between 50 milliseconds and 29 seconds. The upper bound can be increased for regional and private Rest APIs only, via a quota increase request for your acccount. This increase might require a reduction in your account-level throttle quota limit. See

invalid @link

{@link https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html

Amazon API Gateway quotas} for more details.

Returns:

this

vpcLink

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions.Builder vpcLink(IVpcLink vpcLink)

Sets the value of IntegrationOptions.getVpcLink()

Parameters:

vpcLink - The VpcLink used for the integration. Required if connectionType is VPC_LINK

Returns:

this

build

@Stability(Stable)
public StepFunctionsExecutionIntegrationOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StepFunctionsExecutionIntegrationOptions

Throws:

NullPointerException - if any required attribute was not provided