Class CfnIntegrationResponsePropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIntegrationResponsePropsMixin>
- Enclosing class:
CfnIntegrationResponsePropsMixin
CfnIntegrationResponsePropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionThe API identifier.The API identifier.build()contentHandlingStrategy(String contentHandlingStrategy) Supported only for WebSocket APIs.create()create(CfnPropertyMixinOptions options) integrationId(String integrationId) The integration ID.integrationId(IIntegrationRef integrationId) The integration ID.integrationResponseKey(String integrationResponseKey) The integration response key.responseParameters(Object responseParameters) A key-value map specifying response parameters that are passed to the method response from the backend.responseTemplates(Object responseTemplates) The collection of response templates for the integration response as a string-to-string map of key-value pairs.templateSelectionExpression(String templateSelectionExpression) The template selection expression for the integration response.
-
Method Details
-
create
@Stability(Stable) public static CfnIntegrationResponsePropsMixin.Builder create(CfnPropertyMixinOptions options) - Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnIntegrationResponsePropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnIntegrationResponsePropsMixin.Builder.
-
apiId
The API identifier.- Parameters:
apiId- The API identifier. This parameter is required.- Returns:
this- See Also:
-
apiId
The API identifier.- Parameters:
apiId- The API identifier. This parameter is required.- Returns:
this- See Also:
-
contentHandlingStrategy
@Stability(Stable) public CfnIntegrationResponsePropsMixin.Builder contentHandlingStrategy(String contentHandlingStrategy) Supported only for WebSocket APIs.Specifies how to handle response payload content type conversions. Supported values are
CONVERT_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.
- Parameters:
contentHandlingStrategy- Supported only for WebSocket APIs. This parameter is required.- Returns:
this- See Also:
-
integrationId
@Stability(Stable) public CfnIntegrationResponsePropsMixin.Builder integrationId(String integrationId) The integration ID.- Parameters:
integrationId- The integration ID. This parameter is required.- Returns:
this- See Also:
-
integrationId
@Stability(Stable) public CfnIntegrationResponsePropsMixin.Builder integrationId(IIntegrationRef integrationId) The integration ID.- Parameters:
integrationId- The integration ID. This parameter is required.- Returns:
this- See Also:
-
integrationResponseKey
@Stability(Stable) public CfnIntegrationResponsePropsMixin.Builder integrationResponseKey(String integrationResponseKey) The integration response key.- Parameters:
integrationResponseKey- The integration response key. This parameter is required.- Returns:
this- See Also:
-
responseParameters
@Stability(Stable) public CfnIntegrationResponsePropsMixin.Builder responseParameters(Object 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 of
method.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.- Parameters:
responseParameters- A key-value map specifying response parameters that are passed to the method response from the backend. This parameter is required.- Returns:
this- See Also:
-
responseTemplates
@Stability(Stable) public CfnIntegrationResponsePropsMixin.Builder responseTemplates(Object 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.
- Parameters:
responseTemplates- The collection of response templates for the integration response as a string-to-string map of key-value pairs. This parameter is required.- Returns:
this- See Also:
-
templateSelectionExpression
@Stability(Stable) public CfnIntegrationResponsePropsMixin.Builder templateSelectionExpression(String templateSelectionExpression) The template selection expression for the integration response.Supported only for WebSocket APIs.
- Parameters:
templateSelectionExpression- The template selection expression for the integration response. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnIntegrationResponsePropsMixin>- Returns:
- a newly built instance of
CfnIntegrationResponsePropsMixin.
-