Package software.amazon.awscdk.services.imagebuilder

Interface CfnWorkflowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkflowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:27.559Z")
@Stability(Stable)
public interface CfnWorkflowProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.imagebuilder.*;
 CfnWorkflowProps cfnWorkflowProps = CfnWorkflowProps.builder()
         .name("name")
         .type("type")
         .version("version")
         // the properties below are optional
         .changeDescription("changeDescription")
         .data("data")
         .description("description")
         .kmsKeyId("kmsKeyId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .uri("uri")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkflowProps.Builder	A builder for CfnWorkflowProps
static final class	CfnWorkflowProps.Jsii$Proxy	An implementation for CfnWorkflowProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkflowProps.Builder	builder()
default String	getChangeDescription()	Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
default String	getData()	Contains the YAML document content for the workflow.
default String	getDescription()	The description of the workflow.
default String	getKmsKeyId()	The KMS key identifier used to encrypt the workflow resource.
String	getName()	The name of the workflow resource.
default Map<String,String>	getTags()	The tags that apply to the workflow resource.
String	getType()	Specifies the image creation stage that the workflow applies to.
default String	getUri()	The uri of the workflow.
String	getVersion()	The workflow resource version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the workflow resource.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

Specifies the image creation stage that the workflow applies to.

Image Builder currently supports build and test workflows.

See Also:

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

getVersion

@Stability(Stable)
@NotNull
String getVersion()

The workflow resource version.

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

See Also:

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

getChangeDescription

@Stability(Stable)
@Nullable
default String getChangeDescription()

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

See Also:

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

getData

@Stability(Stable)
@Nullable
default String getData()

Contains the YAML document content for the workflow.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the workflow.

See Also:

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The KMS key identifier used to encrypt the workflow resource.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The tags that apply to the workflow resource.

See Also:

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

getUri

@Stability(Stable)
@Nullable
default String getUri()

The uri of the workflow.

See Also:

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

builder

@Stability(Stable)
static CfnWorkflowProps.Builder builder()

Returns:

a CfnWorkflowProps.Builder of CfnWorkflowProps