Interface IHttpRouteIntegrationConfig

Config returned back as a result of the bind.

Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IHttpRouteIntegrationConfig
Syntax (vb)
Public Interface IHttpRouteIntegrationConfig
Remarks

ExampleMetadata: fixture=_generated

Examples
// 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;

IntegrationCredentials integrationCredentials;
ParameterMapping parameterMapping;
PayloadFormatVersion payloadFormatVersion;

var httpRouteIntegrationConfig = new HttpRouteIntegrationConfig {
    PayloadFormatVersion = payloadFormatVersion,
    Type = HttpIntegrationType.HTTP_PROXY,

    // the properties below are optional
    ConnectionId = "connectionId",
    ConnectionType = HttpConnectionType.VPC_LINK,
    Credentials = integrationCredentials,
    Method = HttpMethod.ANY,
    ParameterMapping = parameterMapping,
    SecureServerName = "secureServerName",
    Subtype = HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
    Timeout = Duration.Minutes(30),
    Uri = "uri"
};

Synopsis

Properties

ConnectionId

The ID of the VPC link for a private integration.
ConnectionType

The type of the network connection to the integration endpoint.
Credentials

The credentials with which to invoke the integration.
Method

The HTTP method that must be used to invoke the underlying proxy.
ParameterMapping

Specifies how to transform HTTP requests before sending them to the backend.
PayloadFormatVersion

Payload format version in the case of lambda proxy integration.
SecureServerName

Specifies the server name to verified by HTTPS when calling the backend integration.
Subtype

Integration subtype.
Timeout

The maximum amount of time an integration will run before it returns without a response.
Type

Integration type.
Uri

Integration URI.

Properties

ConnectionId

The ID of the VPC link for a private integration.

virtual string ConnectionId { get; }
Property Value

System.String

Remarks

Supported only for HTTP APIs.

Default: - undefined

ConnectionType

The type of the network connection to the integration endpoint.

virtual Nullable<HttpConnectionType> ConnectionType { get; }
Property Value

System.Nullable<HttpConnectionType>

Remarks

Default: HttpConnectionType.INTERNET

Credentials

The credentials with which to invoke the integration.

virtual IntegrationCredentials Credentials { get; }
Property Value

IntegrationCredentials

Remarks

Default: - no credentials, use resource-based permissions on supported AWS services

Method

The HTTP method that must be used to invoke the underlying proxy.

virtual Nullable<HttpMethod> Method { get; }
Property Value

System.Nullable<HttpMethod>

Remarks

Required for HttpIntegrationType.HTTP_PROXY

Default: - undefined

ParameterMapping

Specifies how to transform HTTP requests before sending them to the backend.

virtual ParameterMapping ParameterMapping { get; }
Property Value

ParameterMapping

Remarks

Default: undefined requests are sent to the backend unmodified

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

PayloadFormatVersion

Payload format version in the case of lambda proxy integration.

PayloadFormatVersion PayloadFormatVersion { get; }
Property Value

PayloadFormatVersion

Remarks

Default: - undefined

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html

SecureServerName

Specifies the server name to verified by HTTPS when calling the backend integration.

virtual string SecureServerName { get; }
Property Value

System.String

Remarks

Default: undefined private integration traffic will use HTTP protocol

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html

Subtype

Integration subtype.

virtual Nullable<HttpIntegrationSubtype> Subtype { get; }
Property Value

System.Nullable<HttpIntegrationSubtype>

Remarks

Default: - none, required if no integrationUri is defined.

Timeout

The maximum amount of time an integration will run before it returns without a response.

virtual Duration Timeout { get; }
Property Value

Duration

Remarks

Must be between 50 milliseconds and 29 seconds.

Default: Duration.seconds(29)

Type

Integration type.

HttpIntegrationType Type { get; }
Property Value

HttpIntegrationType

Uri

Integration URI.

virtual string Uri { get; }
Property Value

System.String

Remarks

Default: - none, required if no integrationSubtype is defined.