Class ModifyInstancePlacementRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyInstancePlacementRequest.Builder,
ModifyInstancePlacementRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Affinity
affinity()
The affinity setting for the instance.final String
The affinity setting for the instance.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
groupId()
The Group Id of a placement group.final String
The name of the placement group in which to place the instance.final int
hashCode()
final String
hostId()
The ID of the Dedicated Host with which to associate the instance.final String
The ARN of the host resource group in which to place the instance.final String
The ID of the instance that you are modifying.final Integer
The number of the partition in which to place the instance.static Class
<? extends ModifyInstancePlacementRequest.Builder> final HostTenancy
tenancy()
The tenancy for the instance.final String
The tenancy for the instance.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnAffinity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaffinityAsString()
.- Returns:
- The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
- See Also:
-
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 returnAffinity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaffinityAsString()
.- Returns:
- The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
- See Also:
-
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 ofdefault
ordedicated
.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 ofdefault
ordedicated
.To remove an instance from a placement group, specify an empty 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
The ID of the instance that you are modifying.
- Returns:
- The ID of the instance that you are modifying.
-
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 fromhost
todedicated
ordefault
. Attempting to make one of these unsupported tenancy changes results in anInvalidRequest
error code.If the service returns an enum value that is not available in the current SDK version,
tenancy
will returnHostTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtenancyAsString()
.- 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 fromhost
todedicated
ordefault
. Attempting to make one of these unsupported tenancy changes results in anInvalidRequest
error code. - See Also:
-
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 fromhost
todedicated
ordefault
. Attempting to make one of these unsupported tenancy changes results in anInvalidRequest
error code.If the service returns an enum value that is not available in the current SDK version,
tenancy
will returnHostTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtenancyAsString()
.- 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 fromhost
todedicated
ordefault
. Attempting to make one of these unsupported tenancy changes results in anInvalidRequest
error code. - See Also:
-
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
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
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.
-
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 interfaceToCopyableBuilder<ModifyInstancePlacementRequest.Builder,
ModifyInstancePlacementRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-