com.amazonaws.services.ec2.model

Class CreateReplaceRootVolumeTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateReplaceRootVolumeTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateReplaceRootVolumeTaskRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateReplaceRootVolumeTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CreateReplaceRootVolumeTaskRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateReplaceRootVolumeTaskRequest()

Method Summary

Modifier and Type	Method and Description
CreateReplaceRootVolumeTaskRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
Boolean	getDeleteReplacedRootVolume() Indicates whether to automatically delete the original root volume after the root volume replacement task completes.
Request<CreateReplaceRootVolumeTaskRequest>	getDryRunRequest() This method is intended for internal use only.
String	getImageId() The ID of the AMI to use to restore the root volume.
String	getInstanceId() The ID of the instance for which to replace the root volume.
String	getSnapshotId() The ID of the snapshot from which to restore the replacement root volume.
List<TagSpecification>	getTagSpecifications() The tags to apply to the root volume replacement task.
int	hashCode()
Boolean	isDeleteReplacedRootVolume() Indicates whether to automatically delete the original root volume after the root volume replacement task completes.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
void	setDeleteReplacedRootVolume(Boolean deleteReplacedRootVolume) Indicates whether to automatically delete the original root volume after the root volume replacement task completes.
void	setImageId(String imageId) The ID of the AMI to use to restore the root volume.
void	setInstanceId(String instanceId) The ID of the instance for which to replace the root volume.
void	setSnapshotId(String snapshotId) The ID of the snapshot from which to restore the replacement root volume.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the root volume replacement task.
String	toString() Returns a string representation of this object.
CreateReplaceRootVolumeTaskRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
CreateReplaceRootVolumeTaskRequest	withDeleteReplacedRootVolume(Boolean deleteReplacedRootVolume) Indicates whether to automatically delete the original root volume after the root volume replacement task completes.
CreateReplaceRootVolumeTaskRequest	withImageId(String imageId) The ID of the AMI to use to restore the root volume.
CreateReplaceRootVolumeTaskRequest	withInstanceId(String instanceId) The ID of the instance for which to replace the root volume.
CreateReplaceRootVolumeTaskRequest	withSnapshotId(String snapshotId) The ID of the snapshot from which to restore the replacement root volume.
CreateReplaceRootVolumeTaskRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the root volume replacement task.
CreateReplaceRootVolumeTaskRequest	withTagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the root volume replacement task.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateReplaceRootVolumeTaskRequest

public CreateReplaceRootVolumeTaskRequest()

Method Detail

setInstanceId

public void setInstanceId(String instanceId)

The ID of the instance for which to replace the root volume.

Parameters:

instanceId - The ID of the instance for which to replace the root volume.

getInstanceId

public String getInstanceId()

The ID of the instance for which to replace the root volume.

Returns:

The ID of the instance for which to replace the root volume.

withInstanceId

public CreateReplaceRootVolumeTaskRequest withInstanceId(String instanceId)

The ID of the instance for which to replace the root volume.

Parameters:

instanceId - The ID of the instance for which to replace the root volume.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSnapshotId

public void setSnapshotId(String 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.

Parameters:

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.

getSnapshotId

public String getSnapshotId()

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.

Returns:

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.

withSnapshotId

public CreateReplaceRootVolumeTaskRequest withSnapshotId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String 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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

Returns:

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.

withClientToken

public CreateReplaceRootVolumeTaskRequest withClientToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to apply to the root volume replacement task.

Returns:

The tags to apply to the root volume replacement task.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the root volume replacement task.

Parameters:

tagSpecifications - The tags to apply to the root volume replacement task.

withTagSpecifications

public CreateReplaceRootVolumeTaskRequest withTagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the root volume replacement task.

NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

tagSpecifications - The tags to apply to the root volume replacement task.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagSpecifications

public CreateReplaceRootVolumeTaskRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the root volume replacement task.

Parameters:

tagSpecifications - The tags to apply to the root volume replacement task.

Returns:

Returns a reference to this object so that method calls can be chained together.

setImageId

public void setImageId(String 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.

Parameters:

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.

getImageId

public String getImageId()

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.

Returns:

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.

withImageId

public CreateReplaceRootVolumeTaskRequest withImageId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeleteReplacedRootVolume

public void setDeleteReplacedRootVolume(Boolean 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.

Parameters:

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.

getDeleteReplacedRootVolume

public Boolean getDeleteReplacedRootVolume()

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.

Returns:

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.

withDeleteReplacedRootVolume

public CreateReplaceRootVolumeTaskRequest withDeleteReplacedRootVolume(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDeleteReplacedRootVolume

public Boolean isDeleteReplacedRootVolume()

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.

Returns:

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.

getDryRunRequest

public Request<CreateReplaceRootVolumeTaskRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateReplaceRootVolumeTaskRequest>

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 CreateReplaceRootVolumeTaskRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()