ModifyInstancePlacementRequest (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class ModifyInstancePlacementRequest
extends Ec2Request
implements ToCopyableBuilder<ModifyInstancePlacementRequest.Builder,ModifyInstancePlacementRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModifyInstancePlacementRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ModifyInstancePlacementRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`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()` Reserved for future use.
`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()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - affinity
```
public final Affinity affinity()
```
    The affinity setting for the instance.
    
    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.
    
    See Also:
    
    Affinity
  - affinityAsString
```
public final String affinityAsString()
```
    The affinity setting for the instance.
    
    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.
    
    See Also:
    
    Affinity
  - 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 ("").
  - 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.
  - 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 can't change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy 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 can't change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy error code.
    
    See Also:
    
    HostTenancy
  - tenancyAsString
```
public final String tenancyAsString()
```
    The tenancy for the instance.
    
    For T3 instances, you can't change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy 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 can't change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy error code.
    
    See Also:
    
    HostTenancy
  - partitionNumber
```
public final Integer partitionNumber()
```
    Reserved for future use.
    
    Returns:
    
    Reserved for future use.
  - hostResourceGroupArn
```
public final String hostResourceGroupArn()
```
    The ARN of the host resource group in which to place the instance.
    
    Returns:
    
    The ARN of the host resource group in which to place 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.

AWS SDK for Java API Reference - 2.17.63

Class ModifyInstancePlacementRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

affinity

affinityAsString

groupName

hostId

instanceId

tenancy

tenancyAsString

partitionNumber

hostResourceGroupArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields