ClusterInstanceGroupSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.ClusterInstanceGroupSpecification

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClusterInstanceGroupSpecification
extends Object
implements Serializable, Cloneable, StructuredPojo

The specifications of an instance group that you need to define.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClusterInstanceGroupSpecification()

Constructors
Constructor and Description
`ClusterInstanceGroupSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterInstanceGroupSpecification`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getExecutionRole()` Specifies an IAM execution role to be assumed by the instance group.
`Integer`	`getInstanceCount()` Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
`String`	`getInstanceGroupName()` Specifies the name of the instance group.
`List<ClusterInstanceStorageConfig>`	`getInstanceStorageConfigs()` Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
`String`	`getInstanceType()` Specifies the instance type of the instance group.
`ClusterLifeCycleConfig`	`getLifeCycleConfig()` Specifies the LifeCycle configuration for the instance group.
`Integer`	`getThreadsPerCore()` Specifies the value for Threads per core.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setExecutionRole(String executionRole)` Specifies an IAM execution role to be assumed by the instance group.
`void`	`setInstanceCount(Integer instanceCount)` Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
`void`	`setInstanceGroupName(String instanceGroupName)` Specifies the name of the instance group.
`void`	`setInstanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)` Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
`void`	`setInstanceType(String instanceType)` Specifies the instance type of the instance group.
`void`	`setLifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)` Specifies the LifeCycle configuration for the instance group.
`void`	`setThreadsPerCore(Integer threadsPerCore)` Specifies the value for Threads per core.
`String`	`toString()` Returns a string representation of this object.
`ClusterInstanceGroupSpecification`	`withExecutionRole(String executionRole)` Specifies an IAM execution role to be assumed by the instance group.
`ClusterInstanceGroupSpecification`	`withInstanceCount(Integer instanceCount)` Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
`ClusterInstanceGroupSpecification`	`withInstanceGroupName(String instanceGroupName)` Specifies the name of the instance group.
`ClusterInstanceGroupSpecification`	`withInstanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)` Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
`ClusterInstanceGroupSpecification`	`withInstanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)` Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
`ClusterInstanceGroupSpecification`	`withInstanceType(ClusterInstanceType instanceType)` Specifies the instance type of the instance group.
`ClusterInstanceGroupSpecification`	`withInstanceType(String instanceType)` Specifies the instance type of the instance group.
`ClusterInstanceGroupSpecification`	`withLifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)` Specifies the LifeCycle configuration for the instance group.
`ClusterInstanceGroupSpecification`	`withThreadsPerCore(Integer threadsPerCore)` Specifies the value for Threads per core.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClusterInstanceGroupSpecification
```
public ClusterInstanceGroupSpecification()
```
- Method Detail
  - setInstanceCount
```
public void setInstanceCount(Integer instanceCount)
```
    Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
    
    Parameters:
    
    instanceCount - Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
  - getInstanceCount
```
public Integer getInstanceCount()
```
    Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
    
    Returns:
    
    Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
  - withInstanceCount
```
public ClusterInstanceGroupSpecification withInstanceCount(Integer instanceCount)
```
    Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
    
    Parameters:
    
    instanceCount - Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceGroupName
```
public void setInstanceGroupName(String instanceGroupName)
```
    Specifies the name of the instance group.
    
    Parameters:
    
    instanceGroupName - Specifies the name of the instance group.
  - getInstanceGroupName
```
public String getInstanceGroupName()
```
    Specifies the name of the instance group.
    
    Returns:
    
    Specifies the name of the instance group.
  - withInstanceGroupName
```
public ClusterInstanceGroupSpecification withInstanceGroupName(String instanceGroupName)
```
    Specifies the name of the instance group.
    
    Parameters:
    
    instanceGroupName - Specifies the name of the instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    Specifies the instance type of the instance group.
    
    Parameters:
    
    instanceType - Specifies the instance type of the instance group.
    
    See Also:
    
    ClusterInstanceType
  - getInstanceType
```
public String getInstanceType()
```
    Specifies the instance type of the instance group.
    
    Returns:
    
    Specifies the instance type of the instance group.
    
    See Also:
    
    ClusterInstanceType
  - withInstanceType
```
public ClusterInstanceGroupSpecification withInstanceType(String instanceType)
```
    Specifies the instance type of the instance group.
    
    Parameters:
    
    instanceType - Specifies the instance type of the instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterInstanceType
  - withInstanceType
```
public ClusterInstanceGroupSpecification withInstanceType(ClusterInstanceType instanceType)
```
    Specifies the instance type of the instance group.
    
    Parameters:
    
    instanceType - Specifies the instance type of the instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterInstanceType
  - setLifeCycleConfig
```
public void setLifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)
```
    Specifies the LifeCycle configuration for the instance group.
    
    Parameters:
    
    lifeCycleConfig - Specifies the LifeCycle configuration for the instance group.
  - getLifeCycleConfig
```
public ClusterLifeCycleConfig getLifeCycleConfig()
```
    Specifies the LifeCycle configuration for the instance group.
    
    Returns:
    
    Specifies the LifeCycle configuration for the instance group.
  - withLifeCycleConfig
```
public ClusterInstanceGroupSpecification withLifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)
```
    Specifies the LifeCycle configuration for the instance group.
    
    Parameters:
    
    lifeCycleConfig - Specifies the LifeCycle configuration for the instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionRole
```
public void setExecutionRole(String executionRole)
```
    Specifies an IAM execution role to be assumed by the instance group.
    
    Parameters:
    
    executionRole - Specifies an IAM execution role to be assumed by the instance group.
  - getExecutionRole
```
public String getExecutionRole()
```
    Specifies an IAM execution role to be assumed by the instance group.
    
    Returns:
    
    Specifies an IAM execution role to be assumed by the instance group.
  - withExecutionRole
```
public ClusterInstanceGroupSpecification withExecutionRole(String executionRole)
```
    Specifies an IAM execution role to be assumed by the instance group.
    
    Parameters:
    
    executionRole - Specifies an IAM execution role to be assumed by the instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThreadsPerCore
```
public void setThreadsPerCore(Integer threadsPerCore)
```
    Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    threadsPerCore - Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
  - getThreadsPerCore
```
public Integer getThreadsPerCore()
```
    Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
  - withThreadsPerCore
```
public ClusterInstanceGroupSpecification withThreadsPerCore(Integer threadsPerCore)
```
    Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    threadsPerCore - Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInstanceStorageConfigs
```
public List<ClusterInstanceStorageConfig> getInstanceStorageConfigs()
```
    Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
    
    Returns:
    
    Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
  - setInstanceStorageConfigs
```
public void setInstanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)
```
    Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
    
    Parameters:
    
    instanceStorageConfigs - Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
  - withInstanceStorageConfigs
```
public ClusterInstanceGroupSpecification withInstanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)
```
    Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
    
    NOTE: This method appends the values to the existing list (if any). Use setInstanceStorageConfigs(java.util.Collection) or withInstanceStorageConfigs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    instanceStorageConfigs - Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInstanceStorageConfigs
```
public ClusterInstanceGroupSpecification withInstanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)
```
    Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
    
    Parameters:
    
    instanceStorageConfigs - Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ClusterInstanceGroupSpecification clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class ClusterInstanceGroupSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusterInstanceGroupSpecification

Method Detail

setInstanceCount

getInstanceCount

withInstanceCount

setInstanceGroupName

getInstanceGroupName

withInstanceGroupName

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setLifeCycleConfig

getLifeCycleConfig

withLifeCycleConfig

setExecutionRole

getExecutionRole

withExecutionRole

setThreadsPerCore

getThreadsPerCore

withThreadsPerCore

getInstanceStorageConfigs

setInstanceStorageConfigs

withInstanceStorageConfigs

withInstanceStorageConfigs

toString

equals

hashCode

clone

marshall