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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyInstancePlacementRequest.Builder

Method Summary

Modifier and Type	Method	Description
Affinity	affinity()	The affinity setting for the instance.
String	affinityAsString()	The affinity setting for the instance.
static ModifyInstancePlacementRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupId()	The Group Id of a placement group.
String	groupName()	The name of the placement group in which to place the instance.
int	hashCode()
String	hostId()	The ID of the Dedicated Host with which to associate the instance.
String	hostResourceGroupArn()	The ARN of the host resource group in which to place the instance.
String	instanceId()	The ID of the instance that you are modifying.
Integer	partitionNumber()	The number of the partition in which to place the instance.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyInstancePlacementRequest.Builder>	serializableBuilderClass()
HostTenancy	tenancy()	The tenancy for the instance.
String	tenancyAsString()	The tenancy for the instance.
ModifyInstancePlacementRequest.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

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:

HostTenancy

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:

HostTenancy

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:

Affinity

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:

Affinity

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyInstancePlacementRequest.Builder,ModifyInstancePlacementRequest>

Specified by:

toBuilder in class Ec2Request

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo