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 YAML document content for the workflow.
CfnWorkflow.Builder	description(String description)	The description of the workflow.
CfnWorkflow.Builder	kmsKeyId(String kmsKeyId)	The KMS key identifier used to encrypt the workflow resource.
CfnWorkflow.Builder	name(String name)	The name of the workflow resource.
CfnWorkflow.Builder	tags(Map<String,String> tags)	The tags that apply to the workflow resource.
CfnWorkflow.Builder	type(String type)	Specifies the image creation stage that the workflow applies to.
CfnWorkflow.Builder	uri(String uri)	The uri of the workflow.
CfnWorkflow.Builder	version(String version)	The workflow resource version.

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 resource.

Parameters:

name - The name of 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-name

type

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

Specifies the image creation stage that the workflow applies to.

Image Builder currently supports build and test workflows.

Parameters:

type - Specifies the image creation stage that the workflow applies to. 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 workflow resource version.

Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.

Parameters:

version - The workflow resource version. 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 YAML document content for the workflow.

Parameters:

data - Contains the 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)

The description of the workflow.

Parameters:

description - The description 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-description

kmsKeyId

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

The KMS key identifier used to encrypt the workflow resource.

Parameters:

kmsKeyId - The KMS key identifier used to encrypt 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-kmskeyid

tags

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

The tags that apply to the workflow resource.

Parameters:

tags - The 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 the workflow.

Parameters:

uri - The uri 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-uri

build

@Stability(Stable)
public CfnWorkflow build()

Specified by:

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

Returns:

a newly built instance of CfnWorkflow.