| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ElastiCache.CopySnapshot
Description
Makes a copy of an existing snapshot.
This operation is valid for Redis only.
Users or groups that have permissions to use the CopySnapshot
operation can create their own Amazon S3 buckets and copy snapshots to
it. To control access to your snapshots, use an IAM policy to control
who has the ability to use the CopySnapshot operation. For more
information about using IAM to control the use of ElastiCache
operations, see
Exporting Snapshots
and
Authentication & Access Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the
TargetSnapshotNamea new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value forTargetSnapshotName.Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Synopsis
- data CopySnapshot = CopySnapshot' {
- targetBucket :: Maybe Text
- kmsKeyId :: Maybe Text
- tags :: Maybe [Tag]
- sourceSnapshotName :: Text
- targetSnapshotName :: Text
- newCopySnapshot :: Text -> Text -> CopySnapshot
- copySnapshot_targetBucket :: Lens' CopySnapshot (Maybe Text)
- copySnapshot_kmsKeyId :: Lens' CopySnapshot (Maybe Text)
- copySnapshot_tags :: Lens' CopySnapshot (Maybe [Tag])
- copySnapshot_sourceSnapshotName :: Lens' CopySnapshot Text
- copySnapshot_targetSnapshotName :: Lens' CopySnapshot Text
- data CopySnapshotResponse = CopySnapshotResponse' {
- snapshot :: Maybe Snapshot
- httpStatus :: Int
- newCopySnapshotResponse :: Int -> CopySnapshotResponse
- copySnapshotResponse_snapshot :: Lens' CopySnapshotResponse (Maybe Snapshot)
- copySnapshotResponse_httpStatus :: Lens' CopySnapshotResponse Int
Creating a Request
data CopySnapshot Source #
Represents the input of a CopySnapshotMessage operation.
See: newCopySnapshot smart constructor.
Constructors
| CopySnapshot' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CopySnapshot |
Create a value of CopySnapshot 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:targetBucket:CopySnapshot', copySnapshot_targetBucket - The Amazon S3 bucket to which the snapshot is exported. This parameter
is used only when exporting a snapshot for external access.
When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
$sel:kmsKeyId:CopySnapshot', copySnapshot_kmsKeyId - The ID of the KMS key used to encrypt the target snapshot.
$sel:tags:CopySnapshot', copySnapshot_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:sourceSnapshotName:CopySnapshot', copySnapshot_sourceSnapshotName - The name of an existing snapshot from which to make a copy.
$sel:targetSnapshotName:CopySnapshot', copySnapshot_targetSnapshotName - A name for the snapshot copy. ElastiCache does not permit overwriting a
snapshot, therefore this name must be unique within its context -
ElastiCache or an Amazon S3 bucket if exporting.
Request Lenses
copySnapshot_targetBucket :: Lens' CopySnapshot (Maybe Text) Source #
The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.
When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
copySnapshot_kmsKeyId :: Lens' CopySnapshot (Maybe Text) Source #
The ID of the KMS key used to encrypt the target snapshot.
copySnapshot_tags :: Lens' CopySnapshot (Maybe [Tag]) Source #
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
copySnapshot_sourceSnapshotName :: Lens' CopySnapshot Text Source #
The name of an existing snapshot from which to make a copy.
copySnapshot_targetSnapshotName :: Lens' CopySnapshot Text Source #
A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
Destructuring the Response
data CopySnapshotResponse Source #
See: newCopySnapshotResponse smart constructor.
Constructors
| CopySnapshotResponse' | |
Fields
| |
Instances
newCopySnapshotResponse Source #
Arguments
| :: Int | |
| -> CopySnapshotResponse |
Create a value of CopySnapshotResponse 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:snapshot:CopySnapshotResponse', copySnapshotResponse_snapshot - Undocumented member.
$sel:httpStatus:CopySnapshotResponse', copySnapshotResponse_httpStatus - The response's http status code.
Response Lenses
copySnapshotResponse_snapshot :: Lens' CopySnapshotResponse (Maybe Snapshot) Source #
Undocumented member.
copySnapshotResponse_httpStatus :: Lens' CopySnapshotResponse Int Source #
The response's http status code.