Class Placement

java.lang.Object
software.amazon.awssdk.services.ec2.model.Placement
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Placement.Builder,Placement>
@Generated("software.amazon.awssdk:codegen") public final class Placement extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Placement.Builder,Placement>

Describes the placement of an instance.

See Also:

  • Method Details

    • affinity

      public final String affinity()

      The affinity setting for the instance on the Dedicated Host.

      This parameter is not supported for CreateFleet or ImportInstance.

      Returns:
      The affinity setting for the instance on the Dedicated Host.

      This parameter is not supported for CreateFleet or ImportInstance.

    • groupName

      public final String groupName()

      The name of the placement group that the instance is in. If you specify GroupName, you can't specify GroupId.

      Returns:
      The name of the placement group that the instance is in. If you specify GroupName, you can't specify GroupId.

    • partitionNumber

      public final Integer partitionNumber()

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

      This parameter is not supported for CreateFleet.

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

      This parameter is not supported for CreateFleet.

    • hostId

      public final String hostId()

      The ID of the Dedicated Host on which the instance resides.

      This parameter is not supported for CreateFleet or ImportInstance.

      Returns:
      The ID of the Dedicated Host on which the instance resides.

      This parameter is not supported for CreateFleet or ImportInstance.

    • tenancy

      public final Tenancy tenancy()

      The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

      This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

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

      Returns:
      The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

      This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

      See Also:

    • tenancyAsString

      public final String tenancyAsString()

      The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

      This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

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

      Returns:
      The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

      This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

      See Also:

    • spreadDomain

      public final String spreadDomain()

      Reserved for future use.

      Returns:
      Reserved for future use.

    • hostResourceGroupArn

      public final String hostResourceGroupArn()

      The ARN of the host resource group in which to launch the instances.

      If you specify this parameter, either omit the Tenancy parameter or set it to host.

      This parameter is not supported for CreateFleet.

      Returns:
      The ARN of the host resource group in which to launch the instances.

      If you specify this parameter, either omit the Tenancy parameter or set it to host.

      This parameter is not supported for CreateFleet.

    • groupId

      public final String groupId()

      The ID of the placement group that the instance is in. If you specify GroupId, you can't specify GroupName.

      Returns:
      The ID of the placement group that the instance is in. If you specify GroupId, you can't specify GroupName.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone of the instance.

      If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

      This parameter is not supported for CreateFleet.

      Returns:
      The Availability Zone of the instance.

      If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

      This parameter is not supported for CreateFleet.

    • toBuilder

      public Placement.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<Placement.Builder,Placement>
      Returns:
      a builder for type T

    • builder

      public static Placement.Builder builder()

    • serializableBuilderClass

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

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