Class CfnMLTransform
A CloudFormation AWS::Glue::MLTransform.
Inherited Members
Namespace: Amazon.CDK.AWS.Glue
Assembly: Amazon.CDK.AWS.Glue.dll
Syntax (csharp)
public class CfnMLTransform : CfnResource, IConstruct, IConstruct, IDependable, IInspectableSyntax (vb)
Public Class CfnMLTransform
Inherits CfnResource
Implements IConstruct, IConstruct, IDependable, IInspectableRemarks
The AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms.
CloudformationResource: AWS::Glue::MLTransform
Link: 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.AWS.Glue;
var tags;
CfnMLTransform cfnMLTransform = new CfnMLTransform(this, "MyCfnMLTransform", new CfnMLTransformProps {
InputRecordTables = new InputRecordTablesProperty {
GlueTables = new [] { new GlueTablesProperty {
DatabaseName = "databaseName",
TableName = "tableName",
// the properties below are optional
CatalogId = "catalogId",
ConnectionName = "connectionName"
} }
},
Role = "role",
TransformParameters = new TransformParametersProperty {
TransformType = "transformType",
// the properties below are optional
FindMatchesParameters = new FindMatchesParametersProperty {
PrimaryKeyColumnName = "primaryKeyColumnName",
// the properties below are optional
AccuracyCostTradeoff = 123,
EnforceProvidedLabels = false,
PrecisionRecallTradeoff = 123
}
},
// the properties below are optional
Description = "description",
GlueVersion = "glueVersion",
MaxCapacity = 123,
MaxRetries = 123,
Name = "name",
NumberOfWorkers = 123,
Tags = tags,
Timeout = 123,
TransformEncryption = new TransformEncryptionProperty {
MlUserDataEncryption = new MLUserDataEncryptionProperty {
MlUserDataEncryptionMode = "mlUserDataEncryptionMode",
// the properties below are optional
KmsKeyId = "kmsKeyId"
},
TaskRunSecurityConfigurationName = "taskRunSecurityConfigurationName"
},
WorkerType = "workerType"
});Synopsis
Constructors
| CfnMLTransform(Construct, String, ICfnMLTransformProps) | Create a new |
| CfnMLTransform(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| CfnMLTransform(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | |
| 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 |
| Name | A user-defined name for the machine learning transform. Names are required to be unique. |
| NumberOfWorkers | The number of workers of a defined |
| 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. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMLTransform(Construct, String, ICfnMLTransformProps)
Create a new AWS::Glue::MLTransform.
public CfnMLTransform(Construct scope, string id, ICfnMLTransformProps props)Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnMLTransformProps
- resource properties.
CfnMLTransform(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMLTransform(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMLTransform(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMLTransform(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A user-defined, long-form description text for the machine learning transform.
public virtual string Description { get; set; }Property Value
System.String
Remarks
GlueVersion
This value determines which version of AWS Glue this machine learning transform is compatible with.
public virtual string GlueVersion { get; set; }Property Value
System.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.
InputRecordTables
A list of AWS Glue table definitions used by the transform.
public virtual object InputRecordTables { get; set; }Property Value
System.Object
Remarks
MaxCapacity
The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
public virtual Nullable<double> MaxCapacity { get; set; }Property Value
System.Nullable<System.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.
MaxRetries
The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
public virtual Nullable<double> MaxRetries { get; set; }Property Value
System.Nullable<System.Double>
Remarks
Name
A user-defined name for the machine learning transform. Names are required to be unique. Name is optional:.
public virtual string Name { get; set; }Property Value
System.String
Remarks
NumberOfWorkers
The number of workers of a defined workerType that are allocated when a task of the transform runs.
public virtual Nullable<double> NumberOfWorkers { get; set; }Property Value
System.Nullable<System.Double>
Remarks
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
Role
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
public virtual string Role { get; set; }Property Value
System.String
Remarks
The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.
Tags
The tags to use with this machine learning transform.
public virtual TagManager Tags { get; }Property Value
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.
Timeout
The timeout in minutes of the machine learning transform.
public virtual Nullable<double> Timeout { get; set; }Property Value
System.Nullable<System.Double>
Remarks
TransformEncryption
The encryption-at-rest settings of the transform that apply to accessing user data.
public virtual object TransformEncryption { get; set; }Property Value
System.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.
TransformParameters
The algorithm-specific parameters that are associated with the machine learning transform.
public virtual object TransformParameters { get; set; }Property Value
System.Object
Remarks
WorkerType
The type of predefined worker that is allocated when a task of this transform runs.
public virtual string WorkerType { get; set; }Property Value
System.String
Remarks
Accepts a value of Standard, G.1X, or G.2X.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>