com.amazonaws.services.ec2.model.CreateReplaceRootVolumeTaskRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.CreateReplaceRootVolumeTaskRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateReplaceRootVolumeTaskRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The ID of the instance for which to replace the root volume.
*
*/
private String instanceId;
/**
*
* The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a
* snapshot that you previously created from the original root volume.
*
*
* If you want to restore the replacement root volume to the initial launch state, or if you want to restore the
* replacement root volume from an AMI, omit this parameter.
*
*/
private String snapshotId;
/**
*
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a
* client token, a randomly generated token is used for the request to ensure idempotency. For more information, see
* Ensuring idempotency.
*
*/
private String clientToken;
/**
*
* The tags to apply to the root volume replacement task.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing
* information, architecture type, and virtualization type as that of the instance.
*
*
* If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its
* launch state, omit this parameter.
*
*/
private String imageId;
/**
*
* Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the original root
* volume after the replacement task completes, you must manually delete it when you no longer need it.
*
*/
private Boolean deleteReplacedRootVolume;
/**
*
* The ID of the instance for which to replace the root volume.
*
*
* @param instanceId
* The ID of the instance for which to replace the root volume.
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
*
* The ID of the instance for which to replace the root volume.
*
*
* @return The ID of the instance for which to replace the root volume.
*/
public String getInstanceId() {
return this.instanceId;
}
/**
*
* The ID of the instance for which to replace the root volume.
*
*
* @param instanceId
* The ID of the instance for which to replace the root volume.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReplaceRootVolumeTaskRequest withInstanceId(String instanceId) {
setInstanceId(instanceId);
return this;
}
/**
*
* The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a
* snapshot that you previously created from the original root volume.
*
*
* If you want to restore the replacement root volume to the initial launch state, or if you want to restore the
* replacement root volume from an AMI, omit this parameter.
*
*
* @param snapshotId
* The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a
* snapshot that you previously created from the original root volume.
*
* If you want to restore the replacement root volume to the initial launch state, or if you want to restore
* the replacement root volume from an AMI, omit this parameter.
*/
public void setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
}
/**
*
* The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a
* snapshot that you previously created from the original root volume.
*
*
* If you want to restore the replacement root volume to the initial launch state, or if you want to restore the
* replacement root volume from an AMI, omit this parameter.
*
*
* @return The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be
* a snapshot that you previously created from the original root volume.
*
* If you want to restore the replacement root volume to the initial launch state, or if you want to restore
* the replacement root volume from an AMI, omit this parameter.
*/
public String getSnapshotId() {
return this.snapshotId;
}
/**
*
* The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a
* snapshot that you previously created from the original root volume.
*
*
* If you want to restore the replacement root volume to the initial launch state, or if you want to restore the
* replacement root volume from an AMI, omit this parameter.
*
*
* @param snapshotId
* The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a
* snapshot that you previously created from the original root volume.
*
* If you want to restore the replacement root volume to the initial launch state, or if you want to restore
* the replacement root volume from an AMI, omit this parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReplaceRootVolumeTaskRequest withSnapshotId(String snapshotId) {
setSnapshotId(snapshotId);
return this;
}
/**
*
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a
* client token, a randomly generated token is used for the request to ensure idempotency. For more information, see
* Ensuring idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not
* specify a client token, a randomly generated token is used for the request to ensure idempotency. For more
* information, see Ensuring idempotency.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a
* client token, a randomly generated token is used for the request to ensure idempotency. For more information, see
* Ensuring idempotency.
*
*
* @return Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not
* specify a client token, a randomly generated token is used for the request to ensure idempotency. For
* more information, see Ensuring idempotency.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a
* client token, a randomly generated token is used for the request to ensure idempotency. For more information, see
* Ensuring idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not
* specify a client token, a randomly generated token is used for the request to ensure idempotency. For more
* information, see Ensuring idempotency.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReplaceRootVolumeTaskRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The tags to apply to the root volume replacement task.
*
*
* @return The tags to apply to the root volume replacement task.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The tags to apply to the root volume replacement task.
*
*
* @param tagSpecifications
* The tags to apply to the root volume replacement task.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The tags to apply to the root volume replacement task.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The tags to apply to the root volume replacement task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReplaceRootVolumeTaskRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The tags to apply to the root volume replacement task.
*
*
* @param tagSpecifications
* The tags to apply to the root volume replacement task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReplaceRootVolumeTaskRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
*
* The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing
* information, architecture type, and virtualization type as that of the instance.
*
*
* If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its
* launch state, omit this parameter.
*
*
* @param imageId
* The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code,
* billing information, architecture type, and virtualization type as that of the instance.
*
* If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to
* its launch state, omit this parameter.
*/
public void setImageId(String imageId) {
this.imageId = imageId;
}
/**
*
* The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing
* information, architecture type, and virtualization type as that of the instance.
*
*
* If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its
* launch state, omit this parameter.
*
*
* @return The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code,
* billing information, architecture type, and virtualization type as that of the instance.
*
* If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to
* its launch state, omit this parameter.
*/
public String getImageId() {
return this.imageId;
}
/**
*
* The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing
* information, architecture type, and virtualization type as that of the instance.
*
*
* If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its
* launch state, omit this parameter.
*
*
* @param imageId
* The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code,
* billing information, architecture type, and virtualization type as that of the instance.
*
* If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to
* its launch state, omit this parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReplaceRootVolumeTaskRequest withImageId(String imageId) {
setImageId(imageId);
return this;
}
/**
*
* Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the original root
* volume after the replacement task completes, you must manually delete it when you no longer need it.
*
*
* @param deleteReplacedRootVolume
* Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the
* original root volume after the replacement task completes, you must manually delete it when you no longer
* need it.
*/
public void setDeleteReplacedRootVolume(Boolean deleteReplacedRootVolume) {
this.deleteReplacedRootVolume = deleteReplacedRootVolume;
}
/**
*
* Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the original root
* volume after the replacement task completes, you must manually delete it when you no longer need it.
*
*
* @return Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the
* original root volume after the replacement task completes, you must manually delete it when you no longer
* need it.
*/
public Boolean getDeleteReplacedRootVolume() {
return this.deleteReplacedRootVolume;
}
/**
*
* Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the original root
* volume after the replacement task completes, you must manually delete it when you no longer need it.
*
*
* @param deleteReplacedRootVolume
* Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the
* original root volume after the replacement task completes, you must manually delete it when you no longer
* need it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReplaceRootVolumeTaskRequest withDeleteReplacedRootVolume(Boolean deleteReplacedRootVolume) {
setDeleteReplacedRootVolume(deleteReplacedRootVolume);
return this;
}
/**
*
* Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the original root
* volume after the replacement task completes, you must manually delete it when you no longer need it.
*
*
* @return Indicates whether to automatically delete the original root volume after the root volume replacement task
* completes. To delete the original root volume, specify true. If you choose to keep the
* original root volume after the replacement task completes, you must manually delete it when you no longer
* need it.
*/
public Boolean isDeleteReplacedRootVolume() {
return this.deleteReplacedRootVolume;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new CreateReplaceRootVolumeTaskRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getInstanceId() != null)
sb.append("InstanceId: ").append(getInstanceId()).append(",");
if (getSnapshotId() != null)
sb.append("SnapshotId: ").append(getSnapshotId()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications()).append(",");
if (getImageId() != null)
sb.append("ImageId: ").append(getImageId()).append(",");
if (getDeleteReplacedRootVolume() != null)
sb.append("DeleteReplacedRootVolume: ").append(getDeleteReplacedRootVolume());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateReplaceRootVolumeTaskRequest == false)
return false;
CreateReplaceRootVolumeTaskRequest other = (CreateReplaceRootVolumeTaskRequest) obj;
if (other.getInstanceId() == null ^ this.getInstanceId() == null)
return false;
if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false)
return false;
if (other.getSnapshotId() == null ^ this.getSnapshotId() == null)
return false;
if (other.getSnapshotId() != null && other.getSnapshotId().equals(this.getSnapshotId()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
if (other.getImageId() == null ^ this.getImageId() == null)
return false;
if (other.getImageId() != null && other.getImageId().equals(this.getImageId()) == false)
return false;
if (other.getDeleteReplacedRootVolume() == null ^ this.getDeleteReplacedRootVolume() == null)
return false;
if (other.getDeleteReplacedRootVolume() != null && other.getDeleteReplacedRootVolume().equals(this.getDeleteReplacedRootVolume()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
hashCode = prime * hashCode + ((getSnapshotId() == null) ? 0 : getSnapshotId().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
hashCode = prime * hashCode + ((getImageId() == null) ? 0 : getImageId().hashCode());
hashCode = prime * hashCode + ((getDeleteReplacedRootVolume() == null) ? 0 : getDeleteReplacedRootVolume().hashCode());
return hashCode;
}
@Override
public CreateReplaceRootVolumeTaskRequest clone() {
return (CreateReplaceRootVolumeTaskRequest) super.clone();
}
}