Package software.amazon.awscdk.services.glue

Class CfnMLTransform

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnMLTransform
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:02.647Z") @Stability(Stable) public class CfnMLTransform extends CfnResource implements IInspectable, ITaggable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnMLTransformProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • 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.

    • setRole

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

    • 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.

    • setGlueVersion

      @Stability(Stable) public void setGlueVersion(@Nullable String value)
      This value determines which version of AWS Glue this machine learning transform is compatible with.

    • 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.

    • 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.

    • 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:.

    • 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:.

    • 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.

    • 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.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      The tags to use with this machine learning transform.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      The tags to use with this machine learning transform.

    • 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.

    • setTransformEncryption

      @Stability(Stable) public void setTransformEncryption(@Nullable IResolvable value)
      The encryption-at-rest settings of the transform that apply to accessing user data.

    • setTransformEncryption

      @Stability(Stable) public void setTransformEncryption(@Nullable CfnMLTransform.TransformEncryptionProperty value)
      The encryption-at-rest settings of the transform that apply to accessing user data.

    • getWorkerType

      @Stability(Stable) @Nullable public String getWorkerType()
      The type of predefined worker that is allocated when a task of this transform runs.

    • setWorkerType

      @Stability(Stable) public void setWorkerType(@Nullable String value)
      The type of predefined worker that is allocated when a task of this transform runs.