AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ImageBuilder::Workflow

CfnWorkflow

Create a new workflow or a new version of an existing workflow.

Import

import { CfnWorkflow } from 'aws-cdk-lib/aws-imagebuilder';

Or use the module namespace:

import * as imagebuilder from 'aws-cdk-lib/aws-imagebuilder';
// imagebuilder.CfnWorkflow

Properties

Configuration passed to the constructor as CfnWorkflowProps.

nameRequired
string

The name of the workflow to create.

typeRequired
string

The phase in the image build process for which the workflow resource is responsible.

versionRequired
string

The semantic version of this workflow resource. The semantic version syntax adheres to the following rules. > The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. > > *Assignment:* For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. > > *Patterns:* You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

changeDescriptionOptional
string

Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.

dataOptional
string

Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the `uri` of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

descriptionOptional
string

Describes the workflow.

kmsKeyIdOptional
string

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) in the *AWS Key Management Service Developer Guide* .

tagsOptional
{ [key: string]: string }

Tags that apply to the workflow resource.

uriOptional
string

The `uri` of a YAML component document file. This must be an S3 URL ( `s3://bucket/key` ), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota. Alternatively, you can specify the YAML document inline, using the component `data` property. You cannot specify both properties.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter