Cloud.Service.AWS.API.Gateway.Deployment

JSON Example

{
    "created_date": "string",
    "description": "string",
    "execution_arn": "string",
    "invoke_url": "string",
    "provider": "string",
    "provider_region": "string",
    "rest_api_id": "string",
    "stage_description": "string",
    "stage_name": "string"
}

string

created_date

Optional

Date when the gateway deployment is created.

string

description

Optional

Description or purpose of the gateway deployment.

string

execution_arn

Optional

Amazon Resource Name (ARN) to be used when invoking the AWS Lambda function.

string

invoke_url

Optional

URL used to invoke the API that points to the stage. For example https://a54b781f.execute-api.us-west-1.amazonaws.com/prod.

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

rest_api_id

Required

(Required) Unique identifier of the associated Cloud Assembly REST API.

string

stage_description

Optional

Description or purpose of the gateway stage, such as test or production.

string

stage_name

Required

(Required) Name of the gateway stage. If the stage already exists, it will be updated to point to this deployment.

object

variables

Optional

Map that defines variables for the gateway stage.