Placement (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.Placement

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Placement
extends Object
implements Serializable, Cloneable

Describes the placement of an instance.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Placement()
Default constructor for Placement object.

Placement(String availabilityZone)
Constructs a new Placement object.

Constructors
Constructor and Description
`Placement()` Default constructor for Placement object.
`Placement(String availabilityZone)` Constructs a new Placement object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Placement`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAffinity()` The affinity setting for the instance on the Dedicated Host.
`String`	`getAvailabilityZone()` The Availability Zone of the instance.
`String`	`getGroupName()` The name of the placement group the instance is in.
`String`	`getHostId()` The ID of the Dedicated Host on which the instance resides.
`String`	`getHostResourceGroupArn()` The ARN of the host resource group in which to launch the instances.
`Integer`	`getPartitionNumber()` The number of the partition the instance is in.
`String`	`getSpreadDomain()` Reserved for future use.
`String`	`getTenancy()` The tenancy of the instance (if the instance is running in a VPC).
`int`	`hashCode()`
`void`	`setAffinity(String affinity)` The affinity setting for the instance on the Dedicated Host.
`void`	`setAvailabilityZone(String availabilityZone)` The Availability Zone of the instance.
`void`	`setGroupName(String groupName)` The name of the placement group the instance is in.
`void`	`setHostId(String hostId)` The ID of the Dedicated Host on which the instance resides.
`void`	`setHostResourceGroupArn(String hostResourceGroupArn)` The ARN of the host resource group in which to launch the instances.
`void`	`setPartitionNumber(Integer partitionNumber)` The number of the partition the instance is in.
`void`	`setSpreadDomain(String spreadDomain)` Reserved for future use.
`void`	`setTenancy(String tenancy)` The tenancy of the instance (if the instance is running in a VPC).
`void`	`setTenancy(Tenancy tenancy)` The tenancy of the instance (if the instance is running in a VPC).
`String`	`toString()` Returns a string representation of this object.
`Placement`	`withAffinity(String affinity)` The affinity setting for the instance on the Dedicated Host.
`Placement`	`withAvailabilityZone(String availabilityZone)` The Availability Zone of the instance.
`Placement`	`withGroupName(String groupName)` The name of the placement group the instance is in.
`Placement`	`withHostId(String hostId)` The ID of the Dedicated Host on which the instance resides.
`Placement`	`withHostResourceGroupArn(String hostResourceGroupArn)` The ARN of the host resource group in which to launch the instances.
`Placement`	`withPartitionNumber(Integer partitionNumber)` The number of the partition the instance is in.
`Placement`	`withSpreadDomain(String spreadDomain)` Reserved for future use.
`Placement`	`withTenancy(String tenancy)` The tenancy of the instance (if the instance is running in a VPC).
`Placement`	`withTenancy(Tenancy tenancy)` The tenancy of the instance (if the instance is running in a VPC).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Placement
```
public Placement()
```
    Default constructor for Placement object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - Placement
```
public Placement(String availabilityZone)
```
    Constructs a new Placement object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    availabilityZone - The Availability Zone of the instance.
    
    If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
    
    This parameter is not supported by CreateFleet.
- Method Detail
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    The Availability Zone of the instance.
    
    If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    availabilityZone - The Availability Zone of the instance.
    
    If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
    
    This parameter is not supported by CreateFleet.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    The Availability Zone of the instance.
    
    If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    The Availability Zone of the instance.
    
    If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
    
    This parameter is not supported by CreateFleet.
  - withAvailabilityZone
```
public Placement withAvailabilityZone(String availabilityZone)
```
    The Availability Zone of the instance.
    
    If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    availabilityZone - The Availability Zone of the instance.
    
    If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAffinity
```
public void setAffinity(String affinity)
```
    The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    affinity - The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
  - getAffinity
```
public String getAffinity()
```
    The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
  - withAffinity
```
public Placement withAffinity(String affinity)
```
    The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    affinity - The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGroupName
```
public void setGroupName(String groupName)
```
    The name of the placement group the instance is in.
    
    Parameters:
    
    groupName - The name of the placement group the instance is in.
  - getGroupName
```
public String getGroupName()
```
    The name of the placement group the instance is in.
    
    Returns:
    
    The name of the placement group the instance is in.
  - withGroupName
```
public Placement withGroupName(String groupName)
```
    The name of the placement group the instance is in.
    
    Parameters:
    
    groupName - The name of the placement group the instance is in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPartitionNumber
```
public void setPartitionNumber(Integer partitionNumber)
```
    The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    partitionNumber - The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
    
    This parameter is not supported by CreateFleet.
  - getPartitionNumber
```
public Integer getPartitionNumber()
```
    The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
    
    This parameter is not supported by CreateFleet.
  - withPartitionNumber
```
public Placement withPartitionNumber(Integer partitionNumber)
```
    The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    partitionNumber - The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostId
```
public void setHostId(String hostId)
```
    The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    hostId - The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
  - getHostId
```
public String getHostId()
```
    The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
  - withHostId
```
public Placement withHostId(String hostId)
```
    The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    hostId - The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTenancy
```
public void setTenancy(String tenancy)
```
    The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    Parameters:
    
    tenancy - The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    See Also:
    
    Tenancy
  - getTenancy
```
public String getTenancy()
```
    The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    Returns:
    
    The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    See Also:
    
    Tenancy
  - withTenancy
```
public Placement withTenancy(String tenancy)
```
    The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    Parameters:
    
    tenancy - The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Tenancy
  - setTenancy
```
public void setTenancy(Tenancy tenancy)
```
    The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    Parameters:
    
    tenancy - The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    See Also:
    
    Tenancy
  - withTenancy
```
public Placement withTenancy(Tenancy tenancy)
```
    The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    Parameters:
    
    tenancy - The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    
    This parameter is not supported by CreateFleet.
    
    T3 instances that use the unlimited CPU credit option do not support host tenancy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Tenancy
  - setSpreadDomain
```
public void setSpreadDomain(String spreadDomain)
```
    Reserved for future use.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    spreadDomain - Reserved for future use.
    
    This parameter is not supported by CreateFleet.
  - getSpreadDomain
```
public String getSpreadDomain()
```
    Reserved for future use.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    Reserved for future use.
    
    This parameter is not supported by CreateFleet.
  - withSpreadDomain
```
public Placement withSpreadDomain(String spreadDomain)
```
    Reserved for future use.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    spreadDomain - Reserved for future use.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostResourceGroupArn
```
public void setHostResourceGroupArn(String hostResourceGroupArn)
```
    The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    hostResourceGroupArn - The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
    
    This parameter is not supported by CreateFleet.
  - getHostResourceGroupArn
```
public String getHostResourceGroupArn()
```
    The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
    
    This parameter is not supported by CreateFleet.
  - withHostResourceGroupArn
```
public Placement withHostResourceGroupArn(String hostResourceGroupArn)
```
    The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
    
    This parameter is not supported by CreateFleet.
    
    Parameters:
    
    hostResourceGroupArn - The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
    
    This parameter is not supported by CreateFleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Placement clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class Placement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Placement

Placement

Method Detail

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

setAffinity

getAffinity

withAffinity

setGroupName

getGroupName

withGroupName

setPartitionNumber

getPartitionNumber

withPartitionNumber

setHostId

getHostId

withHostId

setTenancy

getTenancy

withTenancy

setTenancy

withTenancy

setSpreadDomain

getSpreadDomain

withSpreadDomain

setHostResourceGroupArn

getHostResourceGroupArn

withHostResourceGroupArn

toString

equals

hashCode

clone