Package software.amazon.awscdk.services.glue

Class CfnMLTransform.Builder

java.lang.Object

software.amazon.awscdk.services.glue.CfnMLTransform.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMLTransform>

Enclosing class:

CfnMLTransform

@Stability(Stable)
public static final class CfnMLTransform.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMLTransform>

A fluent builder for CfnMLTransform.

Method Summary

Modifier and Type	Method	Description
CfnMLTransform	build()
static CfnMLTransform.Builder	create(software.constructs.Construct scope, String id)
CfnMLTransform.Builder	description(String description)	A user-defined, long-form description text for the machine learning transform.
CfnMLTransform.Builder	glueVersion(String glueVersion)	This value determines which version of AWS Glue this machine learning transform is compatible with.
CfnMLTransform.Builder	inputRecordTables(IResolvable inputRecordTables)	A list of AWS Glue table definitions used by the transform.
CfnMLTransform.Builder	inputRecordTables(CfnMLTransform.InputRecordTablesProperty inputRecordTables)	A list of AWS Glue table definitions used by the transform.
CfnMLTransform.Builder	maxCapacity(Number maxCapacity)	The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
CfnMLTransform.Builder	maxRetries(Number maxRetries)	The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
CfnMLTransform.Builder	name(String name)	A user-defined name for the machine learning transform.
CfnMLTransform.Builder	numberOfWorkers(Number numberOfWorkers)	The number of workers of a defined workerType that are allocated when a task of the transform runs.
CfnMLTransform.Builder	role(String role)	The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
CfnMLTransform.Builder	tags(Object tags)	The tags to use with this machine learning transform.
CfnMLTransform.Builder	timeout(Number timeout)	The timeout in minutes of the machine learning transform.
CfnMLTransform.Builder	transformEncryption(IResolvable transformEncryption)	The encryption-at-rest settings of the transform that apply to accessing user data.
CfnMLTransform.Builder	transformEncryption(CfnMLTransform.TransformEncryptionProperty transformEncryption)	The encryption-at-rest settings of the transform that apply to accessing user data.
CfnMLTransform.Builder	transformParameters(IResolvable transformParameters)	The algorithm-specific parameters that are associated with the machine learning transform.
CfnMLTransform.Builder	transformParameters(CfnMLTransform.TransformParametersProperty transformParameters)	The algorithm-specific parameters that are associated with the machine learning transform.
CfnMLTransform.Builder	workerType(String workerType)	The type of predefined worker that is allocated when a task of this transform runs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnMLTransform.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnMLTransform.Builder.

inputRecordTables

@Stability(Stable)
public CfnMLTransform.Builder inputRecordTables(IResolvable inputRecordTables)

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

Parameters:

inputRecordTables - A list of AWS Glue table definitions used by the transform. This parameter is required.

Returns:

this

See Also:

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

inputRecordTables

@Stability(Stable)
public CfnMLTransform.Builder inputRecordTables(CfnMLTransform.InputRecordTablesProperty inputRecordTables)

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

Parameters:

inputRecordTables - A list of AWS Glue table definitions used by the transform. This parameter is required.

Returns:

this

See Also:

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

role

@Stability(Stable)
public CfnMLTransform.Builder role(String 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 .
• 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.

Parameters:

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

Returns:

this

See Also:

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

transformParameters

@Stability(Stable)
public CfnMLTransform.Builder transformParameters(IResolvable transformParameters)

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

Parameters:

transformParameters - The algorithm-specific parameters that are associated with the machine learning transform. This parameter is required.

Returns:

this

See Also:

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

transformParameters

@Stability(Stable)
public CfnMLTransform.Builder transformParameters(CfnMLTransform.TransformParametersProperty transformParameters)

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

Parameters:

transformParameters - The algorithm-specific parameters that are associated with the machine learning transform. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnMLTransform.Builder description(String description)

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

Parameters:

description - A user-defined, long-form description text for the machine learning transform. This parameter is required.

Returns:

this

See Also:

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

glueVersion

@Stability(Stable)
public CfnMLTransform.Builder glueVersion(String 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 in the developer guide.

Parameters:

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

Returns:

this

See Also:

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

maxCapacity

@Stability(Stable)
public CfnMLTransform.Builder maxCapacity(Number 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 .

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.

Parameters:

maxCapacity - The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. This parameter is required.

Returns:

this

See Also:

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

maxRetries

@Stability(Stable)
public CfnMLTransform.Builder maxRetries(Number maxRetries)

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

Parameters:

maxRetries - The maximum number of times to retry after an MLTaskRun of the machine learning transform fails. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnMLTransform.Builder name(String 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.

Parameters:

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

Returns:

this

See Also:

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

numberOfWorkers

@Stability(Stable)
public CfnMLTransform.Builder numberOfWorkers(Number 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).

Parameters:

numberOfWorkers - The number of workers of a defined workerType that are allocated when a task of the transform runs. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnMLTransform.Builder tags(Object 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 in the developer guide.

Parameters:

tags - The tags to use with this machine learning transform. This parameter is required.

Returns:

this

See Also:

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

timeout

@Stability(Stable)
public CfnMLTransform.Builder timeout(Number timeout)

The timeout in minutes of the machine learning transform.

Parameters:

timeout - The timeout in minutes of the machine learning transform. This parameter is required.

Returns:

this

See Also:

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

transformEncryption

@Stability(Stable)
public CfnMLTransform.Builder transformEncryption(IResolvable 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.

Parameters:

transformEncryption - The encryption-at-rest settings of the transform that apply to accessing user data. This parameter is required.

Returns:

this

See Also:

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

transformEncryption

@Stability(Stable)
public CfnMLTransform.Builder transformEncryption(CfnMLTransform.TransformEncryptionProperty 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.

Parameters:

transformEncryption - The encryption-at-rest settings of the transform that apply to accessing user data. This parameter is required.

Returns:

this

See Also:

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

workerType

@Stability(Stable)
public CfnMLTransform.Builder workerType(String 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.

Parameters:

workerType - The type of predefined worker that is allocated when a task of this transform runs. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnMLTransform build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnMLTransform>

Returns:

a newly built instance of CfnMLTransform.