Package software.amazon.awscdk.services.imagebuilder

Class CfnWorkflow.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.CfnWorkflow.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWorkflow>

Enclosing class:

CfnWorkflow

@Stability(Stable)
public static final class CfnWorkflow.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWorkflow>

A fluent builder for CfnWorkflow.

Method Summary

Modifier and Type	Method	Description
CfnWorkflow	build()
CfnWorkflow.Builder	changeDescription(String 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.
static CfnWorkflow.Builder	create(software.constructs.Construct scope, String id)
CfnWorkflow.Builder	data(String data)	Contains the UTF-8 encoded YAML document content for the workflow.
CfnWorkflow.Builder	description(String description)	Describes the workflow.
CfnWorkflow.Builder	kmsKeyId(String kmsKeyId)	The ID of the KMS key that is used to encrypt this workflow resource.
CfnWorkflow.Builder	name(String name)	The name of the workflow to create.
CfnWorkflow.Builder	tags(Map<String,String> tags)	Tags that apply to the workflow resource.
CfnWorkflow.Builder	type(String type)	The phase in the image build process for which the workflow resource is responsible.
CfnWorkflow.Builder	uri(String uri)	The uri of a YAML component document file.
CfnWorkflow.Builder	version(String version)	The semantic version of this workflow resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnWorkflow.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnWorkflow.Builder.

name

@Stability(Stable)
public CfnWorkflow.Builder name(String name)

The name of the workflow to create.

Parameters:

name - The name of the workflow to create. This parameter is required.

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnWorkflow.Builder type(String type)

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

Parameters:

type - The phase in the image build process for which the workflow resource is responsible. This parameter is required.

Returns:

this

See Also:

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

version

@Stability(Stable)
public CfnWorkflow.Builder version(String version)

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.

Parameters:

version - The semantic version of this workflow resource. The semantic version syntax adheres to the following rules. This parameter is required.

Returns:

this

See Also:

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

changeDescription

@Stability(Stable)
public CfnWorkflow.Builder changeDescription(String 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

data

@Stability(Stable)
public CfnWorkflow.Builder data(String 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.

Parameters:

data - Contains the UTF-8 encoded YAML document content for the workflow. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnWorkflow.Builder description(String description)

Describes the workflow.

Parameters:

description - Describes the workflow. This parameter is required.

Returns:

this

See Also:

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

kmsKeyId

@Stability(Stable)
public CfnWorkflow.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

kmsKeyId - The ID of the KMS key that is used to encrypt this workflow resource. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnWorkflow.Builder tags(Map<String,String> tags)

Tags that apply to the workflow resource.

Parameters:

tags - Tags that apply to the workflow resource. This parameter is required.

Returns:

this

See Also:

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

uri

@Stability(Stable)
public CfnWorkflow.Builder uri(String 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.

Parameters:

uri - The uri of a YAML component document file. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnWorkflow build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnWorkflow>

Returns:

a newly built instance of CfnWorkflow.