Class UpdateComputeNodeGroupRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateComputeNodeGroupRequest.Builder,UpdateComputeNodeGroupRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringamiId()The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances.builder()final StringA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final StringThe name or ID of the cluster of the compute node group.final StringThe name or ID of the compute node group.final CustomLaunchTemplateThe custom Amazon EC2 launch template to associate with the compute node group.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the SecurityGroupIds property.final booleanFor responses, this returns true if the service returned a value for the SubnetIds property.final StringThe Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.final LaunchTemplateModeSpecifies whether the compute node group uses a custom launch template or a launch template that PCS manages.final StringSpecifies whether the compute node group uses a custom launch template or a launch template that PCS manages.The lifecycle actions to run on compute nodes in the compute node group.final PurchaseOptionSpecifies how EC2 instances are purchased on your behalf.final StringSpecifies how EC2 instances are purchased on your behalf.Specifies the boundaries of the compute node group auto scaling.The IDs of the EC2 security groups to configure directly on the compute node group.static Class<? extends UpdateComputeNodeGroupRequest.Builder> Additional options related to the Slurm scheduler.final SpotOptionsReturns the value of the SpotOptions property for this object.final StringThe name of the EC2 key pair to configure directly on the compute node group.The list of subnet IDs where the compute node group provisions instances.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
amiId
The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. This value overrides the AMI ID in the custom launch template. Specify an empty string (
"") to remove the AMI ID from the compute node group and use the AMI ID specified in the custom launch template. Omit this value to leave the current setting unchanged.- Returns:
- The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. This value overrides the AMI
ID in the custom launch template. Specify an empty string (
"") to remove the AMI ID from the compute node group and use the AMI ID specified in the custom launch template. Omit this value to leave the current setting unchanged.
-
hasSecurityGroupIds
public final boolean hasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
securityGroupIds
The IDs of the EC2 security groups to configure directly on the compute node group. The security groups must be in the same VPC as the cluster. PCS uses these security groups instead of the security groups in the custom launch template. You can't specify this value if the custom launch template defines network interfaces. Specify an empty list (
[]) to remove the security groups from the compute node group and use the security groups in the custom launch template. Omit this value to leave the current setting unchanged.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
hasSecurityGroupIds()method.- Returns:
- The IDs of the EC2 security groups to configure directly on the compute node group. The security groups
must be in the same VPC as the cluster. PCS uses these security groups instead of the security groups in
the custom launch template. You can't specify this value if the custom launch template defines network
interfaces. Specify an empty list (
[]) to remove the security groups from the compute node group and use the security groups in the custom launch template. Omit this value to leave the current setting unchanged.
-
sshKeyName
The name of the EC2 key pair to configure directly on the compute node group. The key pair must exist in your account and Amazon Web Services Region. PCS uses this key pair instead of the key pair in the custom launch template. Specify an empty string (
"") to remove the key pair from the compute node group and use the key pair in the custom launch template. Omit this value to leave the current setting unchanged. You must have permission forec2:DescribeKeyPairsto specify a key pair. If you delete the key pair later, future instance launches can fail.- Returns:
- The name of the EC2 key pair to configure directly on the compute node group. The key pair must exist in
your account and Amazon Web Services Region. PCS uses this key pair instead of the key pair in the custom
launch template. Specify an empty string (
"") to remove the key pair from the compute node group and use the key pair in the custom launch template. Omit this value to leave the current setting unchanged. You must have permission forec2:DescribeKeyPairsto specify a key pair. If you delete the key pair later, future instance launches can fail.
-
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
The name or ID of the compute node group.
- Returns:
- The name or ID of the compute node group.
-
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 theisEmpty()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
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.
-
launchTemplateMode
Specifies whether the compute node group uses a custom launch template or a launch template that PCS manages. Omit this value to keep the current mode.
Valid values:
-
CUSTOM– Use a custom launch template. To switch fromMANAGED, also providecustomLaunchTemplate. If the compute node group already usesCUSTOMand you omitcustomLaunchTemplate, the existing launch template is unchanged. -
MANAGED– Use a launch template created and managed by PCS. OmitcustomLaunchTemplate. Switching to this mode removes the custom launch template association but doesn't delete the launch template.
When switching to
MANAGED, the compute node group must haveamiIdandsecurityGroupIdsconfigured. You can set these values in the same request.If the service returns an enum value that is not available in the current SDK version,
launchTemplateModewill returnLaunchTemplateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlaunchTemplateModeAsString().- Returns:
- Specifies whether the compute node group uses a custom launch template or a launch template that PCS
manages. Omit this value to keep the current mode.
Valid values:
-
CUSTOM– Use a custom launch template. To switch fromMANAGED, also providecustomLaunchTemplate. If the compute node group already usesCUSTOMand you omitcustomLaunchTemplate, the existing launch template is unchanged. -
MANAGED– Use a launch template created and managed by PCS. OmitcustomLaunchTemplate. Switching to this mode removes the custom launch template association but doesn't delete the launch template.
When switching to
MANAGED, the compute node group must haveamiIdandsecurityGroupIdsconfigured. You can set these values in the same request. -
- See Also:
-
-
launchTemplateModeAsString
Specifies whether the compute node group uses a custom launch template or a launch template that PCS manages. Omit this value to keep the current mode.
Valid values:
-
CUSTOM– Use a custom launch template. To switch fromMANAGED, also providecustomLaunchTemplate. If the compute node group already usesCUSTOMand you omitcustomLaunchTemplate, the existing launch template is unchanged. -
MANAGED– Use a launch template created and managed by PCS. OmitcustomLaunchTemplate. Switching to this mode removes the custom launch template association but doesn't delete the launch template.
When switching to
MANAGED, the compute node group must haveamiIdandsecurityGroupIdsconfigured. You can set these values in the same request.If the service returns an enum value that is not available in the current SDK version,
launchTemplateModewill returnLaunchTemplateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlaunchTemplateModeAsString().- Returns:
- Specifies whether the compute node group uses a custom launch template or a launch template that PCS
manages. Omit this value to keep the current mode.
Valid values:
-
CUSTOM– Use a custom launch template. To switch fromMANAGED, also providecustomLaunchTemplate. If the compute node group already usesCUSTOMand you omitcustomLaunchTemplate, the existing launch template is unchanged. -
MANAGED– Use a launch template created and managed by PCS. OmitcustomLaunchTemplate. Switching to this mode removes the custom launch template association but doesn't delete the launch template.
When switching to
MANAGED, the compute node group must haveamiIdandsecurityGroupIdsconfigured. You can set these values in the same request. -
- See Also:
-
-
customLaunchTemplate
The custom Amazon EC2 launch template to associate with the compute node group. To set or change the custom launch template, specify
idandversion. If you provide this value and omitlaunchTemplateMode, the compute node group must already useCUSTOMmode. To switch fromMANAGEDtoCUSTOM, specifylaunchTemplateModeasCUSTOMand provide this value. If the compute node group already usesCUSTOM, omit this value while also omittinglaunchTemplateMode, or while specifyingCUSTOM, to keep the existing custom launch template. For more information, see Migrating a compute node group from a custom launch template in the PCS User Guide.- Returns:
- The custom Amazon EC2 launch template to associate with the compute node group. To set or change the
custom launch template, specify
idandversion. If you provide this value and omitlaunchTemplateMode, the compute node group must already useCUSTOMmode. To switch fromMANAGEDtoCUSTOM, specifylaunchTemplateModeasCUSTOMand provide this value. If the compute node group already usesCUSTOM, omit this value while also omittinglaunchTemplateMode, or while specifyingCUSTOM, to keep the existing custom launch template. For more information, see Migrating a compute node group from a custom launch template in the PCS User Guide.
-
purchaseOption
Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. 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,
purchaseOptionwill returnPurchaseOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompurchaseOptionAsString().- Returns:
- Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. If you don't provide this option, it defaults to On-Demand.
- See Also:
-
purchaseOptionAsString
Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. 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,
purchaseOptionwill returnPurchaseOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompurchaseOptionAsString().- Returns:
- Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. If you don't provide this option, it defaults to On-Demand.
- See Also:
-
spotOptions
Returns the value of the SpotOptions property for this object.- Returns:
- The value of the SpotOptions property for this object.
-
scalingConfiguration
Specifies the boundaries of the compute node group auto scaling.
- Returns:
- Specifies the boundaries of the compute node group auto scaling.
-
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:RegisterComputeNodeGroupInstancepermission and the role name must start withAWSPCSor must have the path/aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.- 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:RegisterComputeNodeGroupInstancepermission and the role name must start withAWSPCSor must have the path/aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.
-
slurmConfiguration
Additional options related to the Slurm scheduler.
- Returns:
- Additional options related to the Slurm scheduler.
-
nodeLifecycleActions
The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs.
- Returns:
- The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs.
-
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 one 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 one for you.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateComputeNodeGroupRequest.Builder,UpdateComputeNodeGroupRequest> - Specified by:
toBuilderin classPcsRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-