class CfnMLTransform (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Glue.CfnMLTransform |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnMLTransform |
![]() | software.amazon.awscdk.services.glue.CfnMLTransform |
![]() | aws_cdk.aws_glue.CfnMLTransform |
![]() | aws-cdk-lib » aws_glue » CfnMLTransform |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
The AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';
declare const tags: any;
const cfnMLTransform = new glue.CfnMLTransform(this, 'MyCfnMLTransform', {
inputRecordTables: {
glueTables: [{
databaseName: 'databaseName',
tableName: 'tableName',
// the properties below are optional
catalogId: 'catalogId',
connectionName: 'connectionName',
}],
},
role: 'role',
transformParameters: {
transformType: 'transformType',
// the properties below are optional
findMatchesParameters: {
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: {
mlUserDataEncryption: {
mlUserDataEncryptionMode: 'mlUserDataEncryptionMode',
// the properties below are optional
kmsKeyId: 'kmsKeyId',
},
taskRunSecurityConfigurationName: 'taskRunSecurityConfigurationName',
},
workerType: 'workerType',
});
Initializer
new CfnMLTransform(scope: Construct, id: string, props: CfnMLTransformProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.MLTransform Props
Construct Props
Name | Type | Description |
---|---|---|
input | IResolvable | Input | A list of AWS Glue table definitions used by the transform. |
role | string | The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. |
transform | IResolvable | Transform | The algorithm-specific parameters that are associated with the machine learning transform. |
description? | string | A user-defined, long-form description text for the machine learning transform. |
glue | string | This value determines which version of AWS Glue this machine learning transform is compatible with. |
max | number | The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. |
max | number | The maximum number of times to retry after an MLTaskRun of the machine learning transform fails. |
name? | string | A user-defined name for the machine learning transform. Names are required to be unique. Name is optional:. |
number | number | The number of workers of a defined workerType that are allocated when a task of the transform runs. |
tags? | any | The tags to use with this machine learning transform. |
timeout? | number | The timeout in minutes of the machine learning transform. |
transform | IResolvable | Transform | The encryption-at-rest settings of the transform that apply to accessing user data. |
worker | string | The type of predefined worker that is allocated when a task of this transform runs. |
inputRecordTables
Type:
IResolvable
|
Input
A list of AWS Glue table definitions used by the transform.
role
Type:
string
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 .
- 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.
transformParameters
Type:
IResolvable
|
Transform
The algorithm-specific parameters that are associated with the machine learning transform.
description?
Type:
string
(optional)
A user-defined, long-form description text for the machine learning transform.
glueVersion?
Type:
string
(optional)
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 in the developer guide.
maxCapacity?
Type:
number
(optional)
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 .
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
- If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. - If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. - If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). MaxCapacity
andNumberOfWorkers
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.
maxRetries?
Type:
number
(optional)
The maximum number of times to retry after an MLTaskRun
of the machine learning transform fails.
name?
Type:
string
(optional)
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.
numberOfWorkers?
Type:
number
(optional)
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).
tags?
Type:
any
(optional)
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 in the developer guide.
timeout?
Type:
number
(optional)
The timeout in minutes of the machine learning transform.
transformEncryption?
Type:
IResolvable
|
Transform
(optional)
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.
workerType?
Type:
string
(optional)
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
orWorkerType
is set, thenMaxCapacity
cannot be set. - If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. - If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). MaxCapacity
andNumberOfWorkers
must both be at least 1.
Properties
Name | Type | Description |
---|---|---|
attr | string | |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
input | IResolvable | Input | A list of AWS Glue table definitions used by the transform. |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
role | string | The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
transform | IResolvable | Transform | The algorithm-specific parameters that are associated with the machine learning transform. |
description? | string | A user-defined, long-form description text for the machine learning transform. |
glue | string | This value determines which version of AWS Glue this machine learning transform is compatible with. |
max | number | The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. |
max | number | The maximum number of times to retry after an MLTaskRun of the machine learning transform fails. |
name? | string | A user-defined name for the machine learning transform. |
number | number | The number of workers of a defined workerType that are allocated when a task of the transform runs. |
tags | any | The tags to use with this machine learning transform. |
timeout? | number | The timeout in minutes of the machine learning transform. |
transform | IResolvable | Transform | The encryption-at-rest settings of the transform that apply to accessing user data. |
worker | string | The type of predefined worker that is allocated when a task of this transform runs. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrId
Type:
string
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
inputRecordTables
Type:
IResolvable
|
Input
A list of AWS Glue table definitions used by the transform.
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
role
Type:
string
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
transformParameters
Type:
IResolvable
|
Transform
The algorithm-specific parameters that are associated with the machine learning transform.
description?
Type:
string
(optional)
A user-defined, long-form description text for the machine learning transform.
glueVersion?
Type:
string
(optional)
This value determines which version of AWS Glue this machine learning transform is compatible with.
maxCapacity?
Type:
number
(optional)
The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
maxRetries?
Type:
number
(optional)
The maximum number of times to retry after an MLTaskRun
of the machine learning transform fails.
name?
Type:
string
(optional)
A user-defined name for the machine learning transform.
Names are required to be unique. Name
is optional:.
numberOfWorkers?
Type:
number
(optional)
The number of workers of a defined workerType
that are allocated when a task of the transform runs.
tagsRaw?
Type:
any
(optional)
The tags to use with this machine learning transform.
timeout?
Type:
number
(optional)
The timeout in minutes of the machine learning transform.
transformEncryption?
Type:
IResolvable
|
Transform
(optional)
The encryption-at-rest settings of the transform that apply to accessing user data.
workerType?
Type:
string
(optional)
The type of predefined worker that is allocated when a task of this transform runs.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }