Cloud.Service.AWS.API.Gateway.Integration

JSON Example

{
    "account": "string",
    "cache_key_parameters": [
        "string"
    ],
    "cache_namespace": "string",
    "connection_id": "string",
    "connection_type": "string",
    "content_handling": "string",
    "count": 0,
    "credentials": "string",
    "http_method": "string",
    "integration_http_method": "string",
    "passthrough_behavior": "string",
    "region": "string",
    "request_parameters_in_json": "string",
    "resource_id": "string",
    "rest_api_id": "string",
    "timeout_milliseconds": 0,
    "type": "string",
    "uri": "string"
}

string

account

Required

(Required) The name of the AWS cloud account to use for this resource

array of string

cache_key_parameters

Optional

List of request parameters, whose values are cached by the integration.

string

cache_namespace

Optional

API-specific tag group of related cached parameters.

string

connection_id

Optional

VpcLink identifier used for the integration. Required when connection_type is VPC_LINK.

string

connection_type

Optional

Network connection to the integration endpoint. Valid values are INTERNET for connections through the public routable internet, and VPC_LINK for private connections between the API Gateway and a network load balancer in a VPC.

string

content_handling

Optional

When set, the API converts payload content. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT. When omitted, the request payload is passed through from method request to integration request unmodified, provided that passthrough_behavior is configured to support the payload pass-through.

integer

count

Optional

The number of resource instances to be created.

string

credentials

Optional

The credentials required for the integration. For AWS integrations, two options are available. To specify an Identity and Access Management (IAM) role for the API Gateway to assume, enter the role ARN. To require that the caller identity be passed through from the request, enter the string: arn:aws:iam::*:user/*

string

http_method

Required

(Required) API HTTP method of GET, POST, PUT, DELETE, HEAD, OPTION, or ANY.

string

integration_http_method

Optional

Integration HTTP method of GET, POST, PUT, DELETE, HEAD, OPTION, or ANY.

string

passthrough_behavior

Optional

Pass-through behavior of WHEN_NO_MATCH, WHEN_NO_TEMPLATES, or NEVER. Required when request_templates is used.

string

region

Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

object

request_parameters

Optional

Map of request query string parameters and headers to pass to the back-end responder.

string

request_parameters_in_json

Optional

JSON formatted map of request query string parameters and headers to pass to the back-end responder.

object

request_templates

Optional

Map of templates that are applied to the request payload based on the content type.

string

resource_id

Required

(Required) Unique identifier assigned to the integration by AWS.

string

rest_api_id

Required

(Required) Unique identifier of the associated application REST API.

integer

timeout_milliseconds

Optional

Integration request timeout. Range is 50 to 29,000 milliseconds. Default is 29,000 milliseconds.

string

type

Required

(Required) Integration input type of HTTP (for HTTP back ends), MOCK (for integrating as a loop-back endpoint without invoking any back end), AWS (for AWS services), AWS_PROXY (for Lambda proxy integration), or HTTP_PROXY (for HTTP proxy integration). An HTTP or HTTP_PROXY integration with a connection_type of VPC_LINK is a private integration and uses a VpcLink to connect the API gateway to a network load balancer of a VPC.

string

uri

Optional

The integration input Uniform Resource Identifier (URI). Required for type AWS, AWS_PROXY, HTTP, and HTTP_PROXY.