public static interface IWebSocketApi.Jsii$Default extends IWebSocketApi, IApi.Jsii$Default
IWebSocketApi
.IWebSocketApi.Jsii$Default, IWebSocketApi.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default java.lang.String |
getApiEndpoint()
(experimental) The default endpoint for an API.
|
default java.lang.String |
getApiId()
(experimental) The identifier of this API Gateway API.
|
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 Metric |
metric(java.lang.String metricName,
MetricOptions props)
(experimental) Return the given named metric for this Api Gateway.
|
default ConstructNode getNode()
getNode
in interface IApi.Jsii$Default
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.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 IApi.Jsii$Default
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
default Stack getStack()
getStack
in interface IApi.Jsii$Default
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
default java.lang.String getApiEndpoint()
getApiEndpoint
in interface IApi
getApiEndpoint
in interface IApi.Jsii$Default
default java.lang.String getApiId()
getApiId
in interface IApi
getApiId
in interface IApi.Jsii$Default
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 IApi.Jsii$Default
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
policy
- This parameter is required.default Metric metric(java.lang.String metricName, MetricOptions props)
Default: - average over 5 minutes
metric
in interface IApi
metric
in interface IApi.Jsii$Default
metricName
- This parameter is required.props
-