com.amazonaws.services.ec2.model.BlockDeviceMapping Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2015 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;
/**
*
* Describes a block device mapping.
*
*/
public class BlockDeviceMapping implements Serializable, Cloneable {
/**
* The virtual device name (ephemeralN). Instance store
* volumes are numbered starting from 0. An instance type with 2
* available instance store volumes can specify mappings for
* ephemeral0 and ephemeral1.The number of
* available instance store volumes depends on the instance type. After
* you connect to the instance, you must mount the volume.
* Constraints: For M3 instances, you must specify instance store
* volumes in the block device mapping for the instance. When you launch
* an M3 instance, we ignore any instance store volumes specified in the
* block device mapping for the AMI.
*/
private String virtualName;
/**
* The device name exposed to the instance (for example,
* /dev/sdh or xvdh).
*/
private String deviceName;
/**
* Parameters used to automatically set up EBS volumes when the instance
* is launched.
*/
private EbsBlockDevice ebs;
/**
* Suppresses the specified device included in the block device mapping
* of the AMI.
*/
private String noDevice;
/**
* The virtual device name (ephemeralN). Instance store
* volumes are numbered starting from 0. An instance type with 2
* available instance store volumes can specify mappings for
* ephemeral0 and ephemeral1.The number of
* available instance store volumes depends on the instance type. After
* you connect to the instance, you must mount the volume.
*
Constraints: For M3 instances, you must specify instance store
* volumes in the block device mapping for the instance. When you launch
* an M3 instance, we ignore any instance store volumes specified in the
* block device mapping for the AMI.
*
* @return The virtual device name (ephemeralN). Instance store
* volumes are numbered starting from 0. An instance type with 2
* available instance store volumes can specify mappings for
* ephemeral0 and ephemeral1.The number of
* available instance store volumes depends on the instance type. After
* you connect to the instance, you must mount the volume.
*
Constraints: For M3 instances, you must specify instance store
* volumes in the block device mapping for the instance. When you launch
* an M3 instance, we ignore any instance store volumes specified in the
* block device mapping for the AMI.
*/
public String getVirtualName() {
return virtualName;
}
/**
* The virtual device name (ephemeralN). Instance store
* volumes are numbered starting from 0. An instance type with 2
* available instance store volumes can specify mappings for
* ephemeral0 and ephemeral1.The number of
* available instance store volumes depends on the instance type. After
* you connect to the instance, you must mount the volume.
*
Constraints: For M3 instances, you must specify instance store
* volumes in the block device mapping for the instance. When you launch
* an M3 instance, we ignore any instance store volumes specified in the
* block device mapping for the AMI.
*
* @param virtualName The virtual device name (ephemeralN). Instance store
* volumes are numbered starting from 0. An instance type with 2
* available instance store volumes can specify mappings for
* ephemeral0 and ephemeral1.The number of
* available instance store volumes depends on the instance type. After
* you connect to the instance, you must mount the volume.
*
Constraints: For M3 instances, you must specify instance store
* volumes in the block device mapping for the instance. When you launch
* an M3 instance, we ignore any instance store volumes specified in the
* block device mapping for the AMI.
*/
public void setVirtualName(String virtualName) {
this.virtualName = virtualName;
}
/**
* The virtual device name (ephemeralN). Instance store
* volumes are numbered starting from 0. An instance type with 2
* available instance store volumes can specify mappings for
* ephemeral0 and ephemeral1.The number of
* available instance store volumes depends on the instance type. After
* you connect to the instance, you must mount the volume.
*
Constraints: For M3 instances, you must specify instance store
* volumes in the block device mapping for the instance. When you launch
* an M3 instance, we ignore any instance store volumes specified in the
* block device mapping for the AMI.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param virtualName The virtual device name (ephemeralN). Instance store
* volumes are numbered starting from 0. An instance type with 2
* available instance store volumes can specify mappings for
* ephemeral0 and ephemeral1.The number of
* available instance store volumes depends on the instance type. After
* you connect to the instance, you must mount the volume.
*
Constraints: For M3 instances, you must specify instance store
* volumes in the block device mapping for the instance. When you launch
* an M3 instance, we ignore any instance store volumes specified in the
* block device mapping for the AMI.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BlockDeviceMapping withVirtualName(String virtualName) {
this.virtualName = virtualName;
return this;
}
/**
* The device name exposed to the instance (for example,
* /dev/sdh or xvdh).
*
* @return The device name exposed to the instance (for example,
* /dev/sdh or xvdh).
*/
public String getDeviceName() {
return deviceName;
}
/**
* The device name exposed to the instance (for example,
* /dev/sdh or xvdh).
*
* @param deviceName The device name exposed to the instance (for example,
* /dev/sdh or xvdh).
*/
public void setDeviceName(String deviceName) {
this.deviceName = deviceName;
}
/**
* The device name exposed to the instance (for example,
* /dev/sdh or xvdh).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param deviceName The device name exposed to the instance (for example,
* /dev/sdh or xvdh).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BlockDeviceMapping withDeviceName(String deviceName) {
this.deviceName = deviceName;
return this;
}
/**
* Parameters used to automatically set up EBS volumes when the instance
* is launched.
*
* @return Parameters used to automatically set up EBS volumes when the instance
* is launched.
*/
public EbsBlockDevice getEbs() {
return ebs;
}
/**
* Parameters used to automatically set up EBS volumes when the instance
* is launched.
*
* @param ebs Parameters used to automatically set up EBS volumes when the instance
* is launched.
*/
public void setEbs(EbsBlockDevice ebs) {
this.ebs = ebs;
}
/**
* Parameters used to automatically set up EBS volumes when the instance
* is launched.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param ebs Parameters used to automatically set up EBS volumes when the instance
* is launched.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BlockDeviceMapping withEbs(EbsBlockDevice ebs) {
this.ebs = ebs;
return this;
}
/**
* Suppresses the specified device included in the block device mapping
* of the AMI.
*
* @return Suppresses the specified device included in the block device mapping
* of the AMI.
*/
public String getNoDevice() {
return noDevice;
}
/**
* Suppresses the specified device included in the block device mapping
* of the AMI.
*
* @param noDevice Suppresses the specified device included in the block device mapping
* of the AMI.
*/
public void setNoDevice(String noDevice) {
this.noDevice = noDevice;
}
/**
* Suppresses the specified device included in the block device mapping
* of the AMI.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param noDevice Suppresses the specified device included in the block device mapping
* of the AMI.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BlockDeviceMapping withNoDevice(String noDevice) {
this.noDevice = noDevice;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getVirtualName() != null) sb.append("VirtualName: " + getVirtualName() + ",");
if (getDeviceName() != null) sb.append("DeviceName: " + getDeviceName() + ",");
if (getEbs() != null) sb.append("Ebs: " + getEbs() + ",");
if (getNoDevice() != null) sb.append("NoDevice: " + getNoDevice() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVirtualName() == null) ? 0 : getVirtualName().hashCode());
hashCode = prime * hashCode + ((getDeviceName() == null) ? 0 : getDeviceName().hashCode());
hashCode = prime * hashCode + ((getEbs() == null) ? 0 : getEbs().hashCode());
hashCode = prime * hashCode + ((getNoDevice() == null) ? 0 : getNoDevice().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof BlockDeviceMapping == false) return false;
BlockDeviceMapping other = (BlockDeviceMapping)obj;
if (other.getVirtualName() == null ^ this.getVirtualName() == null) return false;
if (other.getVirtualName() != null && other.getVirtualName().equals(this.getVirtualName()) == false) return false;
if (other.getDeviceName() == null ^ this.getDeviceName() == null) return false;
if (other.getDeviceName() != null && other.getDeviceName().equals(this.getDeviceName()) == false) return false;
if (other.getEbs() == null ^ this.getEbs() == null) return false;
if (other.getEbs() != null && other.getEbs().equals(this.getEbs()) == false) return false;
if (other.getNoDevice() == null ^ this.getNoDevice() == null) return false;
if (other.getNoDevice() != null && other.getNoDevice().equals(this.getNoDevice()) == false) return false;
return true;
}
@Override
public BlockDeviceMapping clone() {
try {
return (BlockDeviceMapping) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!",
e);
}
}
}