@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:31.205Z") public class CfnMLTransform extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnMLTransform.Builder
A fluent builder for
CfnMLTransform . |
static interface |
CfnMLTransform.FindMatchesParametersProperty
The parameters to configure the find matches transform.
|
static interface |
CfnMLTransform.GlueTablesProperty
The database and table in the AWS Glue Data Catalog that is used for input or output data.
|
static interface |
CfnMLTransform.InputRecordTablesProperty
A list of AWS Glue table definitions used by the transform.
|
static interface |
CfnMLTransform.MLUserDataEncryptionProperty
The encryption-at-rest settings of the transform that apply to accessing user data.
|
static interface |
CfnMLTransform.TransformEncryptionProperty
The encryption-at-rest settings of the transform that apply to accessing user data.
|
static interface |
CfnMLTransform.TransformParametersProperty
The algorithm-specific parameters that are associated with the machine learning transform.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnMLTransform(Construct scope,
java.lang.String id,
CfnMLTransformProps props)
Create a new `AWS::Glue::MLTransform`.
|
protected |
CfnMLTransform(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnMLTransform(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A user-defined, long-form description text for the machine learning transform.
|
java.lang.String |
getGlueVersion()
This value determines which version of AWS Glue this machine learning transform is compatible with.
|
java.lang.Object |
getInputRecordTables()
A list of AWS Glue table definitions used by the transform.
|
java.lang.Number |
getMaxCapacity()
The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
|
java.lang.Number |
getMaxRetries()
The maximum number of times to retry after an `MLTaskRun` of the machine learning transform fails.
|
java.lang.String |
getName()
A user-defined name for the machine learning transform.
|
java.lang.Number |
getNumberOfWorkers()
The number of workers of a defined `workerType` that are allocated when a task of the transform runs.
|
java.lang.String |
getRole()
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
|
TagManager |
getTags()
The tags to use with this machine learning transform.
|
java.lang.Number |
getTimeout()
The timeout in minutes of the machine learning transform.
|
java.lang.Object |
getTransformEncryption()
The encryption-at-rest settings of the transform that apply to accessing user data.
|
java.lang.Object |
getTransformParameters()
The algorithm-specific parameters that are associated with the machine learning transform.
|
java.lang.String |
getWorkerType()
The type of predefined worker that is allocated when a task of this transform runs.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.String value)
A user-defined, long-form description text for the machine learning transform.
|
void |
setGlueVersion(java.lang.String value)
This value determines which version of AWS Glue this machine learning transform is compatible with.
|
void |
setInputRecordTables(CfnMLTransform.InputRecordTablesProperty value)
A list of AWS Glue table definitions used by the transform.
|
void |
setInputRecordTables(IResolvable value)
A list of AWS Glue table definitions used by the transform.
|
void |
setMaxCapacity(java.lang.Number value)
The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
|
void |
setMaxRetries(java.lang.Number value)
The maximum number of times to retry after an `MLTaskRun` of the machine learning transform fails.
|
void |
setName(java.lang.String value)
A user-defined name for the machine learning transform.
|
void |
setNumberOfWorkers(java.lang.Number value)
The number of workers of a defined `workerType` that are allocated when a task of the transform runs.
|
void |
setRole(java.lang.String value)
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
|
void |
setTimeout(java.lang.Number value)
The timeout in minutes of the machine learning transform.
|
void |
setTransformEncryption(CfnMLTransform.TransformEncryptionProperty value)
The encryption-at-rest settings of the transform that apply to accessing user data.
|
void |
setTransformEncryption(IResolvable value)
The encryption-at-rest settings of the transform that apply to accessing user data.
|
void |
setTransformParameters(CfnMLTransform.TransformParametersProperty value)
The algorithm-specific parameters that are associated with the machine learning transform.
|
void |
setTransformParameters(IResolvable value)
The algorithm-specific parameters that are associated with the machine learning transform.
|
void |
setWorkerType(java.lang.String value)
The type of predefined worker that is allocated when a task of this transform runs.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnMLTransform(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnMLTransform(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnMLTransform(Construct scope, java.lang.String id, CfnMLTransformProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager 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.
public java.lang.Object getInputRecordTables()
public void setInputRecordTables(IResolvable value)
public void setInputRecordTables(CfnMLTransform.InputRecordTablesProperty value)
public java.lang.String getRole()
The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.
public void setRole(java.lang.String value)
The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.
public java.lang.Object getTransformParameters()
public void setTransformParameters(IResolvable value)
public void setTransformParameters(CfnMLTransform.TransformParametersProperty value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.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.
public void setGlueVersion(java.lang.String value)
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.
public java.lang.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.
public void setMaxCapacity(java.lang.Number value)
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.
public java.lang.Number getMaxRetries()
public void setMaxRetries(java.lang.Number value)
public java.lang.String getName()
Name
, the stack cannot be repeatedly created.Name
is not provided, a randomly generated name will be used instead.public void setName(java.lang.String value)
Name
, the stack cannot be repeatedly created.Name
is not provided, a randomly generated name will be used instead.public java.lang.Number getNumberOfWorkers()
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
public void setNumberOfWorkers(java.lang.Number value)
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
public java.lang.Number getTimeout()
public void setTimeout(java.lang.Number value)
public java.lang.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.
public void setTransformEncryption(IResolvable value)
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.
public void setTransformEncryption(CfnMLTransform.TransformEncryptionProperty value)
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.
public java.lang.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.public void setWorkerType(java.lang.String value)
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.