HttpIntegration

class aws_cdk.aws_apigatewayv2.HttpIntegration(scope, id, *, http_api, integration_type, integration_uri, connection_id=None, connection_type=None, method=None, payload_format_version=None)

Bases: aws_cdk.core.Resource

(experimental) The integration for an API route.

Stability

experimental

Resource

AWS::ApiGatewayV2::Integration

Parameters
  • scope (Construct) –

  • id (str) –

  • http_api (IHttpApi) – (experimental) The HTTP API to which this integration should be bound.

  • integration_type (HttpIntegrationType) – (experimental) Integration type.

  • integration_uri (str) – (experimental) Integration URI. This will be the function ARN in the case of HttpIntegrationType.LAMBDA_PROXY, or HTTP URL in the case of HttpIntegrationType.HTTP_PROXY.

  • connection_id (Optional[str]) – (experimental) The ID of the VPC link for a private integration. Supported only for HTTP APIs. Default: - undefined

  • connection_type (Optional[HttpConnectionType]) – (experimental) The type of the network connection to the integration endpoint. Default: HttpConnectionType.INTERNET

  • method (Optional[HttpMethod]) – (experimental) The HTTP method to use when calling the underlying HTTP proxy. Default: - none. required if the integration type is HttpIntegrationType.HTTP_PROXY.

  • payload_format_version (Optional[PayloadFormatVersion]) – (experimental) The version of the payload format. Default: - defaults to latest in the case of HttpIntegrationType.LAMBDA_PROXY`, irrelevant otherwise.

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

Return type

ResourceEnvironment

http_api

(experimental) The HTTP API associated with this integration.

Stability

experimental

Return type

IHttpApi

integration_id

(experimental) Id of the integration.

Stability

experimental

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

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