deployment

Gets an individual deployment resource

Overview

Name	deployment
Type	Resource
Description	deployment
Id	awscc.apigateway.deployment

Fields

Name	Datatype	Description
deployment_id	string
deployment_canary_settings	object	The input configuration for a canary deployment.
description	string	The description for the Deployment resource to create.
rest_api_id	string	The string identifier of the associated RestApi.
stage_description	object	The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
stage_name	string	The name of the Stage resource for the Deployment resource to create.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
deployment_id,
deployment_canary_settings,
description,
rest_api_id,
stage_description,
stage_name
FROM awscc.apigateway.deployment
WHERE data__Identifier = '<DeploymentId>|<RestApiId>';

Permissions

To operate on the deployment resource, the following permissions are required:

Read

apigateway:GET

Update

apigateway:PATCH,
apigateway:GET,
apigateway:PUT,
apigateway:DELETE

Delete

apigateway:GET,
apigateway:DELETE