Interface ICfnWorkflowProps

Properties for defining a CfnWorkflow.

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnWorkflowProps

Syntax (vb)

Public Interface ICfnWorkflowProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ImageBuilder;

             var cfnWorkflowProps = new CfnWorkflowProps {
                 Name = "name",
                 Type = "type",
                 Version = "version",

                 // the properties below are optional
                 ChangeDescription = "changeDescription",
                 Data = "data",
                 Description = "description",
                 KmsKeyId = "kmsKeyId",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Uri = "uri"
             };

Synopsis

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.
Data	Contains the UTF-8 encoded YAML document content for the workflow.
Description	Describes the workflow.
KmsKeyId	The ID of the KMS key that is used to encrypt this workflow resource.
Name	The name of the workflow to create.
Tags	Tags that apply to the workflow resource.
Type	The phase in the image build process for which the workflow resource is responsible.
Uri	The `uri` of a YAML component document file.
Version	The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

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.

string? ChangeDescription { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-changedescription

Data

Contains the UTF-8 encoded YAML document content for the workflow.

string? Data { get; }

Property Value

string

Remarks

Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-data

Description

Describes the workflow.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-description

KmsKeyId

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

string? KmsKeyId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-kmskeyid

Name

The name of the workflow to create.

string Name { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-name

Type

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

string Type { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-type

Uri

The uri of a YAML component document file.

string? Uri { get; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-uri

Version

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

string Version { get; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-version