deployments

Creates, updates, deletes, gets or lists a deployments resource.

Overview

Name	deployments
Type	Resource
Id	aws.apigatewayv2.deployments

Fields

The following fields are returned by SELECT queries:

get_deployment

Name	Datatype	Description
auto_deployed	boolean	Specifies whether a deployment was automatically released.
created_date	string (date-time)	The date and time when the Deployment resource was created.
deployment_id	string	The identifier.
deployment_status	string	The status of the deployment: PENDING, FAILED, or SUCCEEDED. (PENDING, FAILED, DEPLOYED)
deployment_status_message	string	May contain additional feedback on the status of an API deployment.
description	string	A string with a length between [0-1024].

get_deployments

Name	Datatype	Description
auto_deployed	boolean	Specifies whether a deployment was automatically released.
created_date	string (date-time)	The date and time when the Deployment resource was created.
deployment_id	string	The identifier.
deployment_status	string	The status of the deployment: PENDING, FAILED, or SUCCEEDED. (PENDING, FAILED, DEPLOYED)
deployment_status_message	string	May contain additional feedback on the status of an API deployment.
description	string	A string with a length between [0-1024].

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment	select	api_id, deployment_id, region		Gets a Deployment.
get_deployments	select	api_id, region	maxResults, nextToken	Gets the Deployments for an API.
create_deployment	insert	api_id, region		Creates a Deployment for an API.
update_deployment	update	api_id, deployment_id, region		Updates a Deployment.
delete_deployment	delete	api_id, deployment_id, region		Deletes a Deployment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_id	string	The API identifier.
deployment_id	string	The deployment ID.
region	string	AWS region (default: us-east-1)
maxResults	string	The maximum number of elements to be returned for this resource.
nextToken	string	The next page of elements from this collection. Not valid for the last element of the collection.

SELECT examples

get_deployment

Gets a Deployment.

SELECT
auto_deployed,
created_date,
deployment_id,
deployment_status,
deployment_status_message,
description
FROM aws.apigatewayv2.deployments
WHERE api_id = '{{ api_id }}' -- required
AND deployment_id = '{{ deployment_id }}' -- required
AND region = '{{ region }}' -- required
;

get_deployments

Gets the Deployments for an API.

SELECT
auto_deployed,
created_date,
deployment_id,
deployment_status,
deployment_status_message,
description
FROM aws.apigatewayv2.deployments
WHERE api_id = '{{ api_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_deployment

Creates a Deployment for an API.

INSERT INTO aws.apigatewayv2.deployments (
Description,
StageName,
api_id,
region
)
SELECT 
'{{ Description }}',
'{{ StageName }}',
'{{ api_id }}',
'{{ region }}'
RETURNING
auto_deployed,
created_date,
deployment_id,
deployment_status,
deployment_status_message,
description
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the deployments resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the deployments resource.
  - name: Description
    value: "{{ Description }}"
    description: |
      A string with a length between [0-1024].
  - name: StageName
    value: "{{ StageName }}"
    description: |
      A string with a length between [1-128].

UPDATE examples

update_deployment

Updates a Deployment.

UPDATE aws.apigatewayv2.deployments
SET 
Description = '{{ Description }}'
WHERE 
api_id = '{{ api_id }}' --required
AND deployment_id = '{{ deployment_id }}' --required
AND region = '{{ region }}' --required
RETURNING
auto_deployed,
created_date,
deployment_id,
deployment_status,
deployment_status_message,
description;

DELETE examples

delete_deployment

Deletes a Deployment.

DELETE FROM aws.apigatewayv2.deployments
WHERE api_id = '{{ api_id }}' --required
AND deployment_id = '{{ deployment_id }}' --required
AND region = '{{ region }}' --required
;