java.lang.Object
- software.amazon.awssdk.services.pcs.model.ComputeNodeGroup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ComputeNodeGroup.Builder,ComputeNodeGroup>

@Generated("software.amazon.awssdk:codegen")
public final class ComputeNodeGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ComputeNodeGroup.Builder,ComputeNodeGroup>

A compute node group associated with a cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ComputeNodeGroup.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`amiId()`	The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances.
`String`	`arn()`	The unique Amazon Resource Name (ARN) of the compute node group.
`static ComputeNodeGroup.Builder`	`builder()`
`String`	`clusterId()`	The ID of the cluster of the compute node group.
`Instant`	`createdAt()`	The date and time the resource was created.
`CustomLaunchTemplate`	`customLaunchTemplate()`	Returns the value of the CustomLaunchTemplate property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ErrorInfo>`	`errorInfo()`	The list of errors that occurred during compute node group provisioning.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasErrorInfo()`	For responses, this returns true if the service returned a value for the ErrorInfo property.
`int`	`hashCode()`
`boolean`	`hasInstanceConfigs()`	For responses, this returns true if the service returned a value for the InstanceConfigs property.
`boolean`	`hasSubnetIds()`	For responses, this returns true if the service returned a value for the SubnetIds property.
`String`	`iamInstanceProfileArn()`	The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
`String`	`id()`	The generated unique ID of the compute node group.
`List<InstanceConfig>`	`instanceConfigs()`	A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
`Instant`	`modifiedAt()`	The date and time the resource was modified.
`String`	`name()`	The name that identifies the compute node group.
`PurchaseOption`	`purchaseOption()`	Specifies how EC2 instances are purchased on your behalf.
`String`	`purchaseOptionAsString()`	Specifies how EC2 instances are purchased on your behalf.
`ScalingConfiguration`	`scalingConfiguration()`	Returns the value of the ScalingConfiguration property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ComputeNodeGroup.Builder>`	`serializableBuilderClass()`
`ComputeNodeGroupSlurmConfiguration`	`slurmConfiguration()`	Returns the value of the SlurmConfiguration property for this object.
`SpotOptions`	`spotOptions()`	Returns the value of the SpotOptions property for this object.
`ComputeNodeGroupStatus`	`status()`	The provisioning status of the compute node group.
`String`	`statusAsString()`	The provisioning status of the compute node group.
`List<String>`	`subnetIds()`	The list of subnet IDs where instances are provisioned by the compute node group.
`ComputeNodeGroup.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name that identifies the compute node group.
    
    Returns:
    
    The name that identifies the compute node group.
  - id
```
public final String id()
```
    The generated unique ID of the compute node group.
    
    Returns:
    
    The generated unique ID of the compute node group.
  - arn
```
public final String arn()
```
    The unique Amazon Resource Name (ARN) of the compute node group.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) of the compute node group.
  - clusterId
```
public final String clusterId()
```
    The ID of the cluster of the compute node group.
    
    Returns:
    
    The ID of the cluster of the compute node group.
  - createdAt
```
public final Instant createdAt()
```
    The date and time the resource was created.
    
    Returns:
    
    The date and time the resource was created.
  - modifiedAt
```
public final Instant modifiedAt()
```
    The date and time the resource was modified.
    
    Returns:
    
    The date and time the resource was modified.
  - status
```
public final ComputeNodeGroupStatus status()
```
    The provisioning status of the compute node group.
    
    The provisioning status doesn't indicate the overall health of the compute node group.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ComputeNodeGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The provisioning status of the compute node group.
    
    The provisioning status doesn't indicate the overall health of the compute node group.
    
    See Also:
    
    ComputeNodeGroupStatus
  - statusAsString
```
public final String statusAsString()
```
    The provisioning status of the compute node group.
    
    The provisioning status doesn't indicate the overall health of the compute node group.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ComputeNodeGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The provisioning status of the compute node group.
    
    The provisioning status doesn't indicate the overall health of the compute node group.
    
    See Also:
    
    ComputeNodeGroupStatus
  - amiId
```
public final String amiId()
```
    The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
    
    Returns:
    
    The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - subnetIds
```
public final List<String> subnetIds()
```
    The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.
    
    Returns:
    
    The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
  - purchaseOption
```
public final PurchaseOption purchaseOption()
```
    Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
    
    If the service returns an enum value that is not available in the current SDK version, purchaseOption will return PurchaseOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from purchaseOptionAsString().
    
    Returns:
    
    Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
    
    See Also:
    
    PurchaseOption
  - purchaseOptionAsString
```
public final String purchaseOptionAsString()
```
    Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
    
    If the service returns an enum value that is not available in the current SDK version, purchaseOption will return PurchaseOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from purchaseOptionAsString().
    
    Returns:
    
    Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
    
    See Also:
    
    PurchaseOption
  - customLaunchTemplate
```
public final CustomLaunchTemplate customLaunchTemplate()
```
    Returns the value of the CustomLaunchTemplate property for this object.
    
    Returns:
    
    The value of the CustomLaunchTemplate property for this object.
  - iamInstanceProfileArn
```
public final String iamInstanceProfileArn()
```
    The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
  - scalingConfiguration
```
public final ScalingConfiguration scalingConfiguration()
```
    Returns the value of the ScalingConfiguration property for this object.
    
    Returns:
    
    The value of the ScalingConfiguration property for this object.
  - hasInstanceConfigs
```
public final boolean hasInstanceConfigs()
```
    For responses, this returns true if the service returned a value for the InstanceConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - instanceConfigs
```
public final List<InstanceConfig> instanceConfigs()
```
    A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceConfigs() method.
    
    Returns:
    
    A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
  - spotOptions
```
public final SpotOptions spotOptions()
```
    Returns the value of the SpotOptions property for this object.
    
    Returns:
    
    The value of the SpotOptions property for this object.
  - slurmConfiguration
```
public final ComputeNodeGroupSlurmConfiguration slurmConfiguration()
```
    Returns the value of the SlurmConfiguration property for this object.
    
    Returns:
    
    The value of the SlurmConfiguration property for this object.
  - hasErrorInfo
```
public final boolean hasErrorInfo()
```
    For responses, this returns true if the service returned a value for the ErrorInfo property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - errorInfo
```
public final List<ErrorInfo> errorInfo()
```
    The list of errors that occurred during compute node group provisioning.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrorInfo() method.
    
    Returns:
    
    The list of errors that occurred during compute node group provisioning.
  - toBuilder
```
public ComputeNodeGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ComputeNodeGroup.Builder,ComputeNodeGroup>
  - builder
```
public static ComputeNodeGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ComputeNodeGroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ComputeNodeGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

id

arn

clusterId

createdAt

modifiedAt

status

statusAsString

amiId

hasSubnetIds

subnetIds

purchaseOption

purchaseOptionAsString

customLaunchTemplate

iamInstanceProfileArn

scalingConfiguration

hasInstanceConfigs

instanceConfigs

spotOptions

slurmConfiguration

hasErrorInfo

errorInfo

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields