Cloud.Service.AWS.API.Gateway.Rest.API

Cloud.Service.AWS.API.Gateway.Rest.API
Cloud.Service.AWS.API.Gateway.Rest.API
JSON Example
{
    "api_key_source": "string",
    "binary_media_types": [
        "string"
    ],
    "body": "string",
    "created_date": "string",
    "description": "string",
    "endpoint_configuration": [
        {
            "types": [
                "string"
            ]
        }
    ],
    "execution_arn": "string",
    "minimum_compression_size": 0,
    "name": "string",
    "policy": "string",
    "provider": "string",
    "provider_region": "string",
    "root_resource_id": "string"
}
string
api_key_source
Optional

Source of the API key for requests. Valid values are HEADER and AUTHORIZER. Default is HEADER.

array of string
binary_media_types
Optional

List of binary media types supported by the REST API. Default is only UTF-8-encoded text payload support.

string
body
Optional

OpenAPI specification that defines the set of routes and integrations to create as part of the REST API.

string
created_date
Optional

Date when the REST API is created.

string
description
Optional

Description or purpose of the REST API.

array of object
endpoint_configuration
Optional

Endpoint configuration of the REST API, showing the endpoint types of the API.

string
execution_arn
Optional

Amazon Resource Name (ARN) to be used when invoking the AWS Lambda function. For example: arn:aws:execute-api:us-west-1:654321:k47905, which can be concatenated with allowed stage, method, and resource path.

integer
minimum_compression_size
Optional

The REST API compresses responses of this size or greater. Range is integer from -1 to 10485760 (10 MB), where greater than -1 enables compression, Default is -1 (compression disabled).

string
name
Required

(Required) Name of the REST API.

string
policy
Optional

JSON formatted AWS IAM policy document that controls access to the API gateway.

string
provider
Required

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

string
provider_region
Required

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

string
root_resource_id
Optional

Unique identifier assigned by AWS to REST API root.