software.amazon.awscdk.services.glue

Interface CfnMLTransformProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMLTransformProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.563Z")
 @Stability(value=Stable)
public interface CfnMLTransformProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnMLTransform`.

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;
 CfnMLTransformProps cfnMLTransformProps = CfnMLTransformProps.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnMLTransformProps.Builder A builder for CfnMLTransformProps
static class	CfnMLTransformProps.Jsii$Proxy An implementation for CfnMLTransformProps

Method Summary

Modifier and Type	Method and Description
static CfnMLTransformProps.Builder	builder()
default String	getDescription() A user-defined, long-form description text for the machine learning transform.
default String	getGlueVersion() This value determines which version of AWS Glue this machine learning transform is compatible with.
Object	getInputRecordTables() A list of AWS Glue table definitions used by the transform.
default Number	getMaxCapacity() The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
default Number	getMaxRetries() The maximum number of times to retry after an `MLTaskRun` of the machine learning transform fails.
default String	getName() A user-defined name for the machine learning transform.
default Number	getNumberOfWorkers() The number of workers of a defined `workerType` that are allocated when a task of the transform runs.
String	getRole() The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
default Object	getTags() The tags to use with this machine learning transform.
default Number	getTimeout() The timeout in minutes of the machine learning transform.
default Object	getTransformEncryption() The encryption-at-rest settings of the transform that apply to accessing user data.
Object	getTransformParameters() The algorithm-specific parameters that are associated with the machine learning transform.
default String	getWorkerType() The type of predefined worker that is allocated when a task of this transform runs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInputRecordTables

@Stability(value=Stable)
 @NotNull
Object getInputRecordTables()

A list of AWS Glue table definitions used by the transform.

getRole

@Stability(value=Stable)
 @NotNull
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.

getTransformParameters

@Stability(value=Stable)
 @NotNull
Object getTransformParameters()

The algorithm-specific parameters that are associated with the machine learning transform.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A user-defined, long-form description text for the machine learning transform.

getGlueVersion

@Stability(value=Stable)
 @Nullable
default 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.

getMaxCapacity

@Stability(value=Stable)
 @Nullable
default 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.

getMaxRetries

@Stability(value=Stable)
 @Nullable
default Number getMaxRetries()

The maximum number of times to retry after an `MLTaskRun` of the machine learning transform fails.

getName

@Stability(value=Stable)
 @Nullable
default 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.

getNumberOfWorkers

@Stability(value=Stable)
 @Nullable
default 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).

getTags

@Stability(value=Stable)
 @Nullable
default Object 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.

getTimeout

@Stability(value=Stable)
 @Nullable
default Number getTimeout()

The timeout in minutes of the machine learning transform.

getTransformEncryption

@Stability(value=Stable)
 @Nullable
default 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.

getWorkerType

@Stability(value=Stable)
 @Nullable
default 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.

builder

@Stability(value=Stable)
static CfnMLTransformProps.Builder builder()

Returns:

a CfnMLTransformProps.Builder of CfnMLTransformProps