com.amazonaws.services.ec2.model.Placement Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes the placement of an instance.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Placement implements Serializable, Cloneable {
/**
*
* 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 for CreateFleet.
*
*/
private String availabilityZone;
/**
*
* The affinity setting for the instance on the Dedicated Host.
*
*
* This parameter is not supported for CreateFleet or ImportInstance.
*
*/
private String affinity;
/**
*
* The name of the placement group that the instance is in. If you specify GroupName, you can't specify
* GroupId.
*
*/
private String groupName;
/**
*
* The number of the partition that the instance is in. Valid only if the placement group strategy is set to
* partition.
*
*
* This parameter is not supported for CreateFleet.
*
*/
private Integer partitionNumber;
/**
*
* The ID of the Dedicated Host on which the instance resides.
*
*
* This parameter is not supported for CreateFleet or ImportInstance.
*
*/
private String hostId;
/**
*
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
*
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance or for
* T3 instances that are configured for the unlimited CPU credit option.
*
*/
private String tenancy;
/**
*
* Reserved for future use.
*
*/
private String spreadDomain;
/**
*
* The ARN of the host resource group in which to launch the instances.
*
*
* If you specify this parameter, either omit the Tenancy parameter or set it to host.
*
*
* This parameter is not supported for CreateFleet.
*
*/
private String hostResourceGroupArn;
/**
*
* The ID of the placement group that the instance is in. If you specify GroupId, you can't specify
* GroupName.
*
*/
private String groupId;
/**
* Default constructor for Placement object. Callers should use the setter or fluent setter (with...) methods to
* initialize the object after creating it.
*/
public Placement() {
}
/**
* Constructs a new Placement object. Callers should use the setter or fluent setter (with...) methods to initialize
* any additional object members.
*
* @param 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 for CreateFleet.
*/
public Placement(String availabilityZone) {
setAvailabilityZone(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 for CreateFleet.
*
*
* @param 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 for CreateFleet.
*/
public void setAvailabilityZone(String availabilityZone) {
this.availabilityZone = 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 for CreateFleet.
*
*
* @return 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 for CreateFleet.
*/
public String getAvailabilityZone() {
return this.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 for CreateFleet.
*
*
* @param 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 for CreateFleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Placement withAvailabilityZone(String availabilityZone) {
setAvailabilityZone(availabilityZone);
return this;
}
/**
*
* The affinity setting for the instance on the Dedicated Host.
*
*
* This parameter is not supported for CreateFleet or ImportInstance.
*
*
* @param affinity
* The affinity setting for the instance on the Dedicated Host.
*
* This parameter is not supported for CreateFleet or ImportInstance.
*/
public void setAffinity(String affinity) {
this.affinity = affinity;
}
/**
*
* The affinity setting for the instance on the Dedicated Host.
*
*
* This parameter is not supported for CreateFleet or ImportInstance.
*
*
* @return The affinity setting for the instance on the Dedicated Host.
*
* This parameter is not supported for CreateFleet or ImportInstance.
*/
public String getAffinity() {
return this.affinity;
}
/**
*
* The affinity setting for the instance on the Dedicated Host.
*
*
* This parameter is not supported for CreateFleet or ImportInstance.
*
*
* @param affinity
* The affinity setting for the instance on the Dedicated Host.
*
* This parameter is not supported for CreateFleet or ImportInstance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Placement withAffinity(String affinity) {
setAffinity(affinity);
return this;
}
/**
*
* The name of the placement group that the instance is in. If you specify GroupName, you can't specify
* GroupId.
*
*
* @param groupName
* The name of the placement group that the instance is in. If you specify GroupName, you can't
* specify GroupId.
*/
public void setGroupName(String groupName) {
this.groupName = groupName;
}
/**
*
* The name of the placement group that the instance is in. If you specify GroupName, you can't specify
* GroupId.
*
*
* @return The name of the placement group that the instance is in. If you specify GroupName, you can't
* specify GroupId.
*/
public String getGroupName() {
return this.groupName;
}
/**
*
* The name of the placement group that the instance is in. If you specify GroupName, you can't specify
* GroupId.
*
*
* @param groupName
* The name of the placement group that the instance is in. If you specify GroupName, you can't
* specify GroupId.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Placement withGroupName(String groupName) {
setGroupName(groupName);
return this;
}
/**
*
* The number of the partition that the instance is in. Valid only if the placement group strategy is set to
* partition.
*
*
* This parameter is not supported for CreateFleet.
*
*
* @param partitionNumber
* The number of the partition that the instance is in. Valid only if the placement group strategy is set to
* partition.
*
* This parameter is not supported for CreateFleet.
*/
public void setPartitionNumber(Integer partitionNumber) {
this.partitionNumber = partitionNumber;
}
/**
*
* The number of the partition that the instance is in. Valid only if the placement group strategy is set to
* partition.
*
*
* This parameter is not supported for CreateFleet.
*
*
* @return The number of the partition that the instance is in. Valid only if the placement group strategy is set to
* partition.
*
* This parameter is not supported for CreateFleet.
*/
public Integer getPartitionNumber() {
return this.partitionNumber;
}
/**
*
* The number of the partition that the instance is in. Valid only if the placement group strategy is set to
* partition.
*
*
* This parameter is not supported for CreateFleet.
*
*
* @param partitionNumber
* The number of the partition that the instance is in. Valid only if the placement group strategy is set to
* partition.
*
* This parameter is not supported for CreateFleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Placement withPartitionNumber(Integer partitionNumber) {
setPartitionNumber(partitionNumber);
return this;
}
/**
*
* The ID of the Dedicated Host on which the instance resides.
*
*
* This parameter is not supported for CreateFleet or ImportInstance.
*
*
* @param hostId
* The ID of the Dedicated Host on which the instance resides.
*
* This parameter is not supported for CreateFleet or ImportInstance.
*/
public void setHostId(String hostId) {
this.hostId = hostId;
}
/**
*
* The ID of the Dedicated Host on which the instance resides.
*
*
* This parameter is not supported for CreateFleet or ImportInstance.
*
*
* @return The ID of the Dedicated Host on which the instance resides.
*
* This parameter is not supported for CreateFleet or ImportInstance.
*/
public String getHostId() {
return this.hostId;
}
/**
*
* The ID of the Dedicated Host on which the instance resides.
*
*
* This parameter is not supported for CreateFleet or ImportInstance.
*
*
* @param hostId
* The ID of the Dedicated Host on which the instance resides.
*
* This parameter is not supported for CreateFleet or ImportInstance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Placement withHostId(String hostId) {
setHostId(hostId);
return this;
}
/**
*
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
*
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance or for
* T3 instances that are configured for the unlimited CPU credit option.
*
*
* @param tenancy
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant
* hardware.
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance
* or for T3 instances that are configured for the unlimited CPU credit option.
* @see Tenancy
*/
public void setTenancy(String tenancy) {
this.tenancy = tenancy;
}
/**
*
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
*
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance or for
* T3 instances that are configured for the unlimited CPU credit option.
*
*
* @return The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant
* hardware.
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance
* or for T3 instances that are configured for the unlimited CPU credit option.
* @see Tenancy
*/
public String getTenancy() {
return this.tenancy;
}
/**
*
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
*
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance or for
* T3 instances that are configured for the unlimited CPU credit option.
*
*
* @param tenancy
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant
* hardware.
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance
* or for T3 instances that are configured for the unlimited CPU credit option.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Tenancy
*/
public Placement withTenancy(String tenancy) {
setTenancy(tenancy);
return this;
}
/**
*
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
*
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance or for
* T3 instances that are configured for the unlimited CPU credit option.
*
*
* @param tenancy
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant
* hardware.
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance
* or for T3 instances that are configured for the unlimited CPU credit option.
* @see Tenancy
*/
public void setTenancy(Tenancy tenancy) {
withTenancy(tenancy);
}
/**
*
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
*
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance or for
* T3 instances that are configured for the unlimited CPU credit option.
*
*
* @param tenancy
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant
* hardware.
*
* This parameter is not supported for CreateFleet. The
* host tenancy is not supported for ImportInstance
* or for T3 instances that are configured for the unlimited CPU credit option.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Tenancy
*/
public Placement withTenancy(Tenancy tenancy) {
this.tenancy = tenancy.toString();
return this;
}
/**
*
* Reserved for future use.
*
*
* @param spreadDomain
* Reserved for future use.
*/
public void setSpreadDomain(String spreadDomain) {
this.spreadDomain = spreadDomain;
}
/**
*
* Reserved for future use.
*
*
* @return Reserved for future use.
*/
public String getSpreadDomain() {
return this.spreadDomain;
}
/**
*
* Reserved for future use.
*
*
* @param spreadDomain
* Reserved for future use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Placement withSpreadDomain(String spreadDomain) {
setSpreadDomain(spreadDomain);
return this;
}
/**
*
* The ARN of the host resource group in which to launch the instances.
*
*
* If you specify this parameter, either omit the Tenancy parameter or set it to host.
*
*
* This parameter is not supported for CreateFleet.
*
*
* @param hostResourceGroupArn
* The ARN of the host resource group in which to launch the instances.
*
* If you specify this parameter, either omit the Tenancy parameter or set it to host.
*
*
* This parameter is not supported for CreateFleet.
*/
public void setHostResourceGroupArn(String hostResourceGroupArn) {
this.hostResourceGroupArn = hostResourceGroupArn;
}
/**
*
* The ARN of the host resource group in which to launch the instances.
*
*
* If you specify this parameter, either omit the Tenancy parameter or set it to host.
*
*
* This parameter is not supported for CreateFleet.
*
*
* @return The ARN of the host resource group in which to launch the instances.
*
* If you specify this parameter, either omit the Tenancy parameter or set it to host.
*
*
* This parameter is not supported for CreateFleet.
*/
public String getHostResourceGroupArn() {
return this.hostResourceGroupArn;
}
/**
*
* The ARN of the host resource group in which to launch the instances.
*
*
* If you specify this parameter, either omit the Tenancy parameter or set it to host.
*
*
* This parameter is not supported for CreateFleet.
*
*
* @param hostResourceGroupArn
* The ARN of the host resource group in which to launch the instances.
*
* If you specify this parameter, either omit the Tenancy parameter or set it to host.
*
*
* This parameter is not supported for CreateFleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Placement withHostResourceGroupArn(String hostResourceGroupArn) {
setHostResourceGroupArn(hostResourceGroupArn);
return this;
}
/**
*
* The ID of the placement group that the instance is in. If you specify GroupId, you can't specify
* GroupName.
*
*
* @param groupId
* The ID of the placement group that the instance is in. If you specify GroupId, you can't
* specify GroupName.
*/
public void setGroupId(String groupId) {
this.groupId = groupId;
}
/**
*
* The ID of the placement group that the instance is in. If you specify GroupId, you can't specify
* GroupName.
*
*
* @return The ID of the placement group that the instance is in. If you specify GroupId, you can't
* specify GroupName.
*/
public String getGroupId() {
return this.groupId;
}
/**
*
* The ID of the placement group that the instance is in. If you specify GroupId, you can't specify
* GroupName.
*
*
* @param groupId
* The ID of the placement group that the instance is in. If you specify GroupId, you can't
* specify GroupName.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Placement withGroupId(String groupId) {
setGroupId(groupId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAvailabilityZone() != null)
sb.append("AvailabilityZone: ").append(getAvailabilityZone()).append(",");
if (getAffinity() != null)
sb.append("Affinity: ").append(getAffinity()).append(",");
if (getGroupName() != null)
sb.append("GroupName: ").append(getGroupName()).append(",");
if (getPartitionNumber() != null)
sb.append("PartitionNumber: ").append(getPartitionNumber()).append(",");
if (getHostId() != null)
sb.append("HostId: ").append(getHostId()).append(",");
if (getTenancy() != null)
sb.append("Tenancy: ").append(getTenancy()).append(",");
if (getSpreadDomain() != null)
sb.append("SpreadDomain: ").append(getSpreadDomain()).append(",");
if (getHostResourceGroupArn() != null)
sb.append("HostResourceGroupArn: ").append(getHostResourceGroupArn()).append(",");
if (getGroupId() != null)
sb.append("GroupId: ").append(getGroupId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Placement == false)
return false;
Placement other = (Placement) obj;
if (other.getAvailabilityZone() == null ^ this.getAvailabilityZone() == null)
return false;
if (other.getAvailabilityZone() != null && other.getAvailabilityZone().equals(this.getAvailabilityZone()) == false)
return false;
if (other.getAffinity() == null ^ this.getAffinity() == null)
return false;
if (other.getAffinity() != null && other.getAffinity().equals(this.getAffinity()) == false)
return false;
if (other.getGroupName() == null ^ this.getGroupName() == null)
return false;
if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == false)
return false;
if (other.getPartitionNumber() == null ^ this.getPartitionNumber() == null)
return false;
if (other.getPartitionNumber() != null && other.getPartitionNumber().equals(this.getPartitionNumber()) == false)
return false;
if (other.getHostId() == null ^ this.getHostId() == null)
return false;
if (other.getHostId() != null && other.getHostId().equals(this.getHostId()) == false)
return false;
if (other.getTenancy() == null ^ this.getTenancy() == null)
return false;
if (other.getTenancy() != null && other.getTenancy().equals(this.getTenancy()) == false)
return false;
if (other.getSpreadDomain() == null ^ this.getSpreadDomain() == null)
return false;
if (other.getSpreadDomain() != null && other.getSpreadDomain().equals(this.getSpreadDomain()) == false)
return false;
if (other.getHostResourceGroupArn() == null ^ this.getHostResourceGroupArn() == null)
return false;
if (other.getHostResourceGroupArn() != null && other.getHostResourceGroupArn().equals(this.getHostResourceGroupArn()) == false)
return false;
if (other.getGroupId() == null ^ this.getGroupId() == null)
return false;
if (other.getGroupId() != null && other.getGroupId().equals(this.getGroupId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAvailabilityZone() == null) ? 0 : getAvailabilityZone().hashCode());
hashCode = prime * hashCode + ((getAffinity() == null) ? 0 : getAffinity().hashCode());
hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().hashCode());
hashCode = prime * hashCode + ((getPartitionNumber() == null) ? 0 : getPartitionNumber().hashCode());
hashCode = prime * hashCode + ((getHostId() == null) ? 0 : getHostId().hashCode());
hashCode = prime * hashCode + ((getTenancy() == null) ? 0 : getTenancy().hashCode());
hashCode = prime * hashCode + ((getSpreadDomain() == null) ? 0 : getSpreadDomain().hashCode());
hashCode = prime * hashCode + ((getHostResourceGroupArn() == null) ? 0 : getHostResourceGroupArn().hashCode());
hashCode = prime * hashCode + ((getGroupId() == null) ? 0 : getGroupId().hashCode());
return hashCode;
}
@Override
public Placement clone() {
try {
return (Placement) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}