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	awscc.launchwizard.deployments

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	ARN of the LaunchWizard deployment
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	deployments	INSERT	DeploymentPatternName, Name, WorkloadName, region
delete_resource	deployments	DELETE	Identifier, region
update_resource	deployments	UPDATE	Identifier, PatchDocument, region
list_resources	deployments_list_only	SELECT	region
get_resource	deployments	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.launchwizard.deployments
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all deployments in a region.

SELECT
  region,
  arn
FROM awscc.launchwizard.deployments_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.launchwizard.deployments (
  DeploymentPatternName,
  Name,
  WorkloadName,
  region
)
SELECT
  '{{ deployment_pattern_name }}',
  '{{ name }}',
  '{{ workload_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.launchwizard.deployments (
  DeploymentPatternName,
  Name,
  Specifications,
  Tags,
  WorkloadName,
  region
)
SELECT
  '{{ deployment_pattern_name }}',
  '{{ name }}',
  '{{ specifications }}',
  '{{ tags }}',
  '{{ workload_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: deployment
  props:
    - name: deployment_pattern_name
      value: '{{ deployment_pattern_name }}'
    - name: name
      value: '{{ name }}'
    - name: specifications
      value: {}
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: workload_name
      value: '{{ workload_name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.launchwizard.deployments
SET PatchDocument = string('{{ {
    "Specifications": specifications,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.launchwizard.deployments
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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