HttpIntegration

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

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

# http_api: apigatewayv2.HttpApi
# integration_credentials: apigatewayv2.IntegrationCredentials
# parameter_mapping: apigatewayv2.ParameterMapping
# payload_format_version: apigatewayv2.PayloadFormatVersion

http_integration = apigatewayv2.HttpIntegration(self, "MyHttpIntegration",
    http_api=http_api,
    integration_type=apigatewayv2.HttpIntegrationType.HTTP_PROXY,

    # the properties below are optional
    connection_id="connectionId",
    connection_type=apigatewayv2.HttpConnectionType.VPC_LINK,
    credentials=integration_credentials,
    integration_subtype=apigatewayv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
    integration_uri="integrationUri",
    method=apigatewayv2.HttpMethod.ANY,
    parameter_mapping=parameter_mapping,
    payload_format_version=payload_format_version,
    secure_server_name="secureServerName"
)
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.

  • 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

  • credentials (Optional[IntegrationCredentials]) – (experimental) The credentials with which to invoke the integration. Default: - no credentials, use resource-based permissions on supported AWS services

  • integration_subtype (Optional[HttpIntegrationSubtype]) – (experimental) Integration subtype. Used for AWS Service integrations, specifies the target of the integration. Default: - none, required if no integrationUri is defined.

  • integration_uri (Optional[str]) – (experimental) Integration URI. This will be the function ARN in the case of HttpIntegrationType.AWS_PROXY, or HTTP URL in the case of HttpIntegrationType.HTTP_PROXY. Default: - none, required if no integrationSubtype is defined.

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

  • parameter_mapping (Optional[ParameterMapping]) – (experimental) Specifies how to transform HTTP requests before sending them to the backend. Default: undefined requests are sent to the backend unmodified

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

  • secure_server_name (Optional[str]) – (experimental) Specifies the TLS configuration for a private integration. Default: undefined private integration traffic will use HTTP protocol

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.

http_api

(experimental) The HTTP API associated with this integration.

Stability:

experimental

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.

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