Show / Hide Table of Contents

Class GatewayResponse

Configure the response received by clients, produced from the API Gateway backend.

Inheritance
System.Object
Resource
GatewayResponse
Implements
IGatewayResponse
IResource
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(String, IArnComponents)
Resource.GetResourceNameAttribute(String)
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class GatewayResponse : Resource, IGatewayResponse, IResource
Syntax (vb)
Public Class GatewayResponse
    Inherits Resource
    Implements IGatewayResponse, IResource
Remarks

Resource: AWS::ApiGateway::GatewayResponse

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;

ResponseType responseType;
RestApi restApi;

var gatewayResponse = new GatewayResponse(this, "MyGatewayResponse", new GatewayResponseProps {
    RestApi = restApi,
    Type = responseType,

    // the properties below are optional
    ResponseHeaders = new Dictionary<string, string> {
        { "responseHeadersKey", "responseHeaders" }
    },
    StatusCode = "statusCode",
    Templates = new Dictionary<string, string> {
        { "templatesKey", "templates" }
    }
});

Synopsis

Constructors

GatewayResponse(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

GatewayResponse(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

GatewayResponse(Construct, String, IGatewayResponseProps)

Constructors

GatewayResponse(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected GatewayResponse(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

GatewayResponse(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected GatewayResponse(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

GatewayResponse(Construct, String, IGatewayResponseProps)

public GatewayResponse(Construct scope, string id, IGatewayResponseProps props)
Parameters
scope Constructs.Construct
id System.String
props IGatewayResponseProps

Implements

IGatewayResponse
IResource
Constructs.IConstruct
Constructs.IDependable
Back to top Generated by DocFX