Workflow
Defines a process that Image Builder uses to build and test images during the image creation process.
Contents
- arn
-
The Amazon Resource Name (ARN) of the workflow resource.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- data
-
Contains the YAML document content for the workflow.
Type: String
Required: No
- dateCreated
-
The timestamp when Image Builder created the workflow resource.
Type: String
Required: No
- description
-
The description of the workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- kmsKeyId
-
The KMS key identifier used to encrypt the workflow resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- name
-
The name of the workflow resource.
Type: String
Pattern:
^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$Required: No
- owner
-
The owner of the workflow resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- parameters
-
An array of input parameters that that the image workflow uses to control actions or configure settings.
Type: Array of WorkflowParameterDetail objects
Required: No
- state
-
Describes the current status of the workflow and the reason for that status.
Type: WorkflowState object
Required: No
-
The tags that apply to the workflow resource
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Maximum length of 256.
Required: No
- type
-
Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.
Type: String
Valid Values:
BUILD | TEST | DISTRIBUTIONRequired: No
- version
-
The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.
Type: String
Pattern:
^[0-9]+\.[0-9]+\.[0-9]+$Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: