Package software.amazon.awscdk.services.apigatewayv2

Interface IWebSocketStage.Jsii$Default

All Superinterfaces:
IConstruct, software.constructs.IConstruct, IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IStage, IStage.Jsii$Default, IWebSocketStage, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IWebSocketStage.Jsii$Proxy
Enclosing interface:
IWebSocketStage
@Internal public static interface IWebSocketStage.Jsii$Default extends IWebSocketStage, IStage.Jsii$Default
Internal default implementation for IWebSocketStage.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default ConstructNode getNode()
      The construct tree node for this construct.
      Specified by:
      getNode in interface IConstruct
      Specified by:
      getNode in interface IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default
      Specified by:
      getNode in interface IStage.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      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.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default
      Specified by:
      getEnv in interface IStage.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default
      Specified by:
      getStack in interface IStage.Jsii$Default

    • getStageName

      @Stability(Experimental) @NotNull default String getStageName()
      (experimental) The name of the stage;

      its primary identifier.

      Specified by:
      getStageName in interface IStage
      Specified by:
      getStageName in interface IStage.Jsii$Default

    • getUrl

      @Stability(Experimental) @NotNull default String getUrl()
      (experimental) The URL to this stage.
      Specified by:
      getUrl in interface IStage
      Specified by:
      getUrl in interface IStage.Jsii$Default

    • getApi

      @Stability(Experimental) @NotNull default IWebSocketApi getApi()
      (experimental) The API this stage is associated to.
      Specified by:
      getApi in interface IWebSocketStage

    • getCallbackUrl

      @Stability(Experimental) @NotNull default String getCallbackUrl()
      (experimental) The callback URL to this stage.

      You can use the callback URL to send messages to the client from the backend system. https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html

      Specified by:
      getCallbackUrl in interface IWebSocketStage

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy 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.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IStage.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • metric

      @Stability(Experimental) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Return the given named metric for this HTTP Api Gateway Stage.

      Default: - average over 5 minutes

      Specified by:
      metric in interface IStage
      Specified by:
      metric in interface IStage.Jsii$Default
      Parameters:
      metricName - This parameter is required.
      props -