Interface CreateWorkflowRequest.Builder

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

  • Method Details

    • name

      CreateWorkflowRequest.Builder name(String name)

      The name of the workflow. You must use unique workflow names within your Amazon Web Services account. The service generates a unique identifier that is appended to ensure temporal uniqueness across the account lifecycle.

      Parameters:
      name - The name of the workflow. You must use unique workflow names within your Amazon Web Services account. The service generates a unique identifier that is appended to ensure temporal uniqueness across the account lifecycle.
      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 that you provide to ensure the idempotency of the request. This token prevents duplicate workflow creation requests.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow creation requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definitionS3Location

      CreateWorkflowRequest.Builder definitionS3Location(DefinitionS3Location definitionS3Location)

      The Amazon S3 location where the workflow definition file is stored. This must point to a valid YAML file that defines the workflow structure using supported Amazon Web Services operators and tasks. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition at creation time, so subsequent changes to the Amazon S3 object will not affect the workflow unless you create a new version. In your YAML definition, include task dependencies, scheduling information, and operator configurations that are compatible with the Amazon Managed Workflows for Apache Airflow Serverless execution environment.

      Parameters:
      definitionS3Location - The Amazon S3 location where the workflow definition file is stored. This must point to a valid YAML file that defines the workflow structure using supported Amazon Web Services operators and tasks. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition at creation time, so subsequent changes to the Amazon S3 object will not affect the workflow unless you create a new version. In your YAML definition, include task dependencies, scheduling information, and operator configurations that are compatible with the Amazon Managed Workflows for Apache Airflow Serverless execution environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definitionS3Location

      default CreateWorkflowRequest.Builder definitionS3Location(Consumer<DefinitionS3Location.Builder> definitionS3Location)

      The Amazon S3 location where the workflow definition file is stored. This must point to a valid YAML file that defines the workflow structure using supported Amazon Web Services operators and tasks. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition at creation time, so subsequent changes to the Amazon S3 object will not affect the workflow unless you create a new version. In your YAML definition, include task dependencies, scheduling information, and operator configurations that are compatible with the Amazon Managed Workflows for Apache Airflow Serverless execution environment.

      This is a convenience method that creates an instance of the DefinitionS3Location.Builder avoiding the need to create one manually via DefinitionS3Location.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definitionS3Location(DefinitionS3Location).

      Parameters:
      definitionS3Location - a consumer that will call methods on DefinitionS3Location.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      CreateWorkflowRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when executing the workflow. This role must have the necessary permissions to access the required Amazon Web Services services and resources that your workflow tasks will interact with. The role is used for task execution in the isolated, multi-tenant environment and should follow the principle of least privilege. Amazon Managed Workflows for Apache Airflow Serverless validates role access during workflow creation but runtime permission checks are performed by the target services.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when executing the workflow. This role must have the necessary permissions to access the required Amazon Web Services services and resources that your workflow tasks will interact with. The role is used for task execution in the isolated, multi-tenant environment and should follow the principle of least privilege. Amazon Managed Workflows for Apache Airflow Serverless validates role access during workflow creation but runtime permission checks are performed by the target services.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateWorkflowRequest.Builder description(String description)

      An optional description of the workflow that you can use to provide additional context about the workflow's purpose and functionality.

      Parameters:
      description - An optional description of the workflow that you can use to provide additional context about the workflow's purpose and functionality.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

      CreateWorkflowRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

      The configuration for encrypting workflow data at rest and in transit. Specifies the encryption type and optional KMS key for customer-managed encryption.

      Parameters:
      encryptionConfiguration - The configuration for encrypting workflow data at rest and in transit. Specifies the encryption type and optional KMS key for customer-managed encryption.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

      default CreateWorkflowRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

      The configuration for encrypting workflow data at rest and in transit. Specifies the encryption type and optional KMS key for customer-managed encryption.

      This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

      Parameters:
      encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loggingConfiguration

      CreateWorkflowRequest.Builder loggingConfiguration(LoggingConfiguration loggingConfiguration)

      The configuration for workflow logging. Specifies the CloudWatch log group where workflow execution logs are stored. Amazon Managed Workflows for Apache Airflow Serverless automatically exports worker logs and task-level information to the specified log group in your account using remote logging functionality. This provides comprehensive observability for debugging and monitoring workflow execution across the distributed, serverless environment.

      Parameters:
      loggingConfiguration - The configuration for workflow logging. Specifies the CloudWatch log group where workflow execution logs are stored. Amazon Managed Workflows for Apache Airflow Serverless automatically exports worker logs and task-level information to the specified log group in your account using remote logging functionality. This provides comprehensive observability for debugging and monitoring workflow execution across the distributed, serverless environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      default CreateWorkflowRequest.Builder loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration)

      The configuration for workflow logging. Specifies the CloudWatch log group where workflow execution logs are stored. Amazon Managed Workflows for Apache Airflow Serverless automatically exports worker logs and task-level information to the specified log group in your account using remote logging functionality. This provides comprehensive observability for debugging and monitoring workflow execution across the distributed, serverless environment.

      This is a convenience method that creates an instance of the LoggingConfiguration.Builder avoiding the need to create one manually via LoggingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfiguration(LoggingConfiguration).

      Parameters:
      loggingConfiguration - a consumer that will call methods on LoggingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • engineVersion

      CreateWorkflowRequest.Builder engineVersion(Integer engineVersion)

      The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for this workflow. This determines the feature set, supported operators, and execution environment capabilities available to your workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains backward compatibility across versions while introducing new features and improvements. Currently supports version 1 with plans for additional versions as the service evolves.

      Parameters:
      engineVersion - The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for this workflow. This determines the feature set, supported operators, and execution environment capabilities available to your workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains backward compatibility across versions while introducing new features and improvements. Currently supports version 1 with plans for additional versions as the service evolves.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

      CreateWorkflowRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

      Network configuration for the workflow execution environment, including VPC security groups and subnets for secure network access. When specified, Amazon Managed Workflows for Apache Airflow Serverless deploys ECS worker tasks in your customer VPC to provide secure connectivity to your resources. If not specified, tasks run in the service's default worker VPC with network isolation from other customers. This configuration enables secure access to VPC-only resources like RDS databases or private endpoints.

      Parameters:
      networkConfiguration - Network configuration for the workflow execution environment, including VPC security groups and subnets for secure network access. When specified, Amazon Managed Workflows for Apache Airflow Serverless deploys ECS worker tasks in your customer VPC to provide secure connectivity to your resources. If not specified, tasks run in the service's default worker VPC with network isolation from other customers. This configuration enables secure access to VPC-only resources like RDS databases or private endpoints.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

      default CreateWorkflowRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)

      Network configuration for the workflow execution environment, including VPC security groups and subnets for secure network access. When specified, Amazon Managed Workflows for Apache Airflow Serverless deploys ECS worker tasks in your customer VPC to provide secure connectivity to your resources. If not specified, tasks run in the service's default worker VPC with network isolation from other customers. This configuration enables secure access to VPC-only resources like RDS databases or private endpoints.

      This is a convenience method that creates an instance of the NetworkConfiguration.Builder avoiding the need to create one manually via NetworkConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).

      Parameters:
      networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

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

      A map of tags to assign to the workflow resource. Tags are key-value pairs that are used for resource organization and cost allocation.

      Parameters:
      tags - A map of tags to assign to the workflow resource. Tags are key-value pairs that are used for resource organization and cost allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerMode

      CreateWorkflowRequest.Builder triggerMode(String triggerMode)

      The trigger mode for the workflow execution.

      Parameters:
      triggerMode - The trigger mode for the workflow execution.
      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.