Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnMethodPropsMixin.IntegrationResponseProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnMethodPropsMixin.IntegrationResponseProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMethodPropsMixin.IntegrationResponseProperty>

Enclosing interface:

CfnMethodPropsMixin.IntegrationResponseProperty

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

A builder for CfnMethodPropsMixin.IntegrationResponseProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnMethodPropsMixin.IntegrationResponseProperty	build()	Builds the configured instance.
CfnMethodPropsMixin.IntegrationResponseProperty.Builder	contentHandling(String contentHandling)	Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getContentHandling()
CfnMethodPropsMixin.IntegrationResponseProperty.Builder	responseParameters(Map<String,String> responseParameters)	Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getResponseParameters()
CfnMethodPropsMixin.IntegrationResponseProperty.Builder	responseParameters(IResolvable responseParameters)	Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getResponseParameters()
CfnMethodPropsMixin.IntegrationResponseProperty.Builder	responseTemplates(Map<String,String> responseTemplates)	Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getResponseTemplates()
CfnMethodPropsMixin.IntegrationResponseProperty.Builder	responseTemplates(IResolvable responseTemplates)	Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getResponseTemplates()
CfnMethodPropsMixin.IntegrationResponseProperty.Builder	selectionPattern(String selectionPattern)	Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getSelectionPattern()
CfnMethodPropsMixin.IntegrationResponseProperty.Builder	statusCode(String statusCode)	Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getStatusCode()

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

contentHandling

@Stability(Stable)
public CfnMethodPropsMixin.IntegrationResponseProperty.Builder contentHandling(String contentHandling)

Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getContentHandling()

Parameters:

contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Returns:

this

responseParameters

@Stability(Stable)
public CfnMethodPropsMixin.IntegrationResponseProperty.Builder responseParameters(Map<String,String> responseParameters)

Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getResponseParameters()

Parameters:

responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

Returns:

this

responseParameters

@Stability(Stable)
public CfnMethodPropsMixin.IntegrationResponseProperty.Builder responseParameters(IResolvable responseParameters)

Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getResponseParameters()

Parameters:

responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

Returns:

this

responseTemplates

@Stability(Stable)
public CfnMethodPropsMixin.IntegrationResponseProperty.Builder responseTemplates(Map<String,String> responseTemplates)

Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getResponseTemplates()

Parameters:

responseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Returns:

this

responseTemplates

@Stability(Stable)
public CfnMethodPropsMixin.IntegrationResponseProperty.Builder responseTemplates(IResolvable responseTemplates)

Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getResponseTemplates()

Parameters:

responseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Returns:

this

selectionPattern

@Stability(Stable)
public CfnMethodPropsMixin.IntegrationResponseProperty.Builder selectionPattern(String selectionPattern)

Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getSelectionPattern()

Parameters:

selectionPattern - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ( \n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Returns:

this

statusCode

@Stability(Stable)
public CfnMethodPropsMixin.IntegrationResponseProperty.Builder statusCode(String statusCode)

Sets the value of CfnMethodPropsMixin.IntegrationResponseProperty.getStatusCode()

Parameters:

statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

Returns:

this

build

@Stability(Stable)
public CfnMethodPropsMixin.IntegrationResponseProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnMethodPropsMixin.IntegrationResponseProperty>

Returns:

a new instance of CfnMethodPropsMixin.IntegrationResponseProperty

Throws:

NullPointerException - if any required attribute was not provided