Class IWebSocketApi.Jsii$Proxy
- All Implemented Interfaces:
IEnvironmentAware,IEnvironmentAware.Jsii$Default,IResource,IResource.Jsii$Default,IApi,IApi.Jsii$Default,IWebSocketApi,IWebSocketApi.Jsii$Default,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IConstruct.Jsii$Default,software.constructs.IDependable,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IWebSocketApi
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IApi
IApi.Jsii$Default, IApi.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IEnvironmentAware
IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketApi
IWebSocketApi.Jsii$Default, IWebSocketApi.Jsii$Proxy -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidapplyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.final StringThe default endpoint for an API.final StringgetApiId()The identifier of this API Gateway API.final ResourceEnvironmentgetEnv()The environment this resource belongs to.final software.constructs.NodegetNode()The tree node.final StackgetStack()The stack in which this resource is defined.final MetricReturn the given named metric for this Api Gateway.final Metricmetric(String metricName, MetricOptions props) Return the given named metric for this Api Gateway.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:
getNodein interfaceIApi.Jsii$Default- Specified by:
getNodein interfacesoftware.constructs.IConstruct- Specified by:
getNodein interfacesoftware.constructs.IConstruct.Jsii$Default- Specified by:
getNodein interfaceIResource.Jsii$Default- Specified by:
getNodein interfaceIWebSocketApi.Jsii$Default
-
getEnv
The environment this resource belongs to.For resources that are created and managed in a Stack (those created by creating new class instances like
new Role(),new Bucket(), etc.), this is always the same as the environment of the stack they belong to.For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(),Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.- Specified by:
getEnvin interfaceIApi.Jsii$Default- Specified by:
getEnvin interfaceIEnvironmentAware- Specified by:
getEnvin interfaceIEnvironmentAware.Jsii$Default- Specified by:
getEnvin interfaceIResource.Jsii$Default- Specified by:
getEnvin interfaceIWebSocketApi.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStackin interfaceIApi.Jsii$Default- Specified by:
getStackin interfaceIResource- Specified by:
getStackin interfaceIResource.Jsii$Default- Specified by:
getStackin interfaceIWebSocketApi.Jsii$Default
-
getApiEndpoint
The default endpoint for an API.- Specified by:
getApiEndpointin interfaceIApi- Specified by:
getApiEndpointin interfaceIApi.Jsii$Default- Specified by:
getApiEndpointin interfaceIWebSocketApi.Jsii$Default
-
getApiId
The identifier of this API Gateway API.- Specified by:
getApiIdin interfaceIApi- Specified by:
getApiIdin interfaceIApi.Jsii$Default- Specified by:
getApiIdin interfaceIWebSocketApi.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:
applyRemovalPolicyin interfaceIApi.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIResource- Specified by:
applyRemovalPolicyin interfaceIResource.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIWebSocketApi.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 Api Gateway.Default: - average over 5 minutes
- Specified by:
metricin interfaceIApi- Specified by:
metricin interfaceIApi.Jsii$Default- Specified by:
metricin interfaceIWebSocketApi.Jsii$Default- Parameters:
metricName- This parameter is required.props-
-
metric
Return the given named metric for this Api Gateway.Default: - average over 5 minutes
-