deployments

Creates, updates, deletes or gets a deployment resource or lists deployments in a region

Overview

Name	deployments
Type	Resource
Description	Definition of AWS::LaunchWizard::Deployment Resource Type
Id	aws.launchwizard.deployments

Fields

Name	Datatype	Description
arn	string	ARN of the LaunchWizard deployment
created_at	string	Timestamp of LaunchWizard deployment creation
deleted_at	string	Timestamp of LaunchWizard deployment deletion
deployment_id	string	Deployment ID of the LaunchWizard deployment
deployment_pattern_name	string	Workload deployment pattern name
name	string	Name of LaunchWizard deployment
resource_group	string	Resource Group Name created for LaunchWizard deployment
specifications	object	LaunchWizard deployment specifications
status	string	Status of LaunchWizard deployment
tags	array	Tags for LaunchWizard deployment
workload_name	string	Workload Name for LaunchWizard deployment
region	string	AWS region.

For more information, see AWS::LaunchWizard::Deployment.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DeploymentPatternName, Name, Specifications, WorkloadName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all deployments in a region.

SELECT
region,
arn,
created_at,
deleted_at,
deployment_id,
deployment_pattern_name,
name,
resource_group,
specifications,
status,
tags,
workload_name
FROM aws.launchwizard.deployments
WHERE region = 'us-east-1';

Gets all properties from an individual deployment.

SELECT
region,
arn,
created_at,
deleted_at,
deployment_id,
deployment_pattern_name,
name,
resource_group,
specifications,
status,
tags,
workload_name
FROM aws.launchwizard.deployments
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new deployment resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.launchwizard.deployments (
 DeploymentPatternName,
 Name,
 Specifications,
 WorkloadName,
 region
)
SELECT 
'{{ DeploymentPatternName }}',
 '{{ Name }}',
 '{{ Specifications }}',
 '{{ WorkloadName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.launchwizard.deployments (
 DeploymentPatternName,
 Name,
 Specifications,
 Tags,
 WorkloadName,
 region
)
SELECT 
 '{{ DeploymentPatternName }}',
 '{{ Name }}',
 '{{ Specifications }}',
 '{{ Tags }}',
 '{{ WorkloadName }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: deployment
    props:
      - name: DeploymentPatternName
        value: '{{ DeploymentPatternName }}'
      - name: Name
        value: '{{ Name }}'
      - name: Specifications
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: WorkloadName
        value: '{{ WorkloadName }}'

DELETE example

/*+ delete */
DELETE FROM aws.launchwizard.deployments
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

launchwizard:CreateDeployment,
launchwizard:GetDeployment,
launchwizard:ListDeploymentEvents,
launchwizard:ListTagsForResource,
launchwizard:TagResource,
ssm:GetParameter,
ssm:PutParameter,
ssm:DescribeParameters,
ssm:AddTagsToResource,
ssm:DeleteParameter,
secretsmanager:DescribeSecret,
secretsmanager:PutSecretValue,
secretsmanager:CreateSecret,
secretsmanager:TagResource,
secretsmanager:UpdateSecret,
resource-groups:CreateGroup,
resource-groups:DeleteGroup,
cloudformation:DeleteStack,
cloudformation:DescribeStackResources,
cloudformation:DescribeStackResource,
cloudformation:DescribeStacks,
cloudformation:DescribeStackEvents,
cloudformation:CreateStack,
cloudformation:TagResource,
s3:PutObject,
s3:GetObject,
s3:CreateBucket,
sns:ListSubscriptionsByTopic,
sns:Publish,
sns:ListSubscriptions,
sns:ListTopics,
sns:CreateTopic,
sns:Subscribe,
sns:Unsubscribe,
sqs:TagQueue,
sqs:GetQueueUrl,
sqs:AddPermission,
sqs:ListQueues,
sqs:GetQueueAttributes,
sqs:ListQueueTags,
sqs:CreateQueue,
sqs:SetQueueAttributes

Read

launchwizard:GetDeployment,
launchwizard:ListDeploymentEvents,
launchwizard:ListTagsForResource

Delete

launchwizard:GetDeployment,
launchwizard:DeleteDeployment,
launchwizard:UntagResource,
ssm:DeleteParameter,
secretsmanager:DeleteSecret,
resource-groups:DeleteGroup,
cloudformation:DeleteStack,
cloudformation:DescribeStacks,
ssm:GetParameter,
sns:ListSubscriptionsByTopic,
sns:Publish,
sns:ListSubscriptions,
sns:ListTopics,
sns:CreateTopic,
sns:DeleteTopic,
sns:Subscribe,
sns:Unsubscribe,
sqs:GetQueueUrl,
sqs:ListQueues,
sqs:DeleteQueue,
sqs:GetQueueAttributes,
sqs:ListQueueTags

Update

launchwizard:GetDeployment,
launchwizard:ListTagsForResource,
launchwizard:TagResource,
launchwizard:UntagResource

List

launchwizard:ListDeployments,
launchwizard:ListTagsForResource