Interface ICfnGatewayResponseProps

Properties for defining a CfnGatewayResponse.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnGatewayResponseProps

Syntax (vb)

Public Interface ICfnGatewayResponseProps

Remarks

Link: 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;

CfnGatewayResponseProps 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

Properties

ResponseParameters	The response parameters (paths, query strings, and headers) for the response.
ResponseTemplates	The response templates for the response.
ResponseType	The response type.
RestApiId	The identifier of the API.
StatusCode	The HTTP status code for the response.

Properties

ResponseParameters

The response parameters (paths, query strings, and headers) for the response.

virtual object ResponseParameters { get; }

Property Value

System.Object

Remarks

Duplicates not allowed.

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

ResponseTemplates

The response templates for the response.

virtual object ResponseTemplates { get; }

Property Value

System.Object

Remarks

Duplicates not allowed.

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

ResponseType

The response type.

string ResponseType { get; }

Property Value

System.String

Remarks

For valid values, see GatewayResponse in the API Gateway API Reference .

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

RestApiId

The identifier of the API.

string RestApiId { get; }

Property Value

System.String

Remarks

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

StatusCode

The HTTP status code for the response.

virtual string StatusCode { get; }

Property Value

System.String

Remarks

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