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< ? requestParameters, Input<String, String> ?>Map< ? requestTemplates, Input<String, String> ?>List< ? responseParameters, Input<IntegrationResponseParameter> ?>String?> ? templateSelectionExpression, Input<int?> ? timeoutMilliseconds, Input<IntegrationTlsConfig?> ? tlsConfig}) -
Creates a new IntegrationState.
apiIdAPI identifier.connectionIdID of the VPC link for a private integration. Supported only for HTTP APIs. Must be between 1 and 1024 characters in length.connectionTypeType of the network connection to the integration endpoint. Valid values:INTERNET,VPC_LINK. Default isINTERNET.contentHandlingStrategyHow to handle response payload content type conversions. Valid values:CONVERT_TO_BINARY,CONVERT_TO_TEXT. Supported only for WebSocket APIs.credentialsArnCredentials required for the integration, if any.descriptionDescription of the integration.integrationMethodIntegration's HTTP method. Must be specified ifintegrationTypeis notMOCK. integrationResponseSelectionExpression Integration response selection expression for the integration.integrationSubtypeAWS service action to invoke. Supported only for HTTP APIs whenintegrationTypeisAWS_PROXY. See the AWS service integration reference documentation for supported values. Must be between 1 and 128 characters in length.integrationTypeIntegration 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, useHTTP_PROXY.integrationUriURI of the Lambda function for a Lambda proxy integration, whenintegrationTypeisAWS_PROXY. For anHTTPintegration, 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.passthroughBehaviorPass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as therequestTemplatesattribute. Valid values:WHEN_NO_MATCH,WHEN_NO_TEMPLATES,NEVER. Default isWHEN_NO_MATCH. Supported only for WebSocket APIs. payloadFormatVersion Format of the payload sent to an integration. Valid values:1.0,2.0. Default is1.0.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requestParametersFor WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. For HTTP APIs with a specifiedintegrationSubtype, a key-value map specifying parameters that are passed toAWS_PROXYintegrations. For HTTP APIs without a specifiedintegrationSubtype, 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.requestTemplatesMap 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.responseParametersMappings 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.timeoutMillisecondsCustom 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.tlsConfigTLS 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 isINTERNET.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
integrationTypeis notMOCK.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
integrationTypeisAWS_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, useHTTP_PROXY.final -
integrationUri
→ Input<
String?> ? -
URI of the Lambda function for a Lambda proxy integration, when
integrationTypeisAWS_PROXY. For anHTTPintegration, 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
requestTemplatesattribute. Valid values:WHEN_NO_MATCH,WHEN_NO_TEMPLATES,NEVER. Default isWHEN_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 is1.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 toAWS_PROXYintegrations. For HTTP APIs without a specifiedintegrationSubtype, 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