Class CfnIntegrationResponseMixinProps

Properties for CfnIntegrationResponsePropsMixin.

Inheritance

object

CfnIntegrationResponseMixinProps

Implements

ICfnIntegrationResponseMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnIntegrationResponseMixinProps : ICfnIntegrationResponseMixinProps

Syntax (vb)

Public Class CfnIntegrationResponseMixinProps Implements ICfnIntegrationResponseMixinProps

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.Mixins.Preview.AWS.ApiGatewayV2.Mixins;

             var responseParameters;
             var responseTemplates;

             var cfnIntegrationResponseMixinProps = new CfnIntegrationResponseMixinProps {
                 ApiId = "apiId",
                 ContentHandlingStrategy = "contentHandlingStrategy",
                 IntegrationId = "integrationId",
                 IntegrationResponseKey = "integrationResponseKey",
                 ResponseParameters = responseParameters,
                 ResponseTemplates = responseTemplates,
                 TemplateSelectionExpression = "templateSelectionExpression"
             };

Synopsis

Constructors

CfnIntegrationResponseMixinProps()

Properties for CfnIntegrationResponsePropsMixin.

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.

Constructors

CfnIntegrationResponseMixinProps()

Properties for CfnIntegrationResponsePropsMixin.

public CfnIntegrationResponseMixinProps()

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.Mixins.Preview.AWS.ApiGatewayV2.Mixins;

             var responseParameters;
             var responseTemplates;

             var cfnIntegrationResponseMixinProps = new CfnIntegrationResponseMixinProps {
                 ApiId = "apiId",
                 ContentHandlingStrategy = "contentHandlingStrategy",
                 IntegrationId = "integrationId",
                 IntegrationResponseKey = "integrationResponseKey",
                 ResponseParameters = responseParameters,
                 ResponseTemplates = responseTemplates,
                 TemplateSelectionExpression = "templateSelectionExpression"
             };

Properties

ApiId

The API identifier.

public string? ApiId { get; set; }

Property Value

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.

public string? ContentHandlingStrategy { get; set; }

Property Value

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.

public string? IntegrationId { get; set; }

Property Value

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.

public string? IntegrationResponseKey { get; set; }

Property Value

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.

public object? ResponseParameters { get; set; }

Property Value

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.

public object? ResponseTemplates { get; set; }

Property Value

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.

public string? TemplateSelectionExpression { get; set; }

Property Value

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

Implements

ICfnIntegrationResponseMixinProps