@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
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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnMLTransformProps.Builder
A builder for
CfnMLTransformProps |
static class |
CfnMLTransformProps.Jsii$Proxy
An implementation for
CfnMLTransformProps |
| 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.
|
@Stability(value=Stable) @NotNull Object getInputRecordTables()
@Stability(value=Stable) @NotNull String getRole()
The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.
@Stability(value=Stable) @NotNull Object getTransformParameters()
@Stability(value=Stable) @Nullable default String getDescription()
@Stability(value=Stable) @Nullable default String getGlueVersion()
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.
@Stability(value=Stable) @Nullable default Number getMaxCapacity()
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 .
NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.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.
@Stability(value=Stable) @Nullable default Number getMaxRetries()
@Stability(value=Stable) @Nullable default String getName()
Name , the stack cannot be repeatedly created.Name is not provided, a randomly generated name will be used instead.@Stability(value=Stable) @Nullable default Number getNumberOfWorkers()
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
@Stability(value=Stable) @Nullable default Object getTags()
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.
@Stability(value=Stable) @Nullable default Number getTimeout()
@Stability(value=Stable) @Nullable default Object getTransformEncryption()
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.
@Stability(value=Stable) @Nullable default String getWorkerType()
Accepts a value of Standard, G.1X, or G.2X.
Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.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 .
NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.WorkerType is set, then NumberOfWorkers is required (and vice versa).MaxCapacity and NumberOfWorkers must both be at least 1.@Stability(value=Stable) static CfnMLTransformProps.Builder builder()
CfnMLTransformProps.Builder of CfnMLTransformPropsCopyright © 2022. All rights reserved.