IntegrationArgs class
The set of arguments for Integration. The set of arguments for Integration.
Constructors
-
IntegrationArgs({Input<
List< ? cacheKeyParameters, Input<String> ?>String?> ? cacheNamespace, Input<String?> ? connectionId, Input<String?> ? connectionType, Input<String?> ? contentHandling, Input<String?> ? credentials, required Input<String> httpMethod, Input<String?> ? integrationHttpMethod, Input<String?> ? integrationTarget, Input<String?> ? passthroughBehavior, Input<String?> ? region, Input<Map< ? requestParameters, Input<String, String> ?>Map< ? requestTemplates, required Input<String, String> ?>String> resourceId, Input<String?> ? responseTransferMode, required Input restApi, Input<int?> ? timeoutMilliseconds, Input<IntegrationTlsConfig?> ? tlsConfig, required Input<String> type, Input<String?> ? uri}) -
Creates a new IntegrationArgs.
cacheKeyParametersList of cache key parameters for the integration.cacheNamespaceIntegration's cache namespace.connectionIdID of the VpcLink used for the integration. Required ifconnectionTypeisVPC_LINKconnectionTypeIntegration input's connectionType. Valid values areINTERNET(default for connections through the public routable internet), andVPC_LINK(for private connections between API Gateway and a network load balancer in a VPC).contentHandlingHow to handle request payload content type conversions. Supported values areCONVERT_TO_BINARYandCONVERT_TO_TEXT. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.credentialsCredentials required for the integration. ForAWSintegrations, 2 options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's ARN. To require that the caller's identity be passed through from the request, specify the stringarn:aws:iam::\*:user/\*.httpMethodHTTP method (GET,POST,PUT,DELETE,HEAD,OPTION,ANY) when calling the associated resource.integrationHttpMethodIntegration HTTP method (GET,POST,PUT,DELETE,HEAD,OPTIONs,ANY,PATCH) specifying how API Gateway will interact with the back end. Required iftypeisAWS,AWS_PROXY,HTTPorHTTP_PROXY. Not all methods are compatible with allAWSintegrations. e.g., Lambda function can only be invoked viaPOST.integrationTargetALB or NLB ARN to send the request to. Used for private integrations with VPC Link V2. When using VPC Link V2, this parameter specifies the load balancer ARN, whileuriis used to set the Host header.passthroughBehaviorIntegration passthrough behavior (WHEN_NO_MATCH,WHEN_NO_TEMPLATES,NEVER). Required ifrequestTemplatesis used.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requestParametersMap of request query string parameters and headers that should be passed to the backend responder. For example:requestParameters = { "integration.request.header.X-Some-Other-Header" = "method.request.header.X-Some-Header" }requestTemplatesMap of the integration's request templates.resourceIdAPI resource ID.responseTransferModeResponse transfer mode of the integration. Valid values areBUFFEREDandSTREAM. Default toBUFFERED. Once set, setting the value toBUFFEREDrequires explicitly specifyingBUFFERED, rather than removing this argument.restApiID of the associated REST API.timeoutMillisecondsCustom timeout in milliseconds. The minimum value is 50. The maximum value is 300,000 whenresponseTransferModeisBUFFERED, and 900,000 whenresponseTransferModeisSTREAM. The default value is 29,000 milliseconds. You need to raise a Service Quota Ticket to increase time beyond 29,000 milliseconds forBUFFEREDmode.tlsConfigTLS configuration. See below.typeIntegration input's type. Valid values areHTTP(for HTTP backends),MOCK(not calling any real backend),AWS(for AWS services),AWS_PROXY(for Lambda proxy integration) andHTTP_PROXY(for HTTP proxy integration). AnHTTPorHTTP_PROXYintegration with aconnectionTypeofVPC_LINKis referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.uriInput's URI. Required iftypeisAWS,AWS_PROXY,HTTPorHTTP_PROXY. For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the formarn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}.region,subdomainandserviceare used to determine the right endpoint. e.g.,arn:aws:apigateway:eu-west-1:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-1:123456789012:function:my-func/invocations. For private integrations, the URI parameter is not used for routing requests to your endpoint, but is used for setting the Host header and for certificate validation.const -
IntegrationArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
cacheKeyParameters
→ Input<
List< ?String> ?> -
List of cache key parameters for the integration.
final
-
cacheNamespace
→ Input<
String?> ? -
Integration's cache namespace.
final
-
connectionId
→ Input<
String?> ? -
ID of the VpcLink used for the integration. Required if
connectionTypeisVPC_LINKfinal -
connectionType
→ Input<
String?> ? -
Integration input's connectionType. Valid values are
INTERNET(default for connections through the public routable internet), andVPC_LINK(for private connections between API Gateway and a network load balancer in a VPC).final -
contentHandling
→ Input<
String?> ? -
How to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARYandCONVERT_TO_TEXT. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.final -
credentials
→ Input<
String?> ? -
Credentials required for the integration. For
AWSintegrations, 2 options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's ARN. To require that the caller's identity be passed through from the request, specify the stringarn:aws:iam::\*:user/\*.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
httpMethod
→ Input<
String> -
HTTP method (
GET,POST,PUT,DELETE,HEAD,OPTION,ANY) when calling the associated resource.final -
integrationHttpMethod
→ Input<
String?> ? -
Integration HTTP method (
GET,POST,PUT,DELETE,HEAD,OPTIONs,ANY,PATCH) specifying how API Gateway will interact with the back end. Required iftypeisAWS,AWS_PROXY,HTTPorHTTP_PROXY. Not all methods are compatible with allAWSintegrations. e.g., Lambda function can only be invoked viaPOST.final -
integrationTarget
→ Input<
String?> ? -
ALB or NLB ARN to send the request to. Used for private integrations with VPC Link V2. When using VPC Link V2, this parameter specifies the load balancer ARN, while
uriis used to set the Host header.final -
passthroughBehavior
→ Input<
String?> ? -
Integration passthrough behavior (
WHEN_NO_MATCH,WHEN_NO_TEMPLATES,NEVER). Required ifrequestTemplatesis used.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
requestParameters
→ Input<
Map< ?String, String> ?> -
Map of request query string parameters and headers that should be passed to the backend responder. For example:
requestParameters = { "integration.request.header.X-Some-Other-Header" = "method.request.header.X-Some-Header" }final -
requestTemplates
→ Input<
Map< ?String, String> ?> -
Map of the integration's request templates.
final
-
resourceId
→ Input<
String> -
API resource ID.
final
-
responseTransferMode
→ Input<
String?> ? -
Response transfer mode of the integration. Valid values are
BUFFEREDandSTREAM. Default toBUFFERED. Once set, setting the value toBUFFEREDrequires explicitly specifyingBUFFERED, rather than removing this argument.final - restApi → Input
-
ID of the associated REST API.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
timeoutMilliseconds
→ Input<
int?> ? -
Custom timeout in milliseconds. The minimum value is 50. The maximum value is 300,000 when
responseTransferModeisBUFFERED, and 900,000 whenresponseTransferModeisSTREAM. The default value is 29,000 milliseconds. You need to raise a Service Quota Ticket to increase time beyond 29,000 milliseconds forBUFFEREDmode.final -
tlsConfig
→ Input<
IntegrationTlsConfig?> ? -
TLS configuration. See below.
final
-
type
→ Input<
String> -
Integration input's type. Valid values are
HTTP(for HTTP backends),MOCK(not calling any real backend),AWS(for AWS services),AWS_PROXY(for Lambda proxy integration) andHTTP_PROXY(for HTTP proxy integration). AnHTTPorHTTP_PROXYintegration with aconnectionTypeofVPC_LINKis referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.final -
uri
→ Input<
String?> ? -
Input's URI. Required if
typeisAWS,AWS_PROXY,HTTPorHTTP_PROXY. For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the formarn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}.region,subdomainandserviceare used to determine the right endpoint. e.g.,arn:aws:apigateway:eu-west-1:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-1:123456789012:function:my-func/invocations. For private integrations, the URI parameter is not used for routing requests to your endpoint, but is used for setting the Host header and for certificate validation.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited