Package software.amazon.awscdk.services.glue

Class CfnMLTransformProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • inputRecordTables

      @Stability(Stable) public CfnMLTransformProps.Builder inputRecordTables(IResolvable inputRecordTables)
      Sets the value of CfnMLTransformProps.getInputRecordTables()
      Parameters:
      inputRecordTables - A list of AWS Glue table definitions used by the transform. This parameter is required.
      Returns:
      this

    • inputRecordTables

      @Stability(Stable) public CfnMLTransformProps.Builder inputRecordTables(CfnMLTransform.InputRecordTablesProperty inputRecordTables)
      Sets the value of CfnMLTransformProps.getInputRecordTables()
      Parameters:
      inputRecordTables - A list of AWS Glue table definitions used by the transform. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public CfnMLTransformProps.Builder role(String role)
      Sets the value of CfnMLTransformProps.getRole()
      Parameters:
      role - The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. This parameter is required. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

      • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue . See Attach a Policy to IAM Users That Access AWS Glue .
      • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
      Returns:
      this

    • transformParameters

      @Stability(Stable) public CfnMLTransformProps.Builder transformParameters(IResolvable transformParameters)
      Sets the value of CfnMLTransformProps.getTransformParameters()
      Parameters:
      transformParameters - The algorithm-specific parameters that are associated with the machine learning transform. This parameter is required.
      Returns:
      this

    • transformParameters

      @Stability(Stable) public CfnMLTransformProps.Builder transformParameters(CfnMLTransform.TransformParametersProperty transformParameters)
      Sets the value of CfnMLTransformProps.getTransformParameters()
      Parameters:
      transformParameters - The algorithm-specific parameters that are associated with the machine learning transform. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnMLTransformProps.Builder description(String description)
      Sets the value of CfnMLTransformProps.getDescription()
      Parameters:
      description - A user-defined, long-form description text for the machine learning transform.
      Returns:
      this

    • glueVersion

      @Stability(Stable) public CfnMLTransformProps.Builder glueVersion(String glueVersion)
      Sets the value of CfnMLTransformProps.getGlueVersion()
      Parameters:
      glueVersion - This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.
      Returns:
      this

    • maxCapacity

      @Stability(Stable) public CfnMLTransformProps.Builder maxCapacity(Number maxCapacity)
      Sets the value of CfnMLTransformProps.getMaxCapacity()
      Parameters:
      maxCapacity - The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).
      • MaxCapacity and NumberOfWorkers must both be at least 1.

      When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.

      Returns:
      this

    • maxRetries

      @Stability(Stable) public CfnMLTransformProps.Builder maxRetries(Number maxRetries)
      Sets the value of CfnMLTransformProps.getMaxRetries()
      Parameters:
      maxRetries - The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
      Returns:
      this

    • name

      @Stability(Stable) public CfnMLTransformProps.Builder name(String name)
      Sets the value of CfnMLTransformProps.getName()
      Parameters:
      name - A user-defined name for the machine learning transform. Names are required to be unique. Name is optional:.
      • If you supply Name , the stack cannot be repeatedly created.
      • If Name is not provided, a randomly generated name will be used instead.
      Returns:
      this

    • numberOfWorkers

      @Stability(Stable) public CfnMLTransformProps.Builder numberOfWorkers(Number numberOfWorkers)
      Sets the value of CfnMLTransformProps.getNumberOfWorkers()
      Parameters:
      numberOfWorkers - The number of workers of a defined workerType that are allocated when a task of the transform runs. If WorkerType is set, then NumberOfWorkers is required (and vice versa).
      Returns:
      this

    • tags

      @Stability(Stable) public CfnMLTransformProps.Builder tags(Object tags)
      Sets the value of CfnMLTransformProps.getTags()
      Parameters:
      tags - The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue , see AWS Tags in AWS Glue in the developer guide.
      Returns:
      this

    • timeout

      @Stability(Stable) public CfnMLTransformProps.Builder timeout(Number timeout)
      Sets the value of CfnMLTransformProps.getTimeout()
      Parameters:
      timeout - The timeout in minutes of the machine learning transform.
      Returns:
      this

    • transformEncryption

      @Stability(Stable) public CfnMLTransformProps.Builder transformEncryption(IResolvable transformEncryption)
      Sets the value of CfnMLTransformProps.getTransformEncryption()
      Parameters:
      transformEncryption - The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

      Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.

      Returns:
      this

    • transformEncryption

      @Stability(Stable) public CfnMLTransformProps.Builder transformEncryption(CfnMLTransform.TransformEncryptionProperty transformEncryption)
      Sets the value of CfnMLTransformProps.getTransformEncryption()
      Parameters:
      transformEncryption - The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

      Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.

      Returns:
      this

    • workerType

      @Stability(Stable) public CfnMLTransformProps.Builder workerType(String workerType)
      Sets the value of CfnMLTransformProps.getWorkerType()
      Parameters:
      workerType - The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).
      • MaxCapacity and NumberOfWorkers must both be at least 1.
      Returns:
      this

    • build

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