Package software.amazon.awssdk.services.ec2.model

Class CreatePlacementGroupRequest

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.CreatePlacementGroupRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePlacementGroupRequest.Builder,CreatePlacementGroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePlacementGroupRequest extends Ec2Request implements ToCopyableBuilder<CreatePlacementGroupRequest.Builder,CreatePlacementGroupRequest>

  • Method Details

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • groupName

      public final String groupName()

      A name for the placement group. Must be unique within the scope of your account for the Region.

      Constraints: Up to 255 ASCII characters

      Returns:
      A name for the placement group. Must be unique within the scope of your account for the Region.

      Constraints: Up to 255 ASCII characters

    • strategy

      public final PlacementStrategy strategy()

      The placement strategy.

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

      Returns:
      The placement strategy.
      See Also:

    • strategyAsString

      public final String strategyAsString()

      The placement strategy.

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

      Returns:
      The placement strategy.
      See Also:

    • partitionCount

      public final Integer partitionCount()

      The number of partitions. Valid only when Strategy is set to partition.

      Returns:
      The number of partitions. Valid only when Strategy is set to partition.

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications 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.

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      The tags to apply to the new placement 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 hasTagSpecifications() method.

      Returns:
      The tags to apply to the new placement group.

    • spreadLevel

      public final SpreadLevel spreadLevel()

      Determines how placement groups spread instances.

      • Host – You can use host only with Outpost placement groups.

      • Rack – No usage restrictions.

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

      Returns:
      Determines how placement groups spread instances.

      • Host – You can use host only with Outpost placement groups.

      • Rack – No usage restrictions.

      See Also:

    • spreadLevelAsString

      public final String spreadLevelAsString()

      Determines how placement groups spread instances.

      • Host – You can use host only with Outpost placement groups.

      • Rack – No usage restrictions.

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

      Returns:
      Determines how placement groups spread instances.

      • Host – You can use host only with Outpost placement groups.

      • Rack – No usage restrictions.

      See Also:

    • toBuilder

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

    • builder

      public static CreatePlacementGroupRequest.Builder builder()

    • serializableBuilderClass

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