Class CfnGatewayResponse

The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnGatewayResponse

Implements

IInspectable

IGatewayResponseRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGatewayResponse : CfnResource, IInspectable, IGatewayResponseRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnGatewayResponse Inherits CfnResource Implements IInspectable, IGatewayResponseRef, IConstruct, IDependable, IEnvironmentAware

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

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

             var cfnGatewayResponse = new CfnGatewayResponse(this, "MyCfnGatewayResponse", 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

CfnGatewayResponse(Construct, string, ICfnGatewayResponseProps)

Create a new AWS::ApiGateway::GatewayResponse.

Properties

AttrId	The ID for the gateway response.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.
CfnPropertyNames	The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.
GatewayResponseRef	A reference to a GatewayResponse resource.
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnGatewayResponse(object)	Checks whether the given object is a CfnGatewayResponse.
RenderProperties(IDictionary<string, object>)	The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.

Constructors

CfnGatewayResponse(Construct, string, ICfnGatewayResponseProps)

Create a new AWS::ApiGateway::GatewayResponse.

public CfnGatewayResponse(Construct scope, string id, ICfnGatewayResponseProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnGatewayResponseProps

Resource properties.

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

Properties

AttrId

The ID for the gateway response.

public virtual string AttrId { get; }

Property Value

string

Remarks

For example: abc123 .

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

GatewayResponseRef

A reference to a GatewayResponse resource.

public virtual IGatewayResponseReference GatewayResponseRef { get; }

Property Value

IGatewayResponseReference

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

ResponseParameters

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

public virtual object? ResponseParameters { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or Dictionary<string, string>

ResponseTemplates

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

public virtual object? ResponseTemplates { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or Dictionary<string, string>

ResponseType

The response type of the associated GatewayResponse.

public virtual string ResponseType { get; set; }

Property Value

string

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

RestApiId

The string identifier of the associated RestApi.

public virtual string RestApiId { get; set; }

Property Value

string

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

StatusCode

The HTTP status code for this GatewayResponse.

public virtual string? StatusCode { get; set; }

Property Value

string

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

IsCfnGatewayResponse(object)

Checks whether the given object is a CfnGatewayResponse.

public static bool IsCfnGatewayResponse(object x)

Parameters

x object

Returns

bool

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGateway::GatewayResponse

ExampleMetadata: fixture=_generated

Implements

IInspectable

IGatewayResponseRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware