Interface CfnMethod.IMethodResponseProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Represents a method response of a given HTTP status code returned to the client.

public interface CfnMethod.IMethodResponseProperty

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 methodResponseProperty = new MethodResponseProperty {
                 StatusCode = "statusCode",

                 // the properties below are optional
                 ResponseModels = new Dictionary<string, string> {
                     { "responseModelsKey", "responseModels" }
                 },
                 ResponseParameters = new Dictionary<string, object> {
                     { "responseParametersKey", false }
                 }
             };

Remarks

The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html

ExampleMetadata: fixture=_generated

Properties

ResponseModels

Specifies the Model resources used for the response's content-type.

object? ResponseModels { get; }

Property Value

object

Remarks

Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels

ResponseParameters

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.

object? ResponseParameters { get; }

Property Value

object

Remarks

A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters

StatusCode

The method response's status code.

string StatusCode { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode