Class CfnGatewayResponseProps

Properties for defining a CfnGatewayResponse.

Inheritance

System.Object

CfnGatewayResponseProps

Implements

ICfnGatewayResponseProps

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGatewayResponseProps : Object, ICfnGatewayResponseProps

Syntax (vb)

Public Class CfnGatewayResponseProps
    Inherits Object
    Implements ICfnGatewayResponseProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.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 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"
};

Synopsis

Constructors

CfnGatewayResponseProps()

Properties

ResponseParameters	Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
ResponseTemplates	Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
ResponseType	The response type of the associated GatewayResponse.
RestApiId	The string identifier of the associated RestApi.
StatusCode	The HTTP status code for this GatewayResponse.

Constructors

CfnGatewayResponseProps()

public CfnGatewayResponseProps()

Properties

ResponseParameters

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

public object ResponseParameters { get; set; }

Property Value

System.Object

Remarks

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

ResponseTemplates

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

public object ResponseTemplates { get; set; }

Property Value

System.Object

Remarks

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

ResponseType

The response type of the associated GatewayResponse.

public string ResponseType { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype

RestApiId

The string identifier of the associated RestApi.

public string RestApiId { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid

StatusCode

The HTTP status code for this GatewayResponse.

public string StatusCode { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode

Implements

ICfnGatewayResponseProps