Interface ProcessingClusterConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ProcessingClusterConfig.Builder,ProcessingClusterConfig>, SdkBuilder<ProcessingClusterConfig.Builder,ProcessingClusterConfig>, SdkPojo
Enclosing class:
ProcessingClusterConfig
@Mutable @NotThreadSafe public static interface ProcessingClusterConfig.Builder extends SdkPojo, CopyableBuilder<ProcessingClusterConfig.Builder,ProcessingClusterConfig>

  • Method Details

    • instanceCount

      ProcessingClusterConfig.Builder instanceCount(Integer instanceCount)

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

      Parameters:
      instanceCount - The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      ProcessingClusterConfig.Builder instanceType(String instanceType)

      The ML compute instance type for the processing job.

      Parameters:
      instanceType - The ML compute instance type for the processing job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceType

      ProcessingClusterConfig.Builder instanceType(ProcessingInstanceType instanceType)

      The ML compute instance type for the processing job.

      Parameters:
      instanceType - The ML compute instance type for the processing job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • volumeSizeInGB

      ProcessingClusterConfig.Builder volumeSizeInGB(Integer volumeSizeInGB)

      The size of the ML storage volume in gigabytes that you want to provision. 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.

      Parameters:
      volumeSizeInGB - The size of the ML storage volume in gigabytes that you want to provision. 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:
      Returns a reference to this object so that method calls can be chained together.

    • volumeKmsKeyId

      ProcessingClusterConfig.Builder volumeKmsKeyId(String volumeKmsKeyId)

      The Amazon Web Services Key Management Service (Amazon Web Services 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.

      Parameters:
      volumeKmsKeyId - The Amazon Web Services Key Management Service (Amazon Web Services 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:
      Returns a reference to this object so that method calls can be chained together.

    • instancePreferences

      ProcessingClusterConfig.Builder instancePreferences(Collection<ProcessingInstancePreference> instancePreferences)

      An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.

      InstancePreferences is mutually exclusive with InstanceType.

      Parameters:
      instancePreferences - An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.

      InstancePreferences is mutually exclusive with InstanceType.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instancePreferences

      ProcessingClusterConfig.Builder instancePreferences(ProcessingInstancePreference... instancePreferences)

      An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.

      InstancePreferences is mutually exclusive with InstanceType.

      Parameters:
      instancePreferences - An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.

      InstancePreferences is mutually exclusive with InstanceType.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instancePreferences

      ProcessingClusterConfig.Builder instancePreferences(Consumer<ProcessingInstancePreference.Builder>... instancePreferences)

      An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.

      InstancePreferences is mutually exclusive with InstanceType.

      This is a convenience method that creates an instance of the ProcessingInstancePreference.Builder avoiding the need to create one manually via ProcessingInstancePreference.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instancePreferences(List<ProcessingInstancePreference>).

      Parameters:
      instancePreferences - a consumer that will call methods on ProcessingInstancePreference.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • selectedInstanceType

      ProcessingClusterConfig.Builder selectedInstanceType(String selectedInstanceType)

      The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.

      Parameters:
      selectedInstanceType - The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • selectedInstanceType

      ProcessingClusterConfig.Builder selectedInstanceType(ProcessingInstanceType selectedInstanceType)

      The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.

      Parameters:
      selectedInstanceType - The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • selectedInstanceCount

      ProcessingClusterConfig.Builder selectedInstanceCount(Integer selectedInstanceCount)

      The number of instances of SelectedInstanceType that the job launched with. The job is billed for this instance type and count. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.

      Parameters:
      selectedInstanceCount - The number of instances of SelectedInstanceType that the job launched with. The job is billed for this instance type and count. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.