Class UpdateComputeNodeGroupRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.pcs.model.PcsRequest
software.amazon.awssdk.services.pcs.model.UpdateComputeNodeGroupRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateComputeNodeGroupRequest.Builder,UpdateComputeNodeGroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateComputeNodeGroupRequest extends PcsRequest implements ToCopyableBuilder<UpdateComputeNodeGroupRequest.Builder,UpdateComputeNodeGroupRequest>

  • Method Details

    • clusterIdentifier

      public final String clusterIdentifier()

      The name or ID of the cluster of the compute node group.

      Returns:
      The name or ID of the cluster of the compute node group.

    • computeNodeGroupIdentifier

      public final String computeNodeGroupIdentifier()

      The name or ID of the compute node group.

      Returns:
      The name or ID of the compute node group.

    • 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 the compute node group provisions instances. 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 the compute node group provisions instances. The subnets must be in the same VPC as the cluster.

    • 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.

    • 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:

    • 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:

    • 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.

    • scalingConfiguration

      public final ScalingConfigurationRequest scalingConfiguration()

      Specifies the boundaries of the compute node group auto scaling.

      Returns:
      Specifies the boundaries of the compute node group auto scaling.

    • 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 the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

      Examples

      • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

      • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

      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 the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

      Examples

      • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

      • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

    • slurmConfiguration

      public final UpdateComputeNodeGroupSlurmConfigurationRequest slurmConfiguration()

      Additional options related to the Slurm scheduler.

      Returns:
      Additional options related to the Slurm scheduler.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

    • toBuilder

      public UpdateComputeNodeGroupRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateComputeNodeGroupRequest.Builder,UpdateComputeNodeGroupRequest>
      Specified by:
      toBuilder in class PcsRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateComputeNodeGroupRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateComputeNodeGroupRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.