Class WebSocketStageAttributes

The attributes used to import existing WebSocketStage.

Inheritance

object

WebSocketStageAttributes

Implements

IWebSocketStageAttributes

IStageAttributes

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class WebSocketStageAttributes : IWebSocketStageAttributes, IStageAttributes

Syntax (vb)

Public Class WebSocketStageAttributes Implements IWebSocketStageAttributes, IStageAttributes

Remarks

ExampleMetadata: infused

Examples

IWebSocketApi webSocketApi;


            var importedStage = WebSocketStage.FromWebSocketStageAttributes(this, "imported-stage", new WebSocketStageAttributes {
                StageName = "myStage",
                Api = webSocketApi
            });

            var apiKey = new ApiKey(this, "MyApiKey");

            var usagePlan = new UsagePlan(this, "MyUsagePlan", new UsagePlanProps {
                ApiStages = new [] { new UsagePlanPerApiStage { Api = webSocketApi, Stage = importedStage } }
            });

            usagePlan.AddApiKey(apiKey);

Synopsis

Constructors

WebSocketStageAttributes()

The attributes used to import existing WebSocketStage.

Properties

Api	The API to which this stage is associated.
StageName	The name of the stage.

Constructors

WebSocketStageAttributes()

The attributes used to import existing WebSocketStage.

public WebSocketStageAttributes()

Remarks

ExampleMetadata: infused

Examples

IWebSocketApi webSocketApi;


            var importedStage = WebSocketStage.FromWebSocketStageAttributes(this, "imported-stage", new WebSocketStageAttributes {
                StageName = "myStage",
                Api = webSocketApi
            });

            var apiKey = new ApiKey(this, "MyApiKey");

            var usagePlan = new UsagePlan(this, "MyUsagePlan", new UsagePlanProps {
                ApiStages = new [] { new UsagePlanPerApiStage { Api = webSocketApi, Stage = importedStage } }
            });

            usagePlan.AddApiKey(apiKey);

Properties

Api

The API to which this stage is associated.

public IWebSocketApi Api { get; set; }

Property Value

IWebSocketApi

Remarks

ExampleMetadata: infused

StageName

The name of the stage.

public string StageName { get; set; }

Property Value

string

Remarks

ExampleMetadata: infused

Implements

IWebSocketStageAttributes

IStageAttributes