Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class WebSocketAwsIntegrationProps.Builder

java.lang.Object

software.amazon.awscdk.aws_apigatewayv2_integrations.WebSocketAwsIntegrationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketAwsIntegrationProps>

Enclosing interface:

WebSocketAwsIntegrationProps

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

A builder for WebSocketAwsIntegrationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WebSocketAwsIntegrationProps	build()	Builds the configured instance.
WebSocketAwsIntegrationProps.Builder	contentHandling(ContentHandling contentHandling)	Sets the value of WebSocketAwsIntegrationProps.getContentHandling()
WebSocketAwsIntegrationProps.Builder	credentialsRole(IRole credentialsRole)	Sets the value of WebSocketAwsIntegrationProps.getCredentialsRole()
WebSocketAwsIntegrationProps.Builder	integrationMethod(String integrationMethod)	Sets the value of WebSocketAwsIntegrationProps.getIntegrationMethod()
WebSocketAwsIntegrationProps.Builder	integrationUri(String integrationUri)	Sets the value of WebSocketAwsIntegrationProps.getIntegrationUri()
WebSocketAwsIntegrationProps.Builder	passthroughBehavior(PassthroughBehavior passthroughBehavior)	Sets the value of WebSocketAwsIntegrationProps.getPassthroughBehavior()
WebSocketAwsIntegrationProps.Builder	requestParameters(Map<String,String> requestParameters)	Sets the value of WebSocketAwsIntegrationProps.getRequestParameters()
WebSocketAwsIntegrationProps.Builder	requestTemplates(Map<String,String> requestTemplates)	Sets the value of WebSocketAwsIntegrationProps.getRequestTemplates()
WebSocketAwsIntegrationProps.Builder	templateSelectionExpression(String templateSelectionExpression)	Sets the value of WebSocketAwsIntegrationProps.getTemplateSelectionExpression()
WebSocketAwsIntegrationProps.Builder	timeout(Duration timeout)	Sets the value of WebSocketAwsIntegrationProps.getTimeout()

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

integrationMethod

@Stability(Stable)
public WebSocketAwsIntegrationProps.Builder integrationMethod(String integrationMethod)

Sets the value of WebSocketAwsIntegrationProps.getIntegrationMethod()

Parameters:

integrationMethod - Specifies the integration's HTTP method type. This parameter is required.

Returns:

this

integrationUri

@Stability(Stable)
public WebSocketAwsIntegrationProps.Builder integrationUri(String integrationUri)

Sets the value of WebSocketAwsIntegrationProps.getIntegrationUri()

Parameters:

integrationUri - Integration URI. This parameter is required.

Returns:

this

contentHandling

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

Sets the value of WebSocketAwsIntegrationProps.getContentHandling()

Parameters:

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

Returns:

this

credentialsRole

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

Sets the value of WebSocketAwsIntegrationProps.getCredentialsRole()

Parameters:

credentialsRole - Specifies the credentials role required for the integration.

Returns:

this

passthroughBehavior

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

Sets the value of WebSocketAwsIntegrationProps.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 WebSocketAwsIntegrationProps.Builder requestParameters(Map<String,String> requestParameters)

Sets the value of WebSocketAwsIntegrationProps.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.

Returns:

this

requestTemplates

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

Sets the value of WebSocketAwsIntegrationProps.getRequestTemplates()

Parameters:

requestTemplates - A map of Apache Velocity templates that are applied on the request payload.

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

Returns:

this

templateSelectionExpression

@Stability(Stable)
public WebSocketAwsIntegrationProps.Builder templateSelectionExpression(String templateSelectionExpression)

Sets the value of WebSocketAwsIntegrationProps.getTemplateSelectionExpression()

Parameters:

templateSelectionExpression - The template selection expression for the integration.

Returns:

this

timeout

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

Sets the value of WebSocketAwsIntegrationProps.getTimeout()

Parameters:

timeout - The maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds.

Returns:

this

build

@Stability(Stable)
public WebSocketAwsIntegrationProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of WebSocketAwsIntegrationProps

Throws:

NullPointerException - if any required attribute was not provided