software.amazon.awscdk.services.apigateway

Class CfnMethod.IntegrationResponseProperty.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnMethod.IntegrationResponseProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnMethod.IntegrationResponseProperty

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

A builder for CfnMethod.IntegrationResponseProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

statusCode

@Stability(value=Stable)
public CfnMethod.IntegrationResponseProperty.Builder statusCode(String statusCode)

Sets the value of CfnMethod.IntegrationResponseProperty.getStatusCode()

Parameters:

statusCode - The status code that API Gateway uses to map the integration response to a [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) status code. This parameter is required.

Returns:

this

contentHandling

@Stability(value=Stable)
public CfnMethod.IntegrationResponseProperty.Builder contentHandling(String contentHandling)

Sets the value of CfnMethod.IntegrationResponseProperty.getContentHandling()

Parameters:

contentHandling - Specifies how to handle request payload content type conversions. Valid values are:.

• CONVERT_TO_BINARY : Converts a request payload from a base64-encoded string to a binary blob.
• CONVERT_TO_TEXT : Converts a request payload from a binary blob to a base64-encoded string.

If this property isn't defined, the request payload is passed through from the method request to the integration request without modification.

Returns:

this

responseParameters

@Stability(value=Stable)
public CfnMethod.IntegrationResponseProperty.Builder responseParameters(IResolvable responseParameters)

Sets the value of CfnMethod.IntegrationResponseProperty.getResponseParameters()

Parameters:

responseParameters - The response parameters from the backend response that API Gateway sends to the method response. Specify response parameters as key-value pairs ( string-to-string mappings ).

Use the destination as the key and the source as the value:

• The destination must be an existing response parameter in the MethodResponse property.
• 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 the destination specified in the request.

For more information about templates, see API Gateway Mapping Template and Access Logging Variable Reference in the API Gateway Developer Guide .

Returns:

this

responseParameters

@Stability(value=Stable)
public CfnMethod.IntegrationResponseProperty.Builder responseParameters(Map<String,String> responseParameters)

Sets the value of CfnMethod.IntegrationResponseProperty.getResponseParameters()

Parameters:

responseParameters - The response parameters from the backend response that API Gateway sends to the method response. Specify response parameters as key-value pairs ( string-to-string mappings ).

Use the destination as the key and the source as the value:

• The destination must be an existing response parameter in the MethodResponse property.
• 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 the destination specified in the request.

For more information about templates, see API Gateway Mapping Template and Access Logging Variable Reference in the API Gateway Developer Guide .

Returns:

this

responseTemplates

@Stability(value=Stable)
public CfnMethod.IntegrationResponseProperty.Builder responseTemplates(IResolvable responseTemplates)

Sets the value of CfnMethod.IntegrationResponseProperty.getResponseTemplates()

Parameters:

responseTemplates - The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value. For more information, see API Gateway Mapping Template and Access Logging Variable Reference in the API Gateway Developer Guide .

Returns:

this

responseTemplates

@Stability(value=Stable)
public CfnMethod.IntegrationResponseProperty.Builder responseTemplates(Map<String,String> responseTemplates)

Sets the value of CfnMethod.IntegrationResponseProperty.getResponseTemplates()

Parameters:

responseTemplates - The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value. For more information, see API Gateway Mapping Template and Access Logging Variable Reference in the API Gateway Developer Guide .

Returns:

this

selectionPattern

@Stability(value=Stable)
public CfnMethod.IntegrationResponseProperty.Builder selectionPattern(String selectionPattern)

Sets the value of CfnMethod.IntegrationResponseProperty.getSelectionPattern()

Parameters:

selectionPattern - A [regular expression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-regexes.html) that specifies which error strings or status codes from the backend map to the integration response.

Returns:

this

build

@Stability(value=Stable)
public CfnMethod.IntegrationResponseProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnMethod.IntegrationResponseProperty

Throws:

NullPointerException - if any required attribute was not provided