Class CfnMLTransformMixinProps

Properties for CfnMLTransformPropsMixin.

Inheritance

object

CfnMLTransformMixinProps

Implements

ICfnMLTransformMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Glue.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnMLTransformMixinProps : ICfnMLTransformMixinProps

Syntax (vb)

Public Class CfnMLTransformMixinProps Implements ICfnMLTransformMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Glue.Mixins;

             var tags;

             var cfnMLTransformMixinProps = new CfnMLTransformMixinProps {
                 Description = "description",
                 GlueVersion = "glueVersion",
                 InputRecordTables = new InputRecordTablesProperty {
                     GlueTables = new [] { new GlueTablesProperty {
                         CatalogId = "catalogId",
                         ConnectionName = "connectionName",
                         DatabaseName = "databaseName",
                         TableName = "tableName"
                     } }
                 },
                 MaxCapacity = 123,
                 MaxRetries = 123,
                 Name = "name",
                 NumberOfWorkers = 123,
                 Role = "role",
                 Tags = tags,
                 Timeout = 123,
                 TransformEncryption = new TransformEncryptionProperty {
                     MlUserDataEncryption = new MLUserDataEncryptionProperty {
                         KmsKeyId = "kmsKeyId",
                         MlUserDataEncryptionMode = "mlUserDataEncryptionMode"
                     },
                     TaskRunSecurityConfigurationName = "taskRunSecurityConfigurationName"
                 },
                 TransformParameters = new TransformParametersProperty {
                     FindMatchesParameters = new FindMatchesParametersProperty {
                         AccuracyCostTradeoff = 123,
                         EnforceProvidedLabels = false,
                         PrecisionRecallTradeoff = 123,
                         PrimaryKeyColumnName = "primaryKeyColumnName"
                     },
                     TransformType = "transformType"
                 },
                 WorkerType = "workerType"
             };

Synopsis

Constructors

CfnMLTransformMixinProps()

Properties for CfnMLTransformPropsMixin.

Properties

Description	A user-defined, long-form description text for the machine learning transform.
GlueVersion	This value determines which version of AWS Glue this machine learning transform is compatible with.
InputRecordTables	A list of AWS Glue table definitions used by the transform.
MaxCapacity	The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
MaxRetries	The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
Name	A user-defined name for the machine learning transform. Names are required to be unique. Name is optional:.
NumberOfWorkers	The number of workers of a defined workerType that are allocated when a task of the transform runs.
Role	The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
Tags	The tags to use with this machine learning transform.
Timeout	The timeout in minutes of the machine learning transform.
TransformEncryption	The encryption-at-rest settings of the transform that apply to accessing user data.
TransformParameters	The algorithm-specific parameters that are associated with the machine learning transform.
WorkerType	The type of predefined worker that is allocated when a task of this transform runs.

Constructors

CfnMLTransformMixinProps()

Properties for CfnMLTransformPropsMixin.

public CfnMLTransformMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Glue.Mixins;

             var tags;

             var cfnMLTransformMixinProps = new CfnMLTransformMixinProps {
                 Description = "description",
                 GlueVersion = "glueVersion",
                 InputRecordTables = new InputRecordTablesProperty {
                     GlueTables = new [] { new GlueTablesProperty {
                         CatalogId = "catalogId",
                         ConnectionName = "connectionName",
                         DatabaseName = "databaseName",
                         TableName = "tableName"
                     } }
                 },
                 MaxCapacity = 123,
                 MaxRetries = 123,
                 Name = "name",
                 NumberOfWorkers = 123,
                 Role = "role",
                 Tags = tags,
                 Timeout = 123,
                 TransformEncryption = new TransformEncryptionProperty {
                     MlUserDataEncryption = new MLUserDataEncryptionProperty {
                         KmsKeyId = "kmsKeyId",
                         MlUserDataEncryptionMode = "mlUserDataEncryptionMode"
                     },
                     TaskRunSecurityConfigurationName = "taskRunSecurityConfigurationName"
                 },
                 TransformParameters = new TransformParametersProperty {
                     FindMatchesParameters = new FindMatchesParametersProperty {
                         AccuracyCostTradeoff = 123,
                         EnforceProvidedLabels = false,
                         PrecisionRecallTradeoff = 123,
                         PrimaryKeyColumnName = "primaryKeyColumnName"
                     },
                     TransformType = "transformType"
                 },
                 WorkerType = "workerType"
             };

Properties

Description

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

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-description

GlueVersion

This value determines which version of AWS Glue this machine learning transform is compatible with.

public string? GlueVersion { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-glueversion

InputRecordTables

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

public object? InputRecordTables { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-inputrecordtables

Type union: either IResolvable or CfnMLTransformPropsMixin.IInputRecordTablesProperty

MaxCapacity

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.

public double? MaxCapacity { get; set; }

Property Value

double?

Remarks

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 .

When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-maxcapacity

MaxRetries

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

public double? MaxRetries { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-maxretries

Name

A user-defined name for the machine learning transform. Names are required to be unique. Name is optional:.

public string? Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-name

NumberOfWorkers

The number of workers of a defined workerType that are allocated when a task of the transform runs.

public double? NumberOfWorkers { get; set; }

Property Value

double?

Remarks

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-numberofworkers

Role

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

public string? Role { get; set; }

Property Value

string

Remarks

The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-role

Tags

The tags to use with this machine learning transform.

public object? Tags { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-tags

Timeout

The timeout in minutes of the machine learning transform.

public double? Timeout { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-timeout

TransformEncryption

The encryption-at-rest settings of the transform that apply to accessing user data.

public object? TransformEncryption { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-transformencryption

Type union: either IResolvable or CfnMLTransformPropsMixin.ITransformEncryptionProperty

TransformParameters

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

public object? TransformParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-transformparameters

Type union: either IResolvable or CfnMLTransformPropsMixin.ITransformParametersProperty

WorkerType

The type of predefined worker that is allocated when a task of this transform runs.

public string? WorkerType { get; set; }

Property Value

string

Remarks

Accepts a value of Standard, G.1X, or G.2X.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-workertype

Implements

ICfnMLTransformMixinProps