Package software.amazon.awscdk.services.imagebuilder

Class CfnWorkflowProps.Builder

java.lang.Object
software.amazon.awscdk.services.imagebuilder.CfnWorkflowProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWorkflowProps>
Enclosing interface:
CfnWorkflowProps
@Stability(Stable) public static final class CfnWorkflowProps.Builder extends Object implements software.amazon.jsii.Builder<CfnWorkflowProps>
A builder for CfnWorkflowProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public CfnWorkflowProps.Builder name(String name)
      Sets the value of CfnWorkflowProps.getName()
      Parameters:
      name - The name of the workflow to create. This parameter is required.
      Returns:
      this

    • type

      @Stability(Stable) public CfnWorkflowProps.Builder type(String type)
      Sets the value of CfnWorkflowProps.getType()
      Parameters:
      type - The phase in the image build process for which the workflow resource is responsible. This parameter is required.
      Returns:
      this

    • version

      @Stability(Stable) public CfnWorkflowProps.Builder version(String version)
      Sets the value of CfnWorkflowProps.getVersion()
      Parameters:
      version - The semantic version of this workflow resource. The semantic version syntax adheres to the following rules. This parameter is required.

      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.

      Returns:
      this

    • changeDescription

      @Stability(Stable) public CfnWorkflowProps.Builder changeDescription(String changeDescription)
      Sets the value of CfnWorkflowProps.getChangeDescription()
      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.
      Returns:
      this

    • data

      @Stability(Stable) public CfnWorkflowProps.Builder data(String data)
      Sets the value of CfnWorkflowProps.getData()
      Parameters:
      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.
      Returns:
      this

    • description

      @Stability(Stable) public CfnWorkflowProps.Builder description(String description)
      Sets the value of CfnWorkflowProps.getDescription()
      Parameters:
      description - Describes the workflow.
      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnWorkflowProps.Builder kmsKeyId(String kmsKeyId)
      Sets the value of CfnWorkflowProps.getKmsKeyId()
      Parameters:
      kmsKeyId - The ID of the KMS key that is used to encrypt this workflow resource.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnWorkflowProps.Builder tags(Map<String,String> tags)
      Sets the value of CfnWorkflowProps.getTags()
      Parameters:
      tags - Tags that apply to the workflow resource.
      Returns:
      this

    • uri

      @Stability(Stable) public CfnWorkflowProps.Builder uri(String uri)
      Sets the value of CfnWorkflowProps.getUri()
      Parameters:
      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.

      Returns:
      this

    • build

      @Stability(Stable) public CfnWorkflowProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnWorkflowProps>
      Returns:
      a new instance of CfnWorkflowProps
      Throws:
      NullPointerException - if any required attribute was not provided