deployments

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

Overview

Name	deployments
Type	Resource
Id	aws.m2.deployments

Fields

The following fields are returned by SELECT queries:

get_deployment

Name	Datatype	Description
application_id	string	The unique identifier of the application. (pattern: <code>^\S{1,80}$</code>)
application_version	integer	The application version.
creation_time	string (date-time)	The timestamp when the deployment was created.
deployment_id	string	The unique identifier of the deployment. (pattern: <code>^\S{1,80}$</code>)
environment_id	string	The unique identifier of the runtime environment. (pattern: <code>^\S{1,80}$</code>)
status	string	The status of the deployment. (Deploying, Succeeded, Failed, Updating Deployment)
status_reason	string	The reason for the reported status.

list_deployments

Name	Datatype	Description
application_id	string	The unique identifier of the application. (pattern: <code>^\S{1,80}$</code>)
application_version	integer	The version of the application.
creation_time	string (date-time)	The timestamp when the deployment was created.
deployment_id	string	The unique identifier of the deployment. (pattern: <code>^\S{1,80}$</code>)
environment_id	string	The unique identifier of the runtime environment. (pattern: <code>^\S{1,80}$</code>)
status	string	The current status of the deployment. (Deploying, Succeeded, Failed, Updating Deployment)
status_reason	string	The reason for the reported status.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment	select	application_id, deployment_id, region		Gets details of a specific deployment with a given deployment identifier.
list_deployments	select	application_id, region	maxResults, nextToken	Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.
create_deployment	insert	application_id, region, applicationVersion, environmentId		Creates and starts a deployment to deploy an application into a runtime environment.

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
application_id	string	The application identifier.
deployment_id	string	The unique identifier for the deployment.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of objects to return.
nextToken	string	A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

SELECT examples

get_deployment

Gets details of a specific deployment with a given deployment identifier.

SELECT
application_id,
application_version,
creation_time,
deployment_id,
environment_id,
status,
status_reason
FROM aws.m2.deployments
WHERE application_id = '{{ application_id }}' -- required
AND deployment_id = '{{ deployment_id }}' -- required
AND region = '{{ region }}' -- required
;

list_deployments

Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.

SELECT
application_id,
application_version,
creation_time,
deployment_id,
environment_id,
status,
status_reason
FROM aws.m2.deployments
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_deployment

Creates and starts a deployment to deploy an application into a runtime environment.

INSERT INTO aws.m2.deployments (
applicationVersion,
clientToken,
environmentId,
application_id,
region
)
SELECT 
{{ applicationVersion }} /* required */,
'{{ clientToken }}',
'{{ environmentId }}' /* required */,
'{{ application_id }}',
'{{ region }}'
RETURNING
deployment_id
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the deployments resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the deployments resource.
  - name: applicationVersion
    value: {{ applicationVersion }}
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.
  - name: environmentId
    value: "{{ environmentId }}"