Package software.amazon.awscdk.services.glue

Class CfnMLTransform

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.glue.CfnMLTransform
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.426Z") @Stability(Stable) public class CfnMLTransform extends CfnResource implements IInspectable
A CloudFormation AWS::Glue::MLTransform.

The AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object tags;
 CfnMLTransform cfnMLTransform = CfnMLTransform.Builder.create(this, "MyCfnMLTransform")
         .inputRecordTables(InputRecordTablesProperty.builder()
                 .glueTables(List.of(GlueTablesProperty.builder()
                         .databaseName("databaseName")
                         .tableName("tableName")
                         // the properties below are optional
                         .catalogId("catalogId")
                         .connectionName("connectionName")
                         .build()))
                 .build())
         .role("role")
         .transformParameters(TransformParametersProperty.builder()
                 .transformType("transformType")
                 // the properties below are optional
                 .findMatchesParameters(FindMatchesParametersProperty.builder()
                         .primaryKeyColumnName("primaryKeyColumnName")
                         // the properties below are optional
                         .accuracyCostTradeoff(123)
                         .enforceProvidedLabels(false)
                         .precisionRecallTradeoff(123)
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .glueVersion("glueVersion")
         .maxCapacity(123)
         .maxRetries(123)
         .name("name")
         .numberOfWorkers(123)
         .tags(tags)
         .timeout(123)
         .transformEncryption(TransformEncryptionProperty.builder()
                 .mlUserDataEncryption(MLUserDataEncryptionProperty.builder()
                         .mlUserDataEncryptionMode("mlUserDataEncryptionMode")
                         // the properties below are optional
                         .kmsKeyId("kmsKeyId")
                         .build())
                 .taskRunSecurityConfigurationName("taskRunSecurityConfigurationName")
                 .build())
         .workerType("workerType")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMLTransform

      protected CfnMLTransform(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMLTransform

      protected CfnMLTransform(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMLTransform

      @Stability(Stable) public CfnMLTransform(@NotNull Construct scope, @NotNull String id, @NotNull CfnMLTransformProps props)
      Create a new AWS::Glue::MLTransform.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      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.

    • getInputRecordTables

      @Stability(Stable) @NotNull public Object getInputRecordTables()
      A list of AWS Glue table definitions used by the transform.

    • setInputRecordTables

      @Stability(Stable) public void setInputRecordTables(@NotNull IResolvable value)
      A list of AWS Glue table definitions used by the transform.

    • setInputRecordTables

      @Stability(Stable) public void setInputRecordTables(@NotNull CfnMLTransform.InputRecordTablesProperty value)
      A list of AWS Glue table definitions used by the transform.

    • getRole

      @Stability(Stable) @NotNull public String getRole()
      The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

      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.

    • setRole

      @Stability(Stable) public void setRole(@NotNull String value)
      The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

      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.

    • getTransformParameters

      @Stability(Stable) @NotNull public Object getTransformParameters()
      The algorithm-specific parameters that are associated with the machine learning transform.

    • setTransformParameters

      @Stability(Stable) public void setTransformParameters(@NotNull IResolvable value)
      The algorithm-specific parameters that are associated with the machine learning transform.

    • setTransformParameters

      @Stability(Stable) public void setTransformParameters(@NotNull CfnMLTransform.TransformParametersProperty value)
      The algorithm-specific parameters that are associated with the machine learning transform.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A user-defined, long-form description text for the machine learning transform.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A user-defined, long-form description text for the machine learning transform.

    • getGlueVersion

      @Stability(Stable) @Nullable public String getGlueVersion()
      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.

    • setGlueVersion

      @Stability(Stable) public void setGlueVersion(@Nullable String value)
      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.

    • getMaxCapacity

      @Stability(Stable) @Nullable public Number getMaxCapacity()
      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.

    • setMaxCapacity

      @Stability(Stable) public void setMaxCapacity(@Nullable Number value)
      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.

    • getMaxRetries

      @Stability(Stable) @Nullable public Number getMaxRetries()
      The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.

    • setMaxRetries

      @Stability(Stable) public void setMaxRetries(@Nullable Number value)
      The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.

    • getName

      @Stability(Stable) @Nullable public String getName()
      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.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      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.

    • getNumberOfWorkers

      @Stability(Stable) @Nullable public Number getNumberOfWorkers()
      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).

    • setNumberOfWorkers

      @Stability(Stable) public void setNumberOfWorkers(@Nullable Number value)
      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).

    • getTimeout

      @Stability(Stable) @Nullable public Number getTimeout()
      The timeout in minutes of the machine learning transform.

    • setTimeout

      @Stability(Stable) public void setTimeout(@Nullable Number value)
      The timeout in minutes of the machine learning transform.

    • getTransformEncryption

      @Stability(Stable) @Nullable public Object getTransformEncryption()
      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.

    • setTransformEncryption

      @Stability(Stable) public void setTransformEncryption(@Nullable IResolvable value)
      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.

    • setTransformEncryption

      @Stability(Stable) public void setTransformEncryption(@Nullable CfnMLTransform.TransformEncryptionProperty value)
      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.

    • getWorkerType

      @Stability(Stable) @Nullable public String getWorkerType()
      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.

    • setWorkerType

      @Stability(Stable) public void setWorkerType(@Nullable String value)
      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.