Class CfnStage

A CloudFormation AWS::ApiGatewayV2::Stage.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnStage
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnStage : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnStage
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

The AWS::ApiGatewayV2::Stage resource specifies a stage for an API. Each stage is a named reference to a deployment of the API and is made available for client applications to call. To learn more, see Working with stages for HTTP APIs and Deploy a WebSocket API in API Gateway .

CloudformationResource: AWS::ApiGatewayV2::Stage

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.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.APIGatewayv2;

var routeSettings;
var stageVariables;
var tags;

CfnStage cfnStage = new CfnStage(this, "MyCfnStage", new CfnStageProps {
    ApiId = "apiId",
    StageName = "stageName",

    // the properties below are optional
    AccessLogSettings = new AccessLogSettingsProperty {
        DestinationArn = "destinationArn",
        Format = "format"
    },
    AccessPolicyId = "accessPolicyId",
    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
});

Synopsis

Constructors

CfnStage(Construct, String, ICfnStageProps)

Create a new AWS::ApiGatewayV2::Stage.
CfnStage(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnStage(DeputyBase.DeputyProps)

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

Properties

AccessLogSettings

Settings for logging access in this stage.
AccessPolicyId

This parameter is not currently supported.
ApiId

The API identifier.
AutoDeploy

Specifies whether updates to an API automatically trigger a new deployment.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
ClientCertificateId

The identifier of a client certificate for a Stage .
DefaultRouteSettings

The default route settings for the stage.
DeploymentId

The deployment identifier for the API stage.
Description

The description for the API stage.
RouteSettings

Route settings for the stage.
StageName

The stage name.
StageVariables

A map that defines the stage variables for a Stage .
Tags

The collection of tags.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnStage(Construct, String, ICfnStageProps)

Create a new AWS::ApiGatewayV2::Stage.

public CfnStage(Construct scope, string id, ICfnStageProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnStageProps
  • resource properties.

CfnStage(ByRefValue)

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

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

The Javascript-owned object reference

CfnStage(DeputyBase.DeputyProps)

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

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

The deputy props

Properties

AccessLogSettings

Settings for logging access in this stage.

public virtual object AccessLogSettings { get; set; }
Property Value

System.Object

Remarks

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

AccessPolicyId

This parameter is not currently supported.

public virtual string AccessPolicyId { get; set; }
Property Value

System.String

Remarks

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

ApiId

The API identifier.

public virtual string ApiId { get; set; }
Property Value

System.String

Remarks

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

AutoDeploy

Specifies whether updates to an API automatically trigger a new deployment.

public virtual object AutoDeploy { get; set; }
Property Value

System.Object

Remarks

The default value is false .

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ClientCertificateId

The identifier of a client certificate for a Stage .

public virtual string ClientCertificateId { get; set; }
Property Value

System.String

Remarks

Supported only for WebSocket APIs.

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

DefaultRouteSettings

The default route settings for the stage.

public virtual object DefaultRouteSettings { get; set; }
Property Value

System.Object

Remarks

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

DeploymentId

The deployment identifier for the API stage.

public virtual string DeploymentId { get; set; }
Property Value

System.String

Remarks

Can't be updated if autoDeploy is enabled.

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

Description

The description for the API stage.

public virtual string Description { get; set; }
Property Value

System.String

Remarks

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

RouteSettings

Route settings for the stage.

public virtual object RouteSettings { get; set; }
Property Value

System.Object

Remarks

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

StageName

The stage name.

public virtual string StageName { get; set; }
Property Value

System.String

Remarks

Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.

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

StageVariables

A map that defines the stage variables for a Stage .

public virtual object StageVariables { get; set; }
Property Value

System.Object

Remarks

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

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

Tags

The collection of tags.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Each tag element is associated with a given resource.

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

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct