Class Workflow.Builder

java.lang.Object
software.amazon.awscdk.services.imagebuilder.alpha.Workflow.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Workflow>
Enclosing class:
Workflow

@Stability(Experimental) public static final class Workflow.Builder extends Object implements software.amazon.jsii.Builder<Workflow>
(experimental) A fluent builder for Workflow.
  • Method Details

    • create

      @Stability(Experimental) public static Workflow.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Workflow.Builder.
    • data

      @Stability(Experimental) public Workflow.Builder data(WorkflowData data)
      (experimental) The workflow document content that defines the image creation process.

      Parameters:
      data - The workflow document content that defines the image creation process. This parameter is required.
      Returns:
      this
    • workflowType

      @Stability(Experimental) public Workflow.Builder workflowType(WorkflowType workflowType)
      (experimental) The phase in the image build process for which the workflow resource is responsible.

      Parameters:
      workflowType - The phase in the image build process for which the workflow resource is responsible. This parameter is required.
      Returns:
      this
    • changeDescription

      @Stability(Experimental) public Workflow.Builder changeDescription(String changeDescription)
      (experimental) The change description of the workflow.

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

      Default: None

      Parameters:
      changeDescription - The change description of the workflow. This parameter is required.
      Returns:
      this
    • description

      @Stability(Experimental) public Workflow.Builder description(String description)
      (experimental) The description of the workflow.

      Default: None

      Parameters:
      description - The description of the workflow. This parameter is required.
      Returns:
      this
    • kmsKey

      @Stability(Experimental) public Workflow.Builder kmsKey(IKey kmsKey)
      (experimental) The KMS key used to encrypt this workflow.

      Default: - an Image Builder owned key will be used to encrypt the workflow.

      Parameters:
      kmsKey - The KMS key used to encrypt this workflow. This parameter is required.
      Returns:
      this
    • tags

      @Stability(Experimental) public Workflow.Builder tags(Map<String,String> tags)
      (experimental) The tags to apply to the workflow.

      Default: None

      Parameters:
      tags - The tags to apply to the workflow. This parameter is required.
      Returns:
      this
    • workflowName

      @Stability(Experimental) public Workflow.Builder workflowName(String workflowName)
      (experimental) The name of the workflow.

      Default: - a name is generated

      Parameters:
      workflowName - The name of the workflow. This parameter is required.
      Returns:
      this
    • workflowVersion

      @Stability(Experimental) public Workflow.Builder workflowVersion(String workflowVersion)
      (experimental) The version of the workflow.

      Default: 1.0.0

      Parameters:
      workflowVersion - The version of the workflow. This parameter is required.
      Returns:
      this
    • build

      @Stability(Experimental) public Workflow build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Workflow>
      Returns:
      a newly built instance of Workflow.