software.amazon.awscdk.services.apigatewayv2

Class IWebSocketStage.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.IWebSocketStage.Jsii$Proxy

All Implemented Interfaces:

IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IStage, IStage.Jsii$Default, IWebSocketStage, IWebSocketStage.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default

Enclosing interface:

IWebSocketStage

@Internal
public static final class IWebSocketStage.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IWebSocketStage.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketStage

IWebSocketStage.Jsii$Default, IWebSocketStage.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	applyRemovalPolicy(RemovalPolicy policy) (experimental) Apply the given removal policy to this resource.
IWebSocketApi	getApi() (experimental) The API this stage is associated to.
String	getCallbackUrl() (experimental) The callback URL to this stage.
ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
ConstructNode	getNode() (experimental) The construct tree node for this construct.
Stack	getStack() (experimental) The stack in which this resource is defined.
String	getStageName() (experimental) The name of the stage;
String	getUrl() (experimental) The URL to this stage.
Metric	metric(String metricName) (experimental) Return the given named metric for this HTTP Api Gateway Stage.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

@Stability(value=Experimental)
 @NotNull
public final ConstructNode getNode()

(experimental) The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IStage.Jsii$Default

Specified by:

getNode in interface IWebSocketStage.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
public final ResourceEnvironment getEnv()

(experimental) 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

Specified by:

getEnv in interface IWebSocketStage.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
public final Stack getStack()

(experimental) 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

Specified by:

getStack in interface IWebSocketStage.Jsii$Default

getStageName

@Stability(value=Experimental)
 @NotNull
public final 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

Specified by:

getStageName in interface IWebSocketStage.Jsii$Default

getUrl

@Stability(value=Experimental)
 @NotNull
public final String getUrl()

(experimental) The URL to this stage.

Specified by:

getUrl in interface IStage

Specified by:

getUrl in interface IStage.Jsii$Default

Specified by:

getUrl in interface IWebSocketStage.Jsii$Default

getApi

@Stability(value=Experimental)
 @NotNull
public final IWebSocketApi getApi()

(experimental) The API this stage is associated to.

Specified by:

getApi in interface IWebSocketStage

Specified by:

getApi in interface IWebSocketStage.Jsii$Default

getCallbackUrl

@Stability(value=Experimental)
 @NotNull
public final 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

Specified by:

getCallbackUrl in interface IWebSocketStage.Jsii$Default

applyRemovalPolicy

@Stability(value=Experimental)
public final void applyRemovalPolicy(@NotNull
                                                                    RemovalPolicy policy)

(experimental) 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

Specified by:

applyRemovalPolicy in interface IWebSocketStage.Jsii$Default

Parameters:

policy - This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
public final 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

Specified by:

metric in interface IWebSocketStage.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Experimental)
 @NotNull
public final Metric metric(@NotNull
                                                                    String metricName)

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

Default: - average over 5 minutes

Specified by:

metric in interface IStage

Parameters:

metricName - This parameter is required.