Package software.amazon.awscdk.services.sagemaker

Class CfnProcessingJob.ClusterConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnProcessingJob.ClusterConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnProcessingJob.ClusterConfigProperty>

Enclosing interface:

CfnProcessingJob.ClusterConfigProperty

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

A builder for CfnProcessingJob.ClusterConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnProcessingJob.ClusterConfigProperty	build()	Builds the configured instance.
CfnProcessingJob.ClusterConfigProperty.Builder	instanceCount(Number instanceCount)	Sets the value of CfnProcessingJob.ClusterConfigProperty.getInstanceCount()
CfnProcessingJob.ClusterConfigProperty.Builder	instanceType(String instanceType)	Sets the value of CfnProcessingJob.ClusterConfigProperty.getInstanceType()
CfnProcessingJob.ClusterConfigProperty.Builder	volumeKmsKeyId(String volumeKmsKeyId)	Sets the value of CfnProcessingJob.ClusterConfigProperty.getVolumeKmsKeyId()
CfnProcessingJob.ClusterConfigProperty.Builder	volumeSizeInGb(Number volumeSizeInGb)	Sets the value of CfnProcessingJob.ClusterConfigProperty.getVolumeSizeInGb()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

instanceCount

@Stability(Stable)
public CfnProcessingJob.ClusterConfigProperty.Builder instanceCount(Number instanceCount)

Sets the value of CfnProcessingJob.ClusterConfigProperty.getInstanceCount()

Parameters:

instanceCount - The number of ML compute instances to use in the processing job. This parameter is required. For distributed processing jobs, specify a value greater than 1. The default value is 1.

Returns:

this

instanceType

@Stability(Stable)
public CfnProcessingJob.ClusterConfigProperty.Builder instanceType(String instanceType)

Sets the value of CfnProcessingJob.ClusterConfigProperty.getInstanceType()

Parameters:

instanceType - The ML compute instance type for the processing job. This parameter is required.

Returns:

this

volumeSizeInGb

@Stability(Stable)
public CfnProcessingJob.ClusterConfigProperty.Builder volumeSizeInGb(Number volumeSizeInGb)

Sets the value of CfnProcessingJob.ClusterConfigProperty.getVolumeSizeInGb()

Parameters:

volumeSizeInGb - The size of the ML storage volume in gigabytes that you want to provision. This parameter is required. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes .

Returns:

this

volumeKmsKeyId

@Stability(Stable)
public CfnProcessingJob.ClusterConfigProperty.Builder volumeKmsKeyId(String volumeKmsKeyId)

Sets the value of CfnProcessingJob.ClusterConfigProperty.getVolumeKmsKeyId()

Parameters:

volumeKmsKeyId - The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes .

For more information about local instance storage encryption, see SSD Instance Store Volumes .

Returns:

this

build

@Stability(Stable)
public CfnProcessingJob.ClusterConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnProcessingJob.ClusterConfigProperty>

Returns:

a new instance of CfnProcessingJob.ClusterConfigProperty

Throws:

NullPointerException - if any required attribute was not provided