Class IWebSocketStage.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,IStage
,IStage.Jsii$Default
,IWebSocketStage
,IWebSocketStage.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IWebSocketStage
-
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IStage
IStage.Jsii$Default, IStage.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketStage
IWebSocketStage.Jsii$Default, IWebSocketStage.Jsii$Proxy
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final IWebSocketApi
getApi()
The API this stage is associated to.final String
The callback URL to this stage.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final software.constructs.Node
getNode()
The tree node.final Stack
getStack()
The stack in which this resource is defined.final String
The name of the stage;final String
getUrl()
The URL to this stage.final Metric
Return the given named metric for this HTTP Api Gateway Stage.final Metric
metric
(String metricName, MetricOptions props) 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 Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
- Specified by:
getNode
in interfaceIStage.Jsii$Default
- Specified by:
getNode
in interfaceIWebSocketStage.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
- Specified by:
getEnv
in interfaceIStage.Jsii$Default
- Specified by:
getEnv
in interfaceIWebSocketStage.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
- Specified by:
getStack
in interfaceIStage.Jsii$Default
- Specified by:
getStack
in interfaceIWebSocketStage.Jsii$Default
-
getStageName
The name of the stage;its primary identifier.
- Specified by:
getStageName
in interfaceIStage
- Specified by:
getStageName
in interfaceIStage.Jsii$Default
- Specified by:
getStageName
in interfaceIWebSocketStage.Jsii$Default
-
getUrl
The URL to this stage.- Specified by:
getUrl
in interfaceIStage
- Specified by:
getUrl
in interfaceIStage.Jsii$Default
- Specified by:
getUrl
in interfaceIWebSocketStage.Jsii$Default
-
getApi
The API this stage is associated to.- Specified by:
getApi
in interfaceIWebSocketStage
- Specified by:
getApi
in interfaceIWebSocketStage.Jsii$Default
-
getCallbackUrl
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 interfaceIWebSocketStage
- Specified by:
getCallbackUrl
in interfaceIWebSocketStage.Jsii$Default
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIStage.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIWebSocketStage.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
metric
@Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this HTTP Api Gateway Stage.Default: - average over 5 minutes
- Specified by:
metric
in interfaceIStage
- Specified by:
metric
in interfaceIStage.Jsii$Default
- Specified by:
metric
in interfaceIWebSocketStage.Jsii$Default
- Parameters:
metricName
- This parameter is required.props
-
-
metric
Return the given named metric for this HTTP Api Gateway Stage.Default: - average over 5 minutes
-