| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.EC2.CreateReplaceRootVolumeTask
Description
Replaces the EBS-backed root volume for a running instance with a new
volume that is restored to the original root volume's launch state,
that is restored to a specific snapshot taken from the original root
volume, or that is restored from an AMI that has the same key
characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
Synopsis
- data CreateReplaceRootVolumeTask = CreateReplaceRootVolumeTask' {}
- newCreateReplaceRootVolumeTask :: Text -> CreateReplaceRootVolumeTask
- createReplaceRootVolumeTask_clientToken :: Lens' CreateReplaceRootVolumeTask (Maybe Text)
- createReplaceRootVolumeTask_deleteReplacedRootVolume :: Lens' CreateReplaceRootVolumeTask (Maybe Bool)
- createReplaceRootVolumeTask_dryRun :: Lens' CreateReplaceRootVolumeTask (Maybe Bool)
- createReplaceRootVolumeTask_imageId :: Lens' CreateReplaceRootVolumeTask (Maybe Text)
- createReplaceRootVolumeTask_snapshotId :: Lens' CreateReplaceRootVolumeTask (Maybe Text)
- createReplaceRootVolumeTask_tagSpecifications :: Lens' CreateReplaceRootVolumeTask (Maybe [TagSpecification])
- createReplaceRootVolumeTask_instanceId :: Lens' CreateReplaceRootVolumeTask Text
- data CreateReplaceRootVolumeTaskResponse = CreateReplaceRootVolumeTaskResponse' {}
- newCreateReplaceRootVolumeTaskResponse :: Int -> CreateReplaceRootVolumeTaskResponse
- createReplaceRootVolumeTaskResponse_replaceRootVolumeTask :: Lens' CreateReplaceRootVolumeTaskResponse (Maybe ReplaceRootVolumeTask)
- createReplaceRootVolumeTaskResponse_httpStatus :: Lens' CreateReplaceRootVolumeTaskResponse Int
Creating a Request
data CreateReplaceRootVolumeTask Source #
See: newCreateReplaceRootVolumeTask smart constructor.
Constructors
| CreateReplaceRootVolumeTask' | |
Fields
| |
Instances
newCreateReplaceRootVolumeTask Source #
Arguments
| :: Text | |
| -> CreateReplaceRootVolumeTask |
Create a value of CreateReplaceRootVolumeTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateReplaceRootVolumeTask, createReplaceRootVolumeTask_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.
CreateReplaceRootVolumeTask, createReplaceRootVolumeTask_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.
$sel:dryRun:CreateReplaceRootVolumeTask', createReplaceRootVolumeTask_dryRun - Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
CreateReplaceRootVolumeTask, createReplaceRootVolumeTask_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.
CreateReplaceRootVolumeTask, createReplaceRootVolumeTask_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.
CreateReplaceRootVolumeTask, createReplaceRootVolumeTask_tagSpecifications - The tags to apply to the root volume replacement task.
CreateReplaceRootVolumeTask, createReplaceRootVolumeTask_instanceId - The ID of the instance for which to replace the root volume.
Request Lenses
createReplaceRootVolumeTask_clientToken :: Lens' CreateReplaceRootVolumeTask (Maybe Text) Source #
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.
createReplaceRootVolumeTask_deleteReplacedRootVolume :: Lens' CreateReplaceRootVolumeTask (Maybe Bool) Source #
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.
createReplaceRootVolumeTask_dryRun :: Lens' CreateReplaceRootVolumeTask (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
createReplaceRootVolumeTask_imageId :: Lens' CreateReplaceRootVolumeTask (Maybe Text) Source #
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.
createReplaceRootVolumeTask_snapshotId :: Lens' CreateReplaceRootVolumeTask (Maybe Text) Source #
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.
createReplaceRootVolumeTask_tagSpecifications :: Lens' CreateReplaceRootVolumeTask (Maybe [TagSpecification]) Source #
The tags to apply to the root volume replacement task.
createReplaceRootVolumeTask_instanceId :: Lens' CreateReplaceRootVolumeTask Text Source #
The ID of the instance for which to replace the root volume.
Destructuring the Response
data CreateReplaceRootVolumeTaskResponse Source #
See: newCreateReplaceRootVolumeTaskResponse smart constructor.
Constructors
| CreateReplaceRootVolumeTaskResponse' | |
Fields
| |
Instances
newCreateReplaceRootVolumeTaskResponse Source #
Arguments
| :: Int | |
| -> CreateReplaceRootVolumeTaskResponse |
Create a value of CreateReplaceRootVolumeTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replaceRootVolumeTask:CreateReplaceRootVolumeTaskResponse', createReplaceRootVolumeTaskResponse_replaceRootVolumeTask - Information about the root volume replacement task.
$sel:httpStatus:CreateReplaceRootVolumeTaskResponse', createReplaceRootVolumeTaskResponse_httpStatus - The response's http status code.
Response Lenses
createReplaceRootVolumeTaskResponse_replaceRootVolumeTask :: Lens' CreateReplaceRootVolumeTaskResponse (Maybe ReplaceRootVolumeTask) Source #
Information about the root volume replacement task.
createReplaceRootVolumeTaskResponse_httpStatus :: Lens' CreateReplaceRootVolumeTaskResponse Int Source #
The response's http status code.