Interface CreateWorkflowRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>, ImagebuilderRequest.Builder, SdkBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateWorkflowRequest
@Mutable @NotThreadSafe public static interface CreateWorkflowRequest.Builder extends ImagebuilderRequest.Builder, SdkPojo, CopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>

  • Method Details

    • name

      CreateWorkflowRequest.Builder name(String name)

      The name of the workflow to create. Image Builder generates the workflow ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a workflow with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the workflow already exists.

      Parameters:
      name - The name of the workflow to create. Image Builder generates the workflow ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a workflow with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the workflow already exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • semanticVersion

      CreateWorkflowRequest.Builder semanticVersion(String semanticVersion)

      The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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:
      semanticVersion - The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateWorkflowRequest.Builder description(String description)

      Describes the workflow.

      Parameters:
      description - Describes the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changeDescription

      CreateWorkflowRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • data

      CreateWorkflowRequest.Builder data(String data)

      The UTF-8 encoded YAML document content for the workflow, up to 16,000 characters. For larger documents, store the document in Amazon S3 and specify the uri property instead. You must specify exactly one of the data or uri properties.

      Parameters:
      data - The UTF-8 encoded YAML document content for the workflow, up to 16,000 characters. For larger documents, store the document in Amazon S3 and specify the uri property instead. You must specify exactly one of the data or uri properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uri

      CreateWorkflowRequest.Builder uri(String uri)

      The uri of a YAML workflow document file stored in Amazon S3. This must be an S3 URL ( s3://bucket/key), and you must have permission to access the S3 bucket it points to. A workflow document that you provide from Amazon S3 can be up to your service quota for workflow size.

      Alternatively, you can specify the YAML document inline, using the workflow data property. You must specify exactly one of the data or uri properties.

      Parameters:
      uri - The uri of a YAML workflow document file stored in Amazon S3. This must be an S3 URL ( s3://bucket/key), and you must have permission to access the S3 bucket it points to. A workflow document that you provide from Amazon S3 can be up to your service quota for workflow size.

      Alternatively, you can specify the YAML document inline, using the workflow data property. You must specify exactly one of the data or uri properties.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateWorkflowRequest.Builder kmsKeyId(String kmsKeyId)

      The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the workflow document with a KMS key that Image Builder owns.

      Parameters:
      kmsKeyId - The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the workflow document with a KMS key that Image Builder owns.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateWorkflowRequest.Builder tags(Map<String,String> tags)

      Tags that apply to the workflow resource.

      Parameters:
      tags - Tags that apply to the workflow resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateWorkflowRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      CreateWorkflowRequest.Builder type(String type)

      The image creation stage that this workflow applies to. Image Builder validates the workflow document steps against the stage you specify.

      Parameters:
      type - The image creation stage that this workflow applies to. Image Builder validates the workflow document steps against the stage you specify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateWorkflowRequest.Builder type(WorkflowType type)

      The image creation stage that this workflow applies to. Image Builder validates the workflow document steps against the stage you specify.

      Parameters:
      type - The image creation stage that this workflow applies to. Image Builder validates the workflow document steps against the stage you specify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      CreateWorkflowRequest.Builder dryRun(Boolean dryRun)

      Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

      Parameters:
      dryRun - Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateWorkflowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateWorkflowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.