Class ModifyInstancePlacementRequest

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

  • Method Details

    • groupName

      public final String groupName()

      The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.

      To remove an instance from a placement group, specify an empty string ("").

      Returns:
      The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.

      To remove an instance from a placement group, specify an empty string ("").

    • partitionNumber

      public final Integer partitionNumber()

      The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition.

      Returns:
      The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition.

    • hostResourceGroupArn

      public final String hostResourceGroupArn()

      The ARN of the host resource group in which to place the instance. The instance must have a tenancy of host to specify this parameter.

      Returns:
      The ARN of the host resource group in which to place the instance. The instance must have a tenancy of host to specify this parameter.

    • groupId

      public final String groupId()

      The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.

      Returns:
      The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.

    • instanceId

      public final String instanceId()

      The ID of the instance that you are modifying.

      Returns:
      The ID of the instance that you are modifying.

    • tenancy

      public final HostTenancy tenancy()

      The tenancy for the instance.

      For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.

      If the service returns an enum value that is not available in the current SDK version, tenancy will return HostTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().

      Returns:
      The tenancy for the instance.

      For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.

      See Also:

    • tenancyAsString

      public final String tenancyAsString()

      The tenancy for the instance.

      For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.

      If the service returns an enum value that is not available in the current SDK version, tenancy will return HostTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().

      Returns:
      The tenancy for the instance.

      For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.

      See Also:

    • affinity

      public final Affinity affinity()

      The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.

      If the service returns an enum value that is not available in the current SDK version, affinity will return Affinity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from affinityAsString().

      Returns:
      The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
      See Also:

    • affinityAsString

      public final String affinityAsString()

      The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.

      If the service returns an enum value that is not available in the current SDK version, affinity will return Affinity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from affinityAsString().

      Returns:
      The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
      See Also:

    • hostId

      public final String hostId()

      The ID of the Dedicated Host with which to associate the instance.

      Returns:
      The ID of the Dedicated Host with which to associate the instance.

    • toBuilder

      public ModifyInstancePlacementRequest.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<ModifyInstancePlacementRequest.Builder,ModifyInstancePlacementRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyInstancePlacementRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyInstancePlacementRequest.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.