@aws-cdk_aws-apigatewayv2-alpha.IIntegration

interface IIntegration ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.IIntegration
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#IIntegration
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.IIntegration
Pythonaws_cdk.aws_apigatewayv2_alpha.IIntegration
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป IIntegration

Implemented by HttpIntegration, WebSocketIntegration

Represents an integration to an API Route.

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
integrationId๐Ÿ”นstringId of the integration.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

env๐Ÿ”น

Type: ResourceEnvironment

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.


integrationId๐Ÿ”น

Type: string

Id of the integration.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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