HttpPrivateIntegrationOptions Struct
Base options for private integration.
| Source | aws-apigatewayv2-integrations/lib/http/base-types.ts |
|---|---|
| Type last changed |
Example
ts
// 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';
import { aws_apigatewayv2_integrations as apigatewayv2_integrations } from 'aws-cdk-lib';
declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const vpcLink: apigatewayv2.VpcLink;
const httpPrivateIntegrationOptions: apigatewayv2_integrations.HttpPrivateIntegrationOptions = {
method: apigatewayv2.HttpMethod.ANY,
parameterMapping: parameterMapping,
secureServerName: 'secureServerName',
timeout: cdk.Duration.minutes(30),
vpcLink: vpcLink,
};
python
# 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
from aws_cdk import aws_apigatewayv2_integrations as apigatewayv2_integrations
# parameter_mapping: apigatewayv2.ParameterMapping
# vpc_link: apigatewayv2.VpcLink
http_private_integration_options = apigatewayv2_integrations.HttpPrivateIntegrationOptions(
method=apigatewayv2.HttpMethod.ANY,
parameter_mapping=parameter_mapping,
secure_server_name="secureServerName",
timeout=cdk.Duration.minutes(30),
vpc_link=vpc_link
)
java
// 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.*;
import software.amazon.awscdk.aws_apigatewayv2_integrations.*;
ParameterMapping parameterMapping;
VpcLink vpcLink;
HttpPrivateIntegrationOptions httpPrivateIntegrationOptions = HttpPrivateIntegrationOptions.builder()
.method(HttpMethod.ANY)
.parameterMapping(parameterMapping)
.secureServerName("secureServerName")
.timeout(Duration.minutes(30))
.vpcLink(vpcLink)
.build();
csharp
// 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;
using Amazon.CDK.AwsApigatewayv2Integrations;
ParameterMapping parameterMapping;
VpcLink vpcLink;
var httpPrivateIntegrationOptions = new HttpPrivateIntegrationOptions {
Method = HttpMethod.ANY,
ParameterMapping = parameterMapping,
SecureServerName = "secureServerName",
Timeout = Duration.Minutes(30),
VpcLink = vpcLink
};
go
// 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"
import "github.com/aws/aws-cdk-go/awscdk"
var parameterMapping ParameterMapping
var vpcLink VpcLink
httpPrivateIntegrationOptions := &HttpPrivateIntegrationOptions{
Method: awscdk.Aws_apigatewayv2.HttpMethod_ANY,
ParameterMapping: parameterMapping,
SecureServerName: jsii.String("secureServerName"),
Timeout: cdk.Duration_Minutes(jsii.Number(30)),
VpcLink: vpcLink,
}
Properties
methodoptionalHttpMethodmethodoptionalHttpMethodmethodoptionalHttpMethodMethodoptionalHttpMethodMethodoptionalHttpMethod = HttpMethod.ANY #The HTTP method that must be used to invoke the underlying HTTP proxy.
parameterMappingoptionalParameterMappingparameter_mappingoptionalParameterMappingparameterMappingoptionalParameterMappingParameterMappingoptionalParameterMappingParameterMappingoptionalParameterMapping #Specifies how to transform HTTP requests before sending them to the backend.
Default: undefined requests are sent to the backend unmodified
secureServerNameoptionalstringsecure_server_nameoptionalstrsecureServerNameoptionalStringSecureServerNameoptionalstringSecureServerNameoptional*string #Specifies the server name to verified by HTTPS when calling the backend integration.
Default: undefined private integration traffic will use HTTP protocol