Interface ICfnIntegrationResponseProps

Properties for defining a CfnIntegrationResponse.

Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnIntegrationResponseProps
Syntax (vb)
Public Interface ICfnIntegrationResponseProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;

var responseParameters;
var responseTemplates;

var cfnIntegrationResponseProps = new CfnIntegrationResponseProps {
    ApiId = "apiId",
    IntegrationId = "integrationId",
    IntegrationResponseKey = "integrationResponseKey",

    // the properties below are optional
    ContentHandlingStrategy = "contentHandlingStrategy",
    ResponseParameters = responseParameters,
    ResponseTemplates = responseTemplates,
    TemplateSelectionExpression = "templateSelectionExpression"
};

Synopsis

Properties

ApiId

The API identifier.
ContentHandlingStrategy

Supported only for WebSocket APIs.
IntegrationId

The integration ID.
IntegrationResponseKey

The integration response key.
ResponseParameters

A key-value map specifying response parameters that are passed to the method response from the backend.
ResponseTemplates

The collection of response templates for the integration response as a string-to-string map of key-value pairs.
TemplateSelectionExpression

The template selection expression for the integration response.

Properties

ApiId

The API identifier.

string ApiId { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-apiid

ContentHandlingStrategy

Supported only for WebSocket APIs.

virtual string ContentHandlingStrategy { get; }
Property Value

System.String

Remarks

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-contenthandlingstrategy

IntegrationId

The integration ID.

string IntegrationId { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationid

IntegrationResponseKey

The integration response key.

string IntegrationResponseKey { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationresponsekey

ResponseParameters

A key-value map specifying response parameters that are passed to the method response from the backend.

virtual object ResponseParameters { get; }
Property Value

System.Object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responseparameters

ResponseTemplates

The collection of response templates for the integration response as a string-to-string map of key-value pairs.

virtual object ResponseTemplates { get; }
Property Value

System.Object

Remarks

Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responsetemplates

TemplateSelectionExpression

The template selection expression for the integration response.

virtual string TemplateSelectionExpression { get; }
Property Value

System.String

Remarks

Supported only for WebSocket APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression