Package software.amazon.awscdk.services.apigatewayv2

Interface IWebSocketIntegration.Jsii$Default

All Superinterfaces:

IConstruct, software.constructs.IConstruct, IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IIntegration, IIntegration.Jsii$Default, IResource, IResource.Jsii$Default, IWebSocketIntegration, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IWebSocketIntegration.Jsii$Proxy

Enclosing interface:

IWebSocketIntegration

@Internal
public static interface IWebSocketIntegration.Jsii$Default
extends IWebSocketIntegration, IIntegration.Jsii$Default

Internal default implementation for IWebSocketIntegration.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.Jsii$Proxy

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

IIntegration.Jsii$Default, IIntegration.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

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

IWebSocketIntegration.Jsii$Default, IWebSocketIntegration.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default String	getIntegrationId()	(experimental) Id of the integration.
default ConstructNode	getNode()	The construct tree node for this construct.
default Stack	getStack()	The stack in which this resource is defined.
default IWebSocketApi	getWebSocketApi()	(experimental) The WebSocket API associated with this integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default 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 IIntegration.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default 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 IIntegration.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IIntegration.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getIntegrationId

@Stability(Experimental)
@NotNull
default String getIntegrationId()

(experimental) Id of the integration.

Specified by:

getIntegrationId in interface IIntegration

Specified by:

getIntegrationId in interface IIntegration.Jsii$Default

getWebSocketApi

@Stability(Experimental)
@NotNull
default IWebSocketApi getWebSocketApi()

(experimental) The WebSocket API associated with this integration.

Specified by:

getWebSocketApi in interface IWebSocketIntegration

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 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 IIntegration.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.