WebSocketIntegration

class aws_cdk.aws_apigatewayv2.WebSocketIntegration(scope, id, *, integration_type, integration_uri, web_socket_api)

Bases: Resource

(experimental) The integration for an API route.

Stability:: experimental
Resource:: AWS::ApiGatewayV2::Integration
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# web_socket_api: apigatewayv2.WebSocketApi

web_socket_integration = apigatewayv2.WebSocketIntegration(self, "MyWebSocketIntegration",
    integration_type=apigatewayv2.WebSocketIntegrationType.AWS_PROXY,
    integration_uri="integrationUri",
    web_socket_api=web_socket_api
)

Parameters:

scope (Construct) –
id (str) –
integration_type (WebSocketIntegrationType) – (experimental) Integration type.
integration_uri (str) – (experimental) Integration URI.
web_socket_api (IWebSocketApi) – (experimental) The WebSocket API to which this integration should be bound.

Stability:

experimental

Methods

apply_removal_policy(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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

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.

integration_id

(experimental) Id of the integration.

Stability:: experimental

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

web_socket_api

(experimental) The WebSocket API associated with this integration.

Stability:: experimental

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool