Class HttpRouteIntegrationConfig
Config returned back as a result of the bind.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HttpRouteIntegrationConfig : Object, IHttpRouteIntegrationConfig
Syntax (vb)
Public Class HttpRouteIntegrationConfig
Inherits Object
Implements 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.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,
Uri = "uri"
};
Synopsis
Constructors
HttpRouteIntegrationConfig() |
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. |
Type | Integration type. |
Uri | Integration URI. |
Constructors
HttpRouteIntegrationConfig()
public HttpRouteIntegrationConfig()
Properties
ConnectionId
The ID of the VPC link for a private integration.
public string ConnectionId { get; set; }
Property Value
System.String
Remarks
Supported only for HTTP APIs.
Default: - undefined
ConnectionType
The type of the network connection to the integration endpoint.
public Nullable<HttpConnectionType> ConnectionType { get; set; }
Property Value
System.Nullable<HttpConnectionType>
Remarks
Default: HttpConnectionType.INTERNET
Credentials
The credentials with which to invoke the integration.
public IntegrationCredentials Credentials { get; set; }
Property Value
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.
public Nullable<HttpMethod> Method { get; set; }
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.
public ParameterMapping ParameterMapping { get; set; }
Property Value
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.
public PayloadFormatVersion PayloadFormatVersion { get; set; }
Property Value
Remarks
Default: - undefined
SecureServerName
Specifies the server name to verified by HTTPS when calling the backend integration.
public string SecureServerName { get; set; }
Property Value
System.String
Remarks
Default: undefined private integration traffic will use HTTP protocol
Subtype
Integration subtype.
public Nullable<HttpIntegrationSubtype> Subtype { get; set; }
Property Value
System.Nullable<HttpIntegrationSubtype>
Remarks
Default: - none, required if no integrationUri
is defined.
Type
Uri
Integration URI.
public string Uri { get; set; }
Property Value
System.String
Remarks
Default: - none, required if no integrationSubtype
is defined.