Class CfnIntegrationResponseMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.CfnIntegrationResponseMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIntegrationResponseMixinProps>
- Enclosing interface:
CfnIntegrationResponseMixinProps
@Stability(Stable)
public static final class CfnIntegrationResponseMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIntegrationResponseMixinProps>
A builder for
CfnIntegrationResponseMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnIntegrationResponseMixinProps.getApiId()Sets the value ofCfnIntegrationResponseMixinProps.getApiId()build()Builds the configured instance.contentHandlingStrategy(String contentHandlingStrategy) Sets the value ofCfnIntegrationResponseMixinProps.getContentHandlingStrategy()integrationId(String integrationId) Sets the value ofCfnIntegrationResponseMixinProps.getIntegrationId()integrationId(IIntegrationRef integrationId) Sets the value ofCfnIntegrationResponseMixinProps.getIntegrationId()integrationResponseKey(String integrationResponseKey) Sets the value ofCfnIntegrationResponseMixinProps.getIntegrationResponseKey()responseParameters(Object responseParameters) Sets the value ofCfnIntegrationResponseMixinProps.getResponseParameters()responseTemplates(Object responseTemplates) Sets the value ofCfnIntegrationResponseMixinProps.getResponseTemplates()templateSelectionExpression(String templateSelectionExpression) Sets the value ofCfnIntegrationResponseMixinProps.getTemplateSelectionExpression()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
apiId
Sets the value ofCfnIntegrationResponseMixinProps.getApiId()- Parameters:
apiId- The API identifier.- Returns:
this
-
apiId
Sets the value ofCfnIntegrationResponseMixinProps.getApiId()- Parameters:
apiId- The API identifier.- Returns:
this
-
contentHandlingStrategy
@Stability(Stable) public CfnIntegrationResponseMixinProps.Builder contentHandlingStrategy(String contentHandlingStrategy) Sets the value ofCfnIntegrationResponseMixinProps.getContentHandlingStrategy()- Parameters:
contentHandlingStrategy- Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values areCONVERT_TO_BINARYandCONVERT_TO_TEXT, with the following behaviors:CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
- Returns:
this
-
integrationId
@Stability(Stable) public CfnIntegrationResponseMixinProps.Builder integrationId(String integrationId) Sets the value ofCfnIntegrationResponseMixinProps.getIntegrationId()- Parameters:
integrationId- The integration ID.- Returns:
this
-
integrationId
@Stability(Stable) public CfnIntegrationResponseMixinProps.Builder integrationId(IIntegrationRef integrationId) Sets the value ofCfnIntegrationResponseMixinProps.getIntegrationId()- Parameters:
integrationId- The integration ID.- Returns:
this
-
integrationResponseKey
@Stability(Stable) public CfnIntegrationResponseMixinProps.Builder integrationResponseKey(String integrationResponseKey) Sets the value ofCfnIntegrationResponseMixinProps.getIntegrationResponseKey()- Parameters:
integrationResponseKey- The integration response key.- Returns:
this
-
responseParameters
@Stability(Stable) public CfnIntegrationResponseMixinProps.Builder responseParameters(Object responseParameters) Sets the value ofCfnIntegrationResponseMixinProps.getResponseParameters()- Parameters:
responseParameters- A key-value map specifying response parameters that are passed to the method response from the backend. 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 ofmethod.response.header. *{name}*, where name is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header. *{name}*orintegration.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 CfnIntegrationResponseMixinProps.Builder responseTemplates(Object responseTemplates) Sets the value ofCfnIntegrationResponseMixinProps.getResponseTemplates()- Parameters:
responseTemplates- The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.- Returns:
this
-
templateSelectionExpression
@Stability(Stable) public CfnIntegrationResponseMixinProps.Builder templateSelectionExpression(String templateSelectionExpression) Sets the value ofCfnIntegrationResponseMixinProps.getTemplateSelectionExpression()- Parameters:
templateSelectionExpression- The template selection expression for the integration response. Supported only for WebSocket APIs.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnIntegrationResponseMixinProps>- Returns:
- a new instance of
CfnIntegrationResponseMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-