Interface IHttpIntegrationProps
(experimental) The integration properties.
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface IHttpIntegrationProps
Syntax (vb)
Public Interface IHttpIntegrationProps
Remarks
Stability: Experimental
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.AWS.APIGatewayv2;
HttpApi httpApi;
IntegrationCredentials integrationCredentials;
ParameterMapping parameterMapping;
PayloadFormatVersion payloadFormatVersion;
var httpIntegrationProps = new HttpIntegrationProps {
HttpApi = httpApi,
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"
};
Synopsis
Properties
ConnectionId | (experimental) The ID of the VPC link for a private integration. |
ConnectionType | (experimental) The type of the network connection to the integration endpoint. |
Credentials | (experimental) The credentials with which to invoke the integration. |
HttpApi | (experimental) The HTTP API to which this integration should be bound. |
IntegrationSubtype | (experimental) Integration subtype. |
IntegrationType | (experimental) Integration type. |
IntegrationUri | (experimental) Integration URI. |
Method | (experimental) The HTTP method to use when calling the underlying HTTP proxy. |
ParameterMapping | (experimental) Specifies how to transform HTTP requests before sending them to the backend. |
PayloadFormatVersion | (experimental) The version of the payload format. |
SecureServerName | (experimental) Specifies the TLS configuration for a private integration. |
Properties
ConnectionId
(experimental) 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
Stability: Experimental
ConnectionType
(experimental) The type of the network connection to the integration endpoint.
virtual Nullable<HttpConnectionType> ConnectionType { get; }
Property Value
System.Nullable<HttpConnectionType>
Remarks
Default: HttpConnectionType.INTERNET
Stability: Experimental
Credentials
(experimental) The credentials with which to invoke the integration.
virtual IntegrationCredentials Credentials { get; }
Property Value
Remarks
Default: - no credentials, use resource-based permissions on supported AWS services
Stability: Experimental
HttpApi
(experimental) The HTTP API to which this integration should be bound.
IHttpApi HttpApi { get; }
Property Value
Remarks
Stability: Experimental
IntegrationSubtype
(experimental) Integration subtype.
virtual Nullable<HttpIntegrationSubtype> IntegrationSubtype { get; }
Property Value
System.Nullable<HttpIntegrationSubtype>
Remarks
Used for AWS Service integrations, specifies the target of the integration.
Default: - none, required if no integrationUri
is defined.
Stability: Experimental
IntegrationType
(experimental) Integration type.
HttpIntegrationType IntegrationType { get; }
Property Value
Remarks
Stability: Experimental
IntegrationUri
(experimental) Integration URI.
virtual string IntegrationUri { get; }
Property Value
System.String
Remarks
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.
Stability: Experimental
Method
(experimental) The HTTP method to use when calling the underlying HTTP proxy.
virtual Nullable<HttpMethod> Method { get; }
Property Value
System.Nullable<HttpMethod>
Remarks
Default: - none. required if the integration type is HttpIntegrationType.HTTP_PROXY
.
Stability: Experimental
ParameterMapping
(experimental) Specifies how to transform HTTP requests before sending them to the backend.
virtual ParameterMapping ParameterMapping { get; }
Property Value
Remarks
Default: undefined requests are sent to the backend unmodified
Stability: Experimental
See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
PayloadFormatVersion
(experimental) The version of the payload format.
virtual PayloadFormatVersion PayloadFormatVersion { get; }
Property Value
Remarks
Default: - defaults to latest in the case of HttpIntegrationType.AWS_PROXY`, irrelevant otherwise.
Stability: Experimental
SecureServerName
(experimental) Specifies the TLS configuration for a private integration.
virtual string SecureServerName { get; }
Property Value
System.String
Remarks
Default: undefined private integration traffic will use HTTP protocol
Stability: Experimental