IntegrationResponseArgs class

The set of arguments for IntegrationResponse. The set of arguments for IntegrationResponse.

Constructors

IntegrationResponseArgs({Input<String?>? contentHandling, required Input<String> httpMethod, Input<String?>? region, required Input<String> resourceId, Input<Map<String, String>?>? responseParameters, Input<Map<String, String>?>? responseTemplates, required Input restApi, Input<String?>? selectionPattern, required Input<String> statusCode})
Creates a new IntegrationResponseArgs. 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 response payload will be passed through from the integration response to the method response without modification. httpMethod HTTP method (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY). region Region where this resource will be managed. Defaults to the Region set in the provider configuration. resourceId API resource ID. responseParameters Map of response parameters that can be read from the backend response. For example: responseParameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }. responseTemplates Map of templates used to transform the integration response body. restApi ID of the associated REST API. selectionPattern Regular expression pattern used to choose an integration response based on the response from the backend. Omit configuring this to make the integration the default one. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched. statusCode HTTP status code.
const
IntegrationResponseArgs.fromMap(Map<String, dynamic> map)
factory

Properties

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 response payload will be passed through from the integration response to the method response without modification.
final
hashCode → int
The hash code for this object.
no setterinherited
httpMethod → Input<String>
HTTP method (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
resourceId → Input<String>
API resource ID.
final
responseParameters → Input<Map<String, String>?>?
Map of response parameters that can be read from the backend response. For example: responseParameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }.
final
responseTemplates → Input<Map<String, String>?>?
Map of templates used to transform the integration response body.
final
restApi → Input
ID of the associated REST API.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectionPattern → Input<String?>?
Regular expression pattern used to choose an integration response based on the response from the backend. Omit configuring this to make the integration the default one. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
final
statusCode → Input<String>
HTTP status code.
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