software.amazon.awscdk.services.apigatewayv2

Class IWebSocketApi.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.IWebSocketApi.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IApi, IApi.Jsii$Default, IWebSocketApi, IWebSocketApi.Jsii$Default

Enclosing interface:

IWebSocketApi

public static final class IWebSocketApi.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IWebSocketApi.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketApi

IWebSocketApi.Jsii$Default, IWebSocketApi.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
java.lang.String	getApiEndpoint() (experimental) The default endpoint for an API.
java.lang.String	getApiId() (experimental) The identifier of this API Gateway API.
ResourceEnvironment	getEnv() The environment this resource belongs to.
ConstructNode	getNode() The construct tree node for this construct.
Stack	getStack() The stack in which this resource is defined.
Metric	metric(java.lang.String metricName) (experimental) Return the given named metric for this Api Gateway.
Metric	metric(java.lang.String metricName, MetricOptions props) (experimental) Return the given named metric for this Api Gateway.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IApi.Jsii$Default

Specified by:

getNode in interface IWebSocketApi.Jsii$Default

getEnv

public final ResourceEnvironment 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 interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IApi.Jsii$Default

Specified by:

getEnv in interface IWebSocketApi.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IApi.Jsii$Default

Specified by:

getStack in interface IWebSocketApi.Jsii$Default

getApiEndpoint

public final java.lang.String getApiEndpoint()

(experimental) The default endpoint for an API.

Specified by:

getApiEndpoint in interface IApi

Specified by:

getApiEndpoint in interface IApi.Jsii$Default

Specified by:

getApiEndpoint in interface IWebSocketApi.Jsii$Default

getApiId

public final java.lang.String getApiId()

(experimental) The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

Specified by:

getApiId in interface IApi.Jsii$Default

Specified by:

getApiId in interface IWebSocketApi.Jsii$Default

applyRemovalPolicy

public final void applyRemovalPolicy(RemovalPolicy policy)

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 interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IApi.Jsii$Default

Specified by:

applyRemovalPolicy in interface IWebSocketApi.Jsii$Default

Parameters:

policy - This parameter is required.

metric

public final Metric metric(java.lang.String metricName,
                           MetricOptions props)

(experimental) Return the given named metric for this Api Gateway.

Default: - average over 5 minutes

Specified by:

metric in interface IApi

Specified by:

metric in interface IApi.Jsii$Default

Specified by:

metric in interface IWebSocketApi.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

public final Metric metric(java.lang.String metricName)

(experimental) Return the given named metric for this Api Gateway.

Default: - average over 5 minutes

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.