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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePlacementGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePlacementGroupRequest.Builder	builder()
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupName()	A name for the placement group.
int	hashCode()
boolean	hasTagSpecifications()	For responses, this returns true if the service returned a value for the TagSpecifications property.
Integer	partitionCount()	The number of partitions.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePlacementGroupRequest.Builder>	serializableBuilderClass()
SpreadLevel	spreadLevel()	Determines how placement groups spread instances.
String	spreadLevelAsString()	Determines how placement groups spread instances.
PlacementStrategy	strategy()	The placement strategy.
String	strategyAsString()	The placement strategy.
List<TagSpecification>	tagSpecifications()	The tags to apply to the new placement group.
CreatePlacementGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

PlacementStrategy

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:

PlacementStrategy

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:

SpreadLevel

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:

SpreadLevel

toBuilder

public CreatePlacementGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePlacementGroupRequest.Builder,CreatePlacementGroupRequest>

Specified by:

toBuilder in class Ec2Request

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo