HttpIntegration L2 construct
The integration for an API route.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
declare const httpApiRef: apigatewayv2.IHttpApiRef;
declare const integrationCredentials: apigatewayv2.IntegrationCredentials;
declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2.PayloadFormatVersion;
const httpIntegration = new apigatewayv2.HttpIntegration(this, 'MyHttpIntegration', {
httpApi: httpApiRef,
integrationType: apigatewayv2.HttpIntegrationType.HTTP_PROXY,
// the properties below are optional
connectionId: 'connectionId',
connectionType: apigatewayv2.HttpConnectionType.VPC_LINK,
credentials: integrationCredentials,
integrationSubtype: apigatewayv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
integrationUri: 'integrationUri',
method: apigatewayv2.HttpMethod.ANY,
parameterMapping: parameterMapping,
payloadFormatVersion: payloadFormatVersion,
secureServerName: 'secureServerName',
timeout: cdk.Duration.minutes(30),
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_apigatewayv2 as apigatewayv2
# http_api_ref: apigatewayv2.IHttpApiRef
# integration_credentials: apigatewayv2.IntegrationCredentials
# parameter_mapping: apigatewayv2.ParameterMapping
# payload_format_version: apigatewayv2.PayloadFormatVersion
http_integration = apigatewayv2.HttpIntegration(self, "MyHttpIntegration",
http_api=http_api_ref,
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",
timeout=cdk.Duration.minutes(30)
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.apigatewayv2.*;
IHttpApiRef httpApiRef;
IntegrationCredentials integrationCredentials;
ParameterMapping parameterMapping;
PayloadFormatVersion payloadFormatVersion;
HttpIntegration httpIntegration = HttpIntegration.Builder.create(this, "MyHttpIntegration")
.httpApi(httpApiRef)
.integrationType(HttpIntegrationType.HTTP_PROXY)
// the properties below are optional
.connectionId("connectionId")
.connectionType(HttpConnectionType.VPC_LINK)
.credentials(integrationCredentials)
.integrationSubtype(HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS)
.integrationUri("integrationUri")
.method(HttpMethod.ANY)
.parameterMapping(parameterMapping)
.payloadFormatVersion(payloadFormatVersion)
.secureServerName("secureServerName")
.timeout(Duration.minutes(30))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Apigatewayv2;
IHttpApiRef httpApiRef;
IntegrationCredentials integrationCredentials;
ParameterMapping parameterMapping;
PayloadFormatVersion payloadFormatVersion;
var httpIntegration = new HttpIntegration(this, "MyHttpIntegration", new HttpIntegrationProps {
HttpApi = httpApiRef,
IntegrationType = HttpIntegrationType.HTTP_PROXY,
// the properties below are optional
ConnectionId = "connectionId",
ConnectionType = HttpConnectionType.VPC_LINK,
Credentials = integrationCredentials,
IntegrationSubtype = HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
IntegrationUri = "integrationUri",
Method = HttpMethod.ANY,
ParameterMapping = parameterMapping,
PayloadFormatVersion = payloadFormatVersion,
SecureServerName = "secureServerName",
Timeout = Duration.Minutes(30)
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var httpApiRef IHttpApiRef
var integrationCredentials IntegrationCredentials
var parameterMapping ParameterMapping
var payloadFormatVersion PayloadFormatVersion
httpIntegration := awscdk.Aws_apigatewayv2.NewHttpIntegration(this, jsii.String("MyHttpIntegration"), &HttpIntegrationProps{
HttpApi: httpApiRef,
IntegrationType: awscdk.*Aws_apigatewayv2.HttpIntegrationType_HTTP_PROXY,
// the properties below are optional
ConnectionId: jsii.String("connectionId"),
ConnectionType: awscdk.*Aws_apigatewayv2.HttpConnectionType_VPC_LINK,
Credentials: integrationCredentials,
IntegrationSubtype: awscdk.*Aws_apigatewayv2.HttpIntegrationSubtype_EVENTBRIDGE_PUT_EVENTS,
IntegrationUri: jsii.String("integrationUri"),
Method: awscdk.*Aws_apigatewayv2.HttpMethod_ANY,
ParameterMapping: parameterMapping,
PayloadFormatVersion: payloadFormatVersion,
SecureServerName: jsii.String("secureServerName"),
Timeout: cdk.Duration_Minutes(jsii.Number(30)),
})
Initializer
new HttpIntegration(scope: Construct, id: string, props: HttpIntegrationProps)
HttpIntegration(scope: Construct, id: str, props: HttpIntegrationProps)
new HttpIntegration(Construct scope, String id, HttpIntegrationProps props)
new HttpIntegration(Construct scope, string id, HttpIntegrationProps props)
NewHttpIntegration(Scope Construct, Id *string, Props HttpIntegrationProps)
Construct Props
connectionIdoptionalstringconnection_idoptionalstrconnectionIdoptionalStringConnectionIdoptionalstringConnectionIdoptional*string= undefined#Supported only for HTTP APIs.
connectionTypeoptionalHttpConnectionTypeconnection_typeoptionalHttpConnectionTypeconnectionTypeoptionalHttpConnectionTypeConnectionTypeoptionalHttpConnectionTypeConnectionTypeoptionalHttpConnectionType= HttpConnectionType.INTERNET#credentialsoptionalIntegrationCredentialscredentialsoptionalIntegrationCredentialscredentialsoptionalIntegrationCredentialsCredentialsoptionalIntegrationCredentialsCredentialsoptionalIntegrationCredentials#Default: no credentials, use resource-based permissions on supported AWS services
httpApiIHttpApiRefhttp_apiIHttpApiRefhttpApiIHttpApiRefHttpApiIHttpApiRefHttpApiIHttpApiRefrequired#integrationSubtypeoptionalHttpIntegrationSubtypeintegration_subtypeoptionalHttpIntegrationSubtypeintegrationSubtypeoptionalHttpIntegrationSubtypeIntegrationSubtypeoptionalHttpIntegrationSubtypeIntegrationSubtypeoptionalHttpIntegrationSubtype#Default: none, required if no integrationUri is defined.
Used for AWS Service integrations, specifies the target of the integration.
integrationTypeHttpIntegrationTypeintegration_typeHttpIntegrationTypeintegrationTypeHttpIntegrationTypeIntegrationTypeHttpIntegrationTypeIntegrationTypeHttpIntegrationTyperequired#integrationUrioptionalstringintegration_urioptionalstrintegrationUrioptionalStringIntegrationUrioptionalstringIntegrationUrioptional*string#Default: none, required if no integrationSubtype is defined.
This will be the function ARN in the case of HttpIntegrationType.AWS_PROXY, or HTTP URL in the case of HttpIntegrationType.HTTP_PROXY.
methodoptionalHttpMethodmethodoptionalHttpMethodmethodoptionalHttpMethodMethodoptionalHttpMethodMethodoptionalHttpMethod#Default: none. required if the integration type is HttpIntegrationType.HTTP_PROXY.
parameterMappingoptionalParameterMappingparameter_mappingoptionalParameterMappingparameterMappingoptionalParameterMappingParameterMappingoptionalParameterMappingParameterMappingoptionalParameterMapping#Default: undefined requests are sent to the backend unmodified
payloadFormatVersionoptionalPayloadFormatVersionpayload_format_versionoptionalPayloadFormatVersionpayloadFormatVersionoptionalPayloadFormatVersionPayloadFormatVersionoptionalPayloadFormatVersionPayloadFormatVersionoptionalPayloadFormatVersion#Default: defaults to latest in the case of HttpIntegrationType.AWS_PROXY`, irrelevant otherwise.
secureServerNameoptionalstringsecure_server_nameoptionalstrsecureServerNameoptionalStringSecureServerNameoptionalstringSecureServerNameoptional*string#Default: undefined private integration traffic will use HTTP protocol
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
integrationRefIntegrationReferenceintegration_refIntegrationReferenceintegrationRefIntegrationReferenceIntegrationRefIntegrationReferenceIntegrationRefIntegrationReference#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.