Class CfnMethod.IntegrationResponseProperty

IntegrationResponse is a property of the Amazon API Gateway Method Integration property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.

Inheritance

System.Object

CfnMethod.IntegrationResponseProperty

Implements

CfnMethod.IIntegrationResponseProperty

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class IntegrationResponseProperty : Object, CfnMethod.IIntegrationResponseProperty

Syntax (vb)

Public Class IntegrationResponseProperty
    Inherits Object
    Implements CfnMethod.IIntegrationResponseProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-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.APIGateway;

var integrationResponseProperty = new IntegrationResponseProperty {
    StatusCode = "statusCode",

    // the properties below are optional
    ContentHandling = "contentHandling",
    ResponseParameters = new Dictionary<string, string> {
        { "responseParametersKey", "responseParameters" }
    },
    ResponseTemplates = new Dictionary<string, string> {
        { "responseTemplatesKey", "responseTemplates" }
    },
    SelectionPattern = "selectionPattern"
};

Synopsis

Constructors

IntegrationResponseProperty()

Properties

ContentHandling	Specifies how to handle response payload content type conversions.
ResponseParameters	A key-value map specifying response parameters that are passed to the method response from the back end.
ResponseTemplates	Specifies the templates used to transform the integration response body.
SelectionPattern	Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.
StatusCode	Specifies the status code that is used to map the integration response to an existing MethodResponse.

Constructors

IntegrationResponseProperty()

public IntegrationResponseProperty()

Properties

ContentHandling

Specifies how to handle response payload content type conversions.

public string ContentHandling { get; set; }

Property Value

System.String

Remarks

Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling

ResponseParameters

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

public object ResponseParameters { get; set; }

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-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-responseparameters

ResponseTemplates

Specifies the templates used to transform the integration response body.

public object ResponseTemplates { get; set; }

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-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-responsetemplates

SelectionPattern

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.

public string SelectionPattern { get; set; }

Property Value

System.String

Remarks

For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ( \n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-selectionpattern

StatusCode

Specifies the status code that is used to map the integration response to an existing MethodResponse.

public string StatusCode { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-statuscode

Implements

CfnMethod.IIntegrationResponseProperty