deployments

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

Overview

Name	deployments
Type	Resource
Id	aws.launch_wizard.deployments

Fields

The following fields are returned by SELECT queries:

get_deployment

Name	Datatype	Description
id	string	The ID of the deployment. (pattern: <code>[a-zA-Z0-9-]+</code>)
name	string	The name of the deployment.
created_at	string (date-time)	The time the deployment was created.
deleted_at	string (date-time)	The time the deployment was deleted.
deployment_arn	string	The Amazon Resource Name (ARN) of the deployment.
modified_at	string (date-time)	The time the deployment was last modified.
pattern_name	string	The pattern name of the deployment. (pattern: <code>[A-Za-z0-9][a-zA-Z0-9-]*</code>)
resource_group	string	The resource group of the deployment.
specifications	object	The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
status	string	The status of the deployment. (COMPLETED, CREATING, DELETE_IN_PROGRESS, DELETE_INITIATING, DELETE_FAILED, DELETED, FAILED, IN_PROGRESS, VALIDATING, UPDATE_IN_PROGRESS, UPDATE_COMPLETED, UPDATE_FAILED, UPDATE_ROLLBACK_COMPLETED, UPDATE_ROLLBACK_FAILED)
tags	object	Information about the tags attached to a deployment.
workload_name	string	The name of the workload. (pattern: <code>[A-Za-z][a-zA-Z0-9-_]*</code>)

list_deployments

Name	Datatype	Description
id	string	The ID of the deployment. (pattern: <code>[a-zA-Z0-9-]+</code>)
name	string	The name of the deployment
created_at	string (date-time)	The time the deployment was created.
modified_at	string (date-time)	The time the deployment was last modified.
pattern_name	string	The name of the workload deployment pattern. (pattern: <code>[A-Za-z0-9][a-zA-Z0-9-]*</code>)
status	string	The status of the deployment. (COMPLETED, CREATING, DELETE_IN_PROGRESS, DELETE_INITIATING, DELETE_FAILED, DELETED, FAILED, IN_PROGRESS, VALIDATING, UPDATE_IN_PROGRESS, UPDATE_COMPLETED, UPDATE_FAILED, UPDATE_ROLLBACK_COMPLETED, UPDATE_ROLLBACK_FAILED)
workload_name	string	The name of the workload. (pattern: <code>[A-Za-z][a-zA-Z0-9-_]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment	select	region		Returns information about the deployment.
list_deployments	select	region		Lists the deployments that have been created.
create_deployment	insert	region, workloadName, deploymentPatternName, name, specifications		Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.
update_deployment	update	region, deploymentId, specifications		Updates a deployment.
delete_deployment	delete	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
region	string	AWS region (default: us-east-1)

SELECT examples

get_deployment

Returns information about the deployment.

SELECT
id,
name,
created_at,
deleted_at,
deployment_arn,
modified_at,
pattern_name,
resource_group,
specifications,
status,
tags,
workload_name
FROM aws.launch_wizard.deployments
WHERE region = '{{ region }}' -- required
;

list_deployments

Lists the deployments that have been created.

SELECT
id,
name,
created_at,
modified_at,
pattern_name,
status,
workload_name
FROM aws.launch_wizard.deployments
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_deployment

Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.

INSERT INTO aws.launch_wizard.deployments (
workloadName,
deploymentPatternName,
name,
specifications,
dryRun,
tags,
region
)
SELECT 
'{{ workloadName }}' /* required */,
'{{ deploymentPatternName }}' /* required */,
'{{ name }}' /* required */,
'{{ specifications }}' /* required */,
{{ dryRun }},
'{{ tags }}',
'{{ region }}'
RETURNING
deployment_id
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the deployments resource.
  - name: workloadName
    value: "{{ workloadName }}"
  - name: deploymentPatternName
    value: "{{ deploymentPatternName }}"
  - name: name
    value: "{{ name }}"
  - name: specifications
    value: "{{ specifications }}"
  - name: dryRun
    value: {{ dryRun }}
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_deployment

Updates a deployment.

UPDATE aws.launch_wizard.deployments
SET 
deploymentId = '{{ deploymentId }}',
specifications = '{{ specifications }}',
workloadVersionName = '{{ workloadVersionName }}',
deploymentPatternVersionName = '{{ deploymentPatternVersionName }}',
dryRun = {{ dryRun }},
force = {{ force }}
WHERE 
region = '{{ region }}' --required
AND deploymentId = '{{ deploymentId }}' --required
AND specifications = '{{ specifications }}' --required
RETURNING
deployment;

DELETE examples

delete_deployment

Deletes a deployment.

DELETE FROM aws.launch_wizard.deployments
WHERE region = '{{ region }}' --required
;