This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).
# AWS::Glue::MLTransform
The AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms.
## Syntax
To declare this entity in your CloudFormation template, use the following syntax:
### JSON
```
{
"Type" : "AWS::Glue::MLTransform",
"Properties" : {
"[Description](#cfn-glue-mltransform-description)" : String,
"[GlueVersion](#cfn-glue-mltransform-glueversion)" : String,
"[InputRecordTables](#cfn-glue-mltransform-inputrecordtables)" : InputRecordTables,
"[MaxCapacity](#cfn-glue-mltransform-maxcapacity)" : Number,
"[MaxRetries](#cfn-glue-mltransform-maxretries)" : Integer,
"[Name](#cfn-glue-mltransform-name)" : String,
"[NumberOfWorkers](#cfn-glue-mltransform-numberofworkers)" : Integer,
"[Role](#cfn-glue-mltransform-role)" : String,
"[Tags](#cfn-glue-mltransform-tags)" : [ [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html), ... ],
"[Timeout](#cfn-glue-mltransform-timeout)" : Integer,
"[TransformEncryption](#cfn-glue-mltransform-transformencryption)" : TransformEncryption,
"[TransformParameters](#cfn-glue-mltransform-transformparameters)" : TransformParameters,
"[WorkerType](#cfn-glue-mltransform-workertype)" : String
}
}
```
### YAML
```
Type: AWS::Glue::MLTransform
Properties:
[Description](#cfn-glue-mltransform-description): String
[GlueVersion](#cfn-glue-mltransform-glueversion): String
[InputRecordTables](#cfn-glue-mltransform-inputrecordtables):
InputRecordTables
[MaxCapacity](#cfn-glue-mltransform-maxcapacity): Number
[MaxRetries](#cfn-glue-mltransform-maxretries): Integer
[Name](#cfn-glue-mltransform-name): String
[NumberOfWorkers](#cfn-glue-mltransform-numberofworkers): Integer
[Role](#cfn-glue-mltransform-role): String
[Tags](#cfn-glue-mltransform-tags):
- [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)
[Timeout](#cfn-glue-mltransform-timeout): Integer
[TransformEncryption](#cfn-glue-mltransform-transformencryption):
TransformEncryption
[TransformParameters](#cfn-glue-mltransform-transformparameters):
TransformParameters
[WorkerType](#cfn-glue-mltransform-workertype): String
```
## Properties
`Description`
A user-defined, long-form description text for the machine learning transform.
*Required*: No
*Type*: String
*Pattern*: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`
*Minimum*: `0`
*Maximum*: `2048`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`GlueVersion`
This value determines which version of AWS Glue this machine learning transform is compatible with. 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](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) in the developer guide.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`InputRecordTables`
A list of AWS Glue table definitions used by the transform.
*Required*: Yes
*Type*: [InputRecordTables](aws-properties-glue-mltransform-inputrecordtables.md)
*Minimum*: `0`
*Maximum*: `10`
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`MaxCapacity`
The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. 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](https://aws.amazon.com/glue/pricing/).
`MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and `WorkerType`.
+ If either `NumberOfWorkers` or `WorkerType` is set, then `MaxCapacity` cannot be set.
+ If `MaxCapacity` is set then neither `NumberOfWorkers` or `WorkerType` can be set.
+ If `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.
*Required*: No
*Type*: Number
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`MaxRetries`
The maximum number of times to retry after an `MLTaskRun` of the machine learning transform fails.
*Required*: No
*Type*: Integer
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Name`
A user-defined name for the machine learning transform. Names are required to be unique. `Name` is optional:
+ If you supply `Name`, the stack cannot be repeatedly created.
+ If `Name` is not provided, a randomly generated name will be used instead.
*Required*: No
*Type*: String
*Pattern*: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`
*Minimum*: `1`
*Maximum*: `255`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`NumberOfWorkers`
The number of workers of a defined `workerType` that are allocated when a task of the transform runs.
If `WorkerType` is set, then `NumberOfWorkers` is required (and vice versa).
*Required*: No
*Type*: Integer
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Role`
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.
+ This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See [Attach a Policy to IAM Users That Access AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html).
+ This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
*Required*: Yes
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Tags`
The tags to use with this machine learning transform. 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](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the developer guide.
*Required*: No
*Type*: Array of [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Timeout`
The timeout in minutes of the machine learning transform.
*Required*: No
*Type*: Integer
*Minimum*: `1`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`TransformEncryption`
The encryption-at-rest settings of the transform that apply to accessing user data. 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.
*Required*: No
*Type*: [TransformEncryption](aws-properties-glue-mltransform-transformencryption.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`TransformParameters`
The algorithm-specific parameters that are associated with the machine learning transform.
*Required*: Yes
*Type*: [TransformParameters](aws-properties-glue-mltransform-transformparameters.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`WorkerType`
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
+ For the `Standard` worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
+ For the `G.1X` worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
+ For the `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`.
+ If either `NumberOfWorkers` or `WorkerType` is set, then `MaxCapacity` cannot be set.
+ If `MaxCapacity` is set then neither `NumberOfWorkers` or `WorkerType` can be set.
+ If `WorkerType` is set, then `NumberOfWorkers` is required (and vice versa).
+ `MaxCapacity` and `NumberOfWorkers` must both be at least 1.
*Required*: No
*Type*: String
*Allowed values*: `Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2X`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
## Return values
### Ref
When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the transform ID.
For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).
### Fn::GetAtt