IntegrationState class

Input properties used for looking up and filtering Integration resources.

Constructors

IntegrationState({Input<String?>? apiId, Input<String?>? connectionId, Input<String?>? connectionType, Input<String?>? contentHandlingStrategy, Input<String?>? credentialsArn, Input<String?>? description, Input<String?>? integrationMethod, Input<String?>? integrationResponseSelectionExpression, Input<String?>? integrationSubtype, Input<String?>? integrationType, Input<String?>? integrationUri, Input<String?>? passthroughBehavior, Input<String?>? payloadFormatVersion, Input<String?>? region, Input<Map<String, String>?>? requestParameters, Input<Map<String, String>?>? requestTemplates, Input<List<IntegrationResponseParameter>?>? responseParameters, Input<String?>? templateSelectionExpression, Input<int?>? timeoutMilliseconds, Input<IntegrationTlsConfig?>? tlsConfig})
Creates a new IntegrationState. apiId API identifier. connectionId ID of the VPC link for a private integration. Supported only for HTTP APIs. Must be between 1 and 1024 characters in length. connectionType Type of the network connection to the integration endpoint. Valid values: INTERNET, VPC_LINK. Default is INTERNET. contentHandlingStrategy How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT. Supported only for WebSocket APIs. credentialsArn Credentials required for the integration, if any. description Description of the integration. integrationMethod Integration's HTTP method. Must be specified if integrationType is not MOCK. integrationResponseSelectionExpression Integration response selection expression for the integration. integrationSubtype AWS service action to invoke. Supported only for HTTP APIs when integrationType is AWS_PROXY. See the AWS service integration reference documentation for supported values. Must be between 1 and 128 characters in length. integrationType Integration type of an integration. Valid values: AWS (supported only for WebSocket APIs), AWS_PROXY, HTTP (supported only for WebSocket APIs), HTTP_PROXY, MOCK (supported only for WebSocket APIs). For an HTTP API private integration, use HTTP_PROXY. integrationUri URI of the Lambda function for a Lambda proxy integration, when integrationType is AWS_PROXY. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. passthroughBehavior Pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates attribute. Valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, NEVER. Default is WHEN_NO_MATCH. Supported only for WebSocket APIs. payloadFormatVersion Format of the payload sent to an integration. Valid values: 1.0, 2.0. Default is 1.0. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. requestParameters For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. For HTTP APIs with a specified integrationSubtype, a key-value map specifying parameters that are passed to AWS_PROXY integrations. For HTTP APIs without a specified integrationSubtype, a key-value map specifying how to transform HTTP requests before sending them to the backend. See the Amazon API Gateway Developer Guide for details. requestTemplates Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. Supported only for WebSocket APIs. responseParameters Mappings to transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs. templateSelectionExpression Template selection expression for the integration. timeoutMilliseconds Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. this provider will only perform drift detection of its value when present in a configuration. tlsConfig TLS configuration for a private integration. Supported only for HTTP APIs.
const
IntegrationState.fromMap(Map<String, dynamic> map)
factory

Properties

apiId → Input<String?>?
API identifier.
final
connectionId → Input<String?>?
ID of the VPC link for a private integration. Supported only for HTTP APIs. Must be between 1 and 1024 characters in length.
final
connectionType → Input<String?>?
Type of the network connection to the integration endpoint. Valid values: INTERNET, VPC_LINK. Default is INTERNET.
final
contentHandlingStrategy → Input<String?>?
How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT. Supported only for WebSocket APIs.
final
credentialsArn → Input<String?>?
Credentials required for the integration, if any.
final
description → Input<String?>?
Description of the integration.
final
hashCode → int
The hash code for this object.
no setterinherited
integrationMethod → Input<String?>?
Integration's HTTP method. Must be specified if integrationType is not MOCK.
final
integrationResponseSelectionExpression → Input<String?>?
Integration response selection expression for the integration.
final
integrationSubtype → Input<String?>?
AWS service action to invoke. Supported only for HTTP APIs when integrationType is AWS_PROXY. See the AWS service integration reference documentation for supported values. Must be between 1 and 128 characters in length.
final
integrationType → Input<String?>?
Integration type of an integration. Valid values: AWS (supported only for WebSocket APIs), AWS_PROXY, HTTP (supported only for WebSocket APIs), HTTP_PROXY, MOCK (supported only for WebSocket APIs). For an HTTP API private integration, use HTTP_PROXY.
final
integrationUri → Input<String?>?
URI of the Lambda function for a Lambda proxy integration, when integrationType is AWS_PROXY. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service.
final
passthroughBehavior → Input<String?>?
Pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates attribute. Valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, NEVER. Default is WHEN_NO_MATCH. Supported only for WebSocket APIs.
final
payloadFormatVersion → Input<String?>?
Format of the payload sent to an integration. Valid values: 1.0, 2.0. Default is 1.0.
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>?>?
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. For HTTP APIs with a specified integrationSubtype, a key-value map specifying parameters that are passed to AWS_PROXY integrations. For HTTP APIs without a specified integrationSubtype, a key-value map specifying how to transform HTTP requests before sending them to the backend. See the Amazon API Gateway Developer Guide for details.
final
requestTemplates → Input<Map<String, String>?>?
Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. Supported only for WebSocket APIs.
final
responseParameters → Input<List<IntegrationResponseParameter>?>?
Mappings to transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
templateSelectionExpression → Input<String?>?
Template selection expression for the integration.
final
timeoutMilliseconds → Input<int?>?
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. this provider will only perform drift detection of its value when present in a configuration.
final
tlsConfig → Input<IntegrationTlsConfig?>?
TLS configuration for a private integration. Supported only for HTTP APIs.
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