AWS::ImageBuilder::Workflow - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::ImageBuilder::Workflow

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ImageBuilder::Workflow",
  "Properties" : {
      "ChangeDescription" : String,
      "Data" : String,
      "Description" : String,
      "KmsKeyId" : String,
      "Name" : String,
      "Tags" : {Key: Value, ...},
      "Type" : String,
      "Uri" : String,
      "Version" : String
    }
}

YAML

Type: AWS::ImageBuilder::Workflow
Properties:
  ChangeDescription: String
  Data: String
  Description: String
  KmsKeyId: String
  Name: String
  Tags: 
    Key: Value
  Type: String
  Uri: String
  Version: String

Properties

ChangeDescription

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

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Data

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.

Required: No

Type: String

Minimum: 1

Maximum: 16000

Update requires: Replacement

Description

Describes the workflow.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

KmsKeyId

The ID of the KMS key that is used to encrypt this workflow resource.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Name

The name of the workflow to create.

Required: Yes

Type: String

Pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Update requires: Replacement

Tags

Tags that apply to the workflow resource.

Required: No

Type: Object of String

Pattern: .{1,}

Update requires: Replacement

Type

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

Required: Yes

Type: String

Allowed values: BUILD | TEST | DISTRIBUTION

Update requires: Replacement

Uri

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.

Required: No

Type: String

Update requires: Replacement

Version

The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

Note

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.

Required: Yes

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the workflow resource.