Show / Hide Table of Contents

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

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

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.

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

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.

object? ResponseTemplates { get; }
Property Value

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.

string ResponseType { get; }
Property Value

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.

string RestApiId { get; }
Property Value

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.

string? StatusCode { get; }
Property Value

string

Remarks

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

Back to top Generated by DocFX