Integration class

Represents an integration.

Constructors

Integration({bool? apiGatewayManaged, String? connectionId, ConnectionType? connectionType, ContentHandlingStrategy? contentHandlingStrategy, String? credentialsArn, String? description, String? integrationId, String? integrationMethod, String? integrationResponseSelectionExpression, String? integrationSubtype, IntegrationType? integrationType, String? integrationUri, PassthroughBehavior? passthroughBehavior, String? payloadFormatVersion, Map<String, String>? requestParameters, Map<String, String>? requestTemplates, Map<String, Map<String, String>>? responseParameters, String? templateSelectionExpression, int? timeoutInMillis, TlsConfig? tlsConfig})
Integration.fromJson(Map<String, dynamic> json)
factory

Properties

apiGatewayManaged bool?
Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
final
connectionId String?
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
final
connectionType ConnectionType?
The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
final
contentHandlingStrategy ContentHandlingStrategy?
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
final
credentialsArn String?
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.
final
description String?
Represents the description of an integration.
final
hashCode int
The hash code for this object.
no setterinherited
integrationId String?
Represents the identifier of an integration.
final
integrationMethod String?
Specifies the integration's HTTP method type.
final
integrationResponseSelectionExpression String?
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
final
integrationSubtype String?
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
final
integrationType IntegrationType?
The integration type of an integration. One of the following:
final
integrationUri String?
For a Lambda integration, specify the URI of a Lambda function.
final
passthroughBehavior PassthroughBehavior?
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
final
payloadFormatVersion String?
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
final
requestParameters Map<String, String>?
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.. , where is querystring, path, or header; and must be a valid and unique method request parameter name.
final
requestTemplates Map<String, String>?
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
final
responseParameters Map<String, Map<String, String>>?
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
templateSelectionExpression String?
The template selection expression for the integration. Supported only for WebSocket APIs.
final
timeoutInMillis 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.
final
tlsConfig TlsConfig?
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited