public static interface IWebSocketRoute.Jsii$Default extends IWebSocketRoute, IRoute.Jsii$Default
IWebSocketRoute
.IWebSocketRoute.Jsii$Default, IWebSocketRoute.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
default ConstructNode |
getNode()
The construct tree node for this construct.
|
default java.lang.String |
getRouteId()
(experimental) Id of the Route.
|
default java.lang.String |
getRouteKey()
(experimental) The key to this route.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
default IWebSocketApi |
getWebSocketApi()
(experimental) The WebSocket API associated with this route.
|
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface IRoute.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 IRoute.Jsii$Default
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface IRoute.Jsii$Default
default java.lang.String getRouteId()
getRouteId
in interface IRoute
getRouteId
in interface IRoute.Jsii$Default
default java.lang.String getRouteKey()
getRouteKey
in interface IWebSocketRoute
default IWebSocketApi getWebSocketApi()
getWebSocketApi
in interface IWebSocketRoute
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 IRoute.Jsii$Default
policy
- This parameter is required.