Table of Contents

Interface ICfnGatewayResponseProps

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

Properties for defining a CfnGatewayResponse.

public interface ICfnGatewayResponseProps

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 cfnGatewayResponseProps = new CfnGatewayResponseProps {
                 ResponseType = "responseType",
                 RestApiId = "restApiId",

                 // the properties below are optional
                 ResponseParameters = new Dictionary<string, string> {
                     { "responseParametersKey", "responseParameters" }
                 },
                 ResponseTemplates = new Dictionary<string, string> {
                     { "responseTemplatesKey", "responseTemplates" }
                 },
                 StatusCode = "statusCode"
             };

Remarks

Properties

ResponseParameters

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

object? ResponseParameters { get; }

Property Value

object

Remarks

ResponseTemplates

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

object? ResponseTemplates { get; }

Property Value

object

Remarks

ResponseType

The response type of the associated GatewayResponse.

string ResponseType { get; }

Property Value

string

Remarks

RestApiId

The string identifier of the associated RestApi.

string RestApiId { get; }

Property Value

string

Remarks

StatusCode

The HTTP status code for this GatewayResponse.

string? StatusCode { get; }

Property Value

string

Remarks