interface CfnWorkflowProps

Language	Type name
.NET	`Amazon.CDK.AWS.ImageBuilder.CfnWorkflowProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnWorkflowProps`
Java	`software.amazon.awscdk.services.imagebuilder.CfnWorkflowProps`
Python	`aws_cdk.aws_imagebuilder.CfnWorkflowProps`
TypeScript	`aws-cdk-lib` » `aws_imagebuilder` » `CfnWorkflowProps`

Properties for defining a CfnWorkflow.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const cfnWorkflowProps: imagebuilder.CfnWorkflowProps = {
  name: 'name',
  type: 'type',
  version: 'version',

  // the properties below are optional
  changeDescription: 'changeDescription',
  data: 'data',
  description: 'description',
  kmsKeyId: 'kmsKeyId',
  tags: {
    tagsKey: 'tags',
  },
  uri: 'uri',
};

Properties

Name	Type	Description
name	`string`	The name of the workflow to create.
type	`string`	The phase in the image build process for which the workflow resource is responsible.
version	`string`	The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.
changeDescription?	`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.
data?	`string`	Contains the UTF-8 encoded YAML document content for the workflow.
description?	`string`	Describes the workflow.
kmsKeyId?	`string`	The ID of the KMS key that is used to encrypt this workflow resource.
tags?	`{ [string]: string }`	Tags that apply to the workflow resource.
uri?	`string`	The `uri` of a YAML component document file.

name

Type: string

The name of the workflow to create.

type

Type: string

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

version

Type: string

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

The semantic version has four nodes: ../. 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.

changeDescription?

Type: string (optional)

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

data?

Type: string (optional)

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.

description?

Type: string (optional)

Describes the workflow.

kmsKeyId?

Type: string (optional)

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

tags?

Type: { [string]: string } (optional)

Tags that apply to the workflow resource.

uri?

Type: string (optional)

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.