public static interface IWebSocketStage.Jsii$Default extends IWebSocketStage, IStage.Jsii$Default
IWebSocketStage
.IWebSocketStage.Jsii$Default, IWebSocketStage.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default IWebSocketApi |
getApi()
(experimental) The API this stage is associated to.
|
default java.lang.String |
getCallbackUrl()
(experimental) The callback URL to this stage.
|
default ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
default ConstructNode |
getNode()
The construct tree node for this construct.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
default java.lang.String |
getStageName()
(experimental) The name of the stage;
|
default java.lang.String |
getUrl()
(experimental) The URL to this stage.
|
default Metric |
metric(java.lang.String metricName,
MetricOptions props)
(experimental) Return the given named metric for this HTTP Api Gateway Stage.
|
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface IStage.Jsii$Default
default ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
getEnv
in interface IStage.Jsii$Default
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface IStage.Jsii$Default
default java.lang.String getStageName()
its primary identifier.
getStageName
in interface IStage
getStageName
in interface IStage.Jsii$Default
default java.lang.String getUrl()
getUrl
in interface IStage
getUrl
in interface IStage.Jsii$Default
default IWebSocketApi getApi()
getApi
in interface IWebSocketStage
default java.lang.String getCallbackUrl()
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
getCallbackUrl
in interface IWebSocketStage
default void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
applyRemovalPolicy
in interface IStage.Jsii$Default
policy
- This parameter is required.default Metric metric(java.lang.String metricName, MetricOptions props)
Default: - average over 5 minutes
metric
in interface IStage
metric
in interface IStage.Jsii$Default
metricName
- This parameter is required.props
-