WebSocketStage

class aws_cdk.aws_apigatewayv2.WebSocketStage(scope, id, *, stage_name, web_socket_api, auto_deploy=None, domain_mapping=None)

Bases: aws_cdk.core.Resource

(experimental) Represents a stage where an instance of the API is deployed.

Stability

experimental

Resource

AWS::ApiGatewayV2::Stage

Parameters
  • scope (Construct) –

  • id (str) –

  • stage_name (str) – (experimental) The name of the stage.

  • web_socket_api (IWebSocketApi) – (experimental) The WebSocket API to which this stage is associated.

  • auto_deploy (Optional[bool]) – (experimental) Whether updates to an API automatically trigger a new deployment. Default: false

  • domain_mapping (Optional[DomainMappingOptions]) – (experimental) The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration

Stability

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

metric(metric_name, *, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)

(experimental) Return the given named metric for this HTTP Api Gateway Stage.

Parameters
  • metric_name (str) –

  • account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.

  • color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color

  • dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.

  • label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label

  • period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)

  • region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.

  • statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average

  • unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Stability

experimental

Return type

Metric

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

api

(experimental) The API this stage is associated to.

Stability

experimental

Return type

IWebSocketApi

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

stage_name

(experimental) The name of the stage;

its primary identifier.

Stability

experimental

Return type

str

url

(experimental) The URL to this stage.

Stability

experimental

Return type

str

Static Methods

classmethod from_web_socket_stage_attributes(scope, id, *, api, stage_name)

(experimental) Import an existing stage into this CDK app.

Parameters
  • scope (Construct) –

  • id (str) –

  • api (IWebSocketApi) – (experimental) The API to which this stage is associated.

  • stage_name (str) – (experimental) The name of the stage.

Stability

experimental

Return type

IWebSocketStage

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool