Table of Contents

Class CfnStageV2

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

(deprecated) A CloudFormation AWS::ApiGatewayV2::Stage.

[Obsolete("moved to package aws-apigatewayv2")]
public class CfnStageV2 : CfnResource, IInspectable
Inheritance
CfnStageV2
Implements
IInspectable

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 routeSettings;
             var stageVariables;
             var tags;

             var cfnStageV2 = new CfnStageV2(this, "MyCfnStageV2", new CfnStageV2Props {
                 ApiId = "apiId",
                 StageName = "stageName",

                 // the properties below are optional
                 AccessLogSettings = new AccessLogSettingsProperty {
                     DestinationArn = "destinationArn",
                     Format = "format"
                 },
                 AutoDeploy = false,
                 ClientCertificateId = "clientCertificateId",
                 DefaultRouteSettings = new RouteSettingsProperty {
                     DataTraceEnabled = false,
                     DetailedMetricsEnabled = false,
                     LoggingLevel = "loggingLevel",
                     ThrottlingBurstLimit = 123,
                     ThrottlingRateLimit = 123
                 },
                 DeploymentId = "deploymentId",
                 Description = "description",
                 RouteSettings = routeSettings,
                 StageVariables = stageVariables,
                 Tags = tags
             });

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html

CloudformationResource: AWS::ApiGatewayV2::Stage

ExampleMetadata: fixture=_generated

Constructors

CfnStageV2(Construct, string, ICfnStageV2Props)

(deprecated) Create a new AWS::ApiGatewayV2::Stage.

[Obsolete]
public CfnStageV2(Construct scope, string id, ICfnStageV2Props props)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnStageV2Props
  • resource properties.

Remarks

Stability: Deprecated

Properties

AccessLogSettings

(deprecated) AWS::ApiGatewayV2::Stage.AccessLogSettings.

[Obsolete]
public virtual object? AccessLogSettings { get; set; }

Property Value

object

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings

ApiId

(deprecated) AWS::ApiGatewayV2::Stage.ApiId.

[Obsolete]
public virtual string ApiId { get; set; }

Property Value

string

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid

AutoDeploy

(deprecated) AWS::ApiGatewayV2::Stage.AutoDeploy.

[Obsolete]
public virtual object? AutoDeploy { get; set; }

Property Value

object

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy

CFN_RESOURCE_TYPE_NAME

(deprecated) The CloudFormation resource type name for this resource class.

[Obsolete]
public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Stability: Deprecated

CfnProperties 

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

Property Value

IDictionary<string, object>

Remarks

Stability: Deprecated

ClientCertificateId

(deprecated) AWS::ApiGatewayV2::Stage.ClientCertificateId.

[Obsolete]
public virtual string? ClientCertificateId { get; set; }

Property Value

string

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid

DefaultRouteSettings

(deprecated) AWS::ApiGatewayV2::Stage.DefaultRouteSettings.

[Obsolete]
public virtual object? DefaultRouteSettings { get; set; }

Property Value

object

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings

DeploymentId

(deprecated) AWS::ApiGatewayV2::Stage.DeploymentId.

[Obsolete]
public virtual string? DeploymentId { get; set; }

Property Value

string

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid

Description

(deprecated) AWS::ApiGatewayV2::Stage.Description.

[Obsolete]
public virtual string? Description { get; set; }

Property Value

string

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description

RouteSettings

(deprecated) AWS::ApiGatewayV2::Stage.RouteSettings.

[Obsolete]
public virtual object RouteSettings { get; set; }

Property Value

object

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings

StageName

(deprecated) AWS::ApiGatewayV2::Stage.StageName.

[Obsolete]
public virtual string StageName { get; set; }

Property Value

string

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename

StageVariables

(deprecated) AWS::ApiGatewayV2::Stage.StageVariables.

[Obsolete]
public virtual object StageVariables { get; set; }

Property Value

object

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables

Tags

(deprecated) AWS::ApiGatewayV2::Stage.Tags.

[Obsolete]
public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags

Methods

Inspect(TreeInspector)

(deprecated) Examines the CloudFormation resource and discloses attributes.

[Obsolete]
public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector
  • tree inspector to collect and process attributes.

Remarks

Stability: Deprecated

RenderProperties(IDictionary<string, object>) 

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Remarks

Stability: Deprecated