HttpIntegrationProps Struct
The integration properties.
| Source | aws-apigatewayv2/lib/http/integration.ts |
|---|---|
| Type last changed |
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 httpIntegrationProps: apigatewayv2.HttpIntegrationProps = {
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_props = apigatewayv2.HttpIntegrationProps(
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;
HttpIntegrationProps httpIntegrationProps = HttpIntegrationProps.builder()
.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 httpIntegrationProps = 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
httpIntegrationProps := &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)),
}
Properties
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_apiIHttpApiRefhttpApiIHttpApiRefHttpApiIHttpApiRefHttpApiIHttpApiRef required #integrationSubtypeoptionalHttpIntegrationSubtypeintegration_subtypeoptionalHttpIntegrationSubtypeintegrationSubtypeoptionalHttpIntegrationSubtypeIntegrationSubtypeoptionalHttpIntegrationSubtypeIntegrationSubtypeoptionalHttpIntegrationSubtype #Default: none, required if no integrationUri is defined.
Used for AWS Service integrations, specifies the target of the integration.
integrationTypeHttpIntegrationTypeintegration_typeHttpIntegrationTypeintegrationTypeHttpIntegrationTypeIntegrationTypeHttpIntegrationTypeIntegrationTypeHttpIntegrationType required #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