workflows

Creates, updates, deletes or gets a workflow resource or lists workflows in a region

Overview

Name	workflows
Type	Resource
Description	Resource schema for AWS::ImageBuilder::Workflow
Id	aws.imagebuilder.workflows

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the workflow.
name	string	The name of the workflow.
version	string	The version of the workflow.
description	string	The description of the workflow.
change_description	string	The change description of the workflow.
type	string	The type of the workflow denotes whether the workflow is used to build, test, or distribute.
data	string	The data of the workflow.
uri	string	The uri of the workflow.
kms_key_id	string	The KMS key identifier used to encrypt the workflow.
tags	object	The tags associated with the workflow.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Type, Version, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all workflows in a region.

SELECT
region,
arn,
name,
version,
description,
change_description,
type,
data,
uri,
kms_key_id,
tags
FROM aws.imagebuilder.workflows
WHERE region = 'us-east-1';

Gets all properties from an individual workflow.

SELECT
region,
arn,
name,
version,
description,
change_description,
type,
data,
uri,
kms_key_id,
tags
FROM aws.imagebuilder.workflows
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.imagebuilder.workflows (
 Name,
 Version,
 Type,
 region
)
SELECT 
'{{ Name }}',
 '{{ Version }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.imagebuilder.workflows (
 Name,
 Version,
 Description,
 ChangeDescription,
 Type,
 Data,
 Uri,
 KmsKeyId,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Version }}',
 '{{ Description }}',
 '{{ ChangeDescription }}',
 '{{ Type }}',
 '{{ Data }}',
 '{{ Uri }}',
 '{{ KmsKeyId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: workflow
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Version
        value: '{{ Version }}'
      - name: Description
        value: '{{ Description }}'
      - name: ChangeDescription
        value: '{{ ChangeDescription }}'
      - name: Type
        value: '{{ Type }}'
      - name: Data
        value: '{{ Data }}'
      - name: Uri
        value: '{{ Uri }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: Tags
        value: {}

DELETE example

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

Permissions

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

Create

iam:GetRole,
kms:GenerateDataKey*,
kms:Encrypt,
kms:Decrypt,
s3:GetObject,
s3:HeadBucket,
s3:GetBucketLocation,
imagebuilder:TagResource,
imagebuilder:GetWorkflow,
imagebuilder:CreateWorkflow

Read

imagebuilder:GetWorkflow

Delete

imagebuilder:GetWorkflow,
imagebuilder:UnTagResource,
imagebuilder:DeleteWorkflow

List

imagebuilder:ListWorkflows