IntegrationState class

Input properties used for looking up and filtering Integration resources.

Constructors

IntegrationState({Input<List<String>?>? cacheKeyParameters, Input<String?>? cacheNamespace, Input<String?>? connectionId, Input<String?>? connectionType, Input<String?>? contentHandling, Input<String?>? credentials, Input<String?>? httpMethod, Input<String?>? integrationHttpMethod, Input<String?>? integrationTarget, Input<String?>? passthroughBehavior, Input<String?>? region, Input<Map<String, String>?>? requestParameters, Input<Map<String, String>?>? requestTemplates, Input<String?>? resourceId, Input<String?>? responseTransferMode, Input? restApi, Input<int?>? timeoutMilliseconds, Input<IntegrationTlsConfig?>? tlsConfig, Input<String?>? type, Input<String?>? uri})
Creates a new IntegrationState. cacheKeyParameters List of cache key parameters for the integration. cacheNamespace Integration's cache namespace. connectionId ID of the VpcLink used for the integration. Required if connectionType is VPC_LINK connectionType Integration input's connectionType. Valid values are INTERNET (default for connections through the public routable internet), and VPC_LINK (for private connections between API Gateway and a network load balancer in a VPC). contentHandling How to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_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. credentials Credentials required for the integration. For AWS integrations, 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 string arn:aws:iam::\*:user/\*. httpMethod HTTP method (GET, POST, PUT, DELETE, HEAD, OPTION, ANY) when calling the associated resource. integrationHttpMethod Integration HTTP method (GET, POST, PUT, DELETE, HEAD, OPTIONs, ANY, PATCH) specifying how API Gateway will interact with the back end. Required if type is AWS, AWS_PROXY, HTTP or HTTP_PROXY. Not all methods are compatible with all AWS integrations. e.g., Lambda function can only be invoked via POST. integrationTarget 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 uri is used to set the Host header. passthroughBehavior Integration passthrough behavior (WHEN_NO_MATCH, WHEN_NO_TEMPLATES, NEVER). Required if requestTemplates is used. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. requestParameters 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" } requestTemplates Map of the integration's request templates. resourceId API resource ID. responseTransferMode Response transfer mode of the integration. Valid values are BUFFERED and STREAM. Default to BUFFERED. Once set, setting the value to BUFFERED requires explicitly specifying BUFFERED, rather than removing this argument. restApi ID of the associated REST API. timeoutMilliseconds Custom timeout in milliseconds. The minimum value is 50. The maximum value is 300,000 when responseTransferMode is BUFFERED, and 900,000 when responseTransferMode is STREAM. The default value is 29,000 milliseconds. You need to raise a Service Quota Ticket to increase time beyond 29,000 milliseconds for BUFFERED mode. tlsConfig TLS configuration. See below. type 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) and HTTP_PROXY (for HTTP proxy integration). An HTTP or HTTP_PROXY integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC. uri Input's URI. Required if type is AWS, AWS_PROXY, HTTP or HTTP_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 form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. region, subdomain and service are 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
IntegrationState.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 connectionType is VPC_LINK
final
connectionType → Input<String?>?
Integration input's connectionType. Valid values are INTERNET (default for connections through the public routable internet), and VPC_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_BINARY and CONVERT_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 AWS integrations, 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 string arn: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 if type is AWS, AWS_PROXY, HTTP or HTTP_PROXY. Not all methods are compatible with all AWS integrations. e.g., Lambda function can only be invoked via POST.
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 uri is used to set the Host header.
final
passthroughBehavior → Input<String?>?
Integration passthrough behavior (WHEN_NO_MATCH, WHEN_NO_TEMPLATES, NEVER). Required if requestTemplates is 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 BUFFERED and STREAM. Default to BUFFERED. Once set, setting the value to BUFFERED requires explicitly specifying BUFFERED, 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 responseTransferMode is BUFFERED, and 900,000 when responseTransferMode is STREAM. The default value is 29,000 milliseconds. You need to raise a Service Quota Ticket to increase time beyond 29,000 milliseconds for BUFFERED mode.
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) and HTTP_PROXY (for HTTP proxy integration). An HTTP or HTTP_PROXY integration with a connectionType of VPC_LINK is 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 type is AWS, AWS_PROXY, HTTP or HTTP_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 form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. region, subdomain and service are 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