Network.AWS.ElastiCache.CopySnapshot

The CopySnapshot action makes a copy of an existing snapshot.

Users or groups that have permissions to use the CopySnapshot API 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 API. For more information about using IAM to control the use of ElastiCache APIs, see Exporting Snapshots and Authentication & Access Control.

Erorr Message:

• 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.

Creating a Request

copySnapshot

Arguments

:: Text

csSourceSnapshotName

-> Text

csTargetSnapshotName

-> CopySnapshot

Creates a value of CopySnapshot with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csTargetBucket
• csSourceSnapshotName
• csTargetSnapshotName

data CopySnapshot

Represents the input of a CopySnapshotMessage action.

See: copySnapshot smart constructor.

Instances

Eq CopySnapshot

Methods

(==) :: CopySnapshot -> CopySnapshot -> Bool

(/=) :: CopySnapshot -> CopySnapshot -> Bool

Data CopySnapshot

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CopySnapshot -> c CopySnapshot

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CopySnapshot

toConstr :: CopySnapshot -> Constr

dataTypeOf :: CopySnapshot -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CopySnapshot)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CopySnapshot)

gmapT :: (forall b. Data b => b -> b) -> CopySnapshot -> CopySnapshot

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CopySnapshot -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CopySnapshot -> r

gmapQ :: (forall d. Data d => d -> u) -> CopySnapshot -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CopySnapshot -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CopySnapshot -> m CopySnapshot

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CopySnapshot -> m CopySnapshot

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CopySnapshot -> m CopySnapshot

Read CopySnapshot

Methods

readsPrec :: Int -> ReadS CopySnapshot

readList :: ReadS [CopySnapshot]

readPrec :: ReadPrec CopySnapshot

readListPrec :: ReadPrec [CopySnapshot]

Show CopySnapshot

Methods

showsPrec :: Int -> CopySnapshot -> ShowS

show :: CopySnapshot -> String

showList :: [CopySnapshot] -> ShowS

Generic CopySnapshot

Associated Types

type Rep CopySnapshot :: * -> *

Methods

from :: CopySnapshot -> Rep CopySnapshot x

to :: Rep CopySnapshot x -> CopySnapshot

Hashable CopySnapshot

Methods

hashWithSalt :: Int -> CopySnapshot -> Int

hash :: CopySnapshot -> Int

NFData CopySnapshot

Methods

rnf :: CopySnapshot -> ()

AWSRequest CopySnapshot

Associated Types

type Rs CopySnapshot :: *

Methods

request :: CopySnapshot -> Request CopySnapshot

response :: MonadResource m => Logger -> Service -> Proxy * CopySnapshot -> ClientResponse -> m (Response CopySnapshot)

ToPath CopySnapshot

Methods

toPath :: CopySnapshot -> ByteString

ToHeaders CopySnapshot

Methods

toHeaders :: CopySnapshot -> [Header]

ToQuery CopySnapshot

Methods

toQuery :: CopySnapshot -> QueryString

type Rep CopySnapshot

type Rep CopySnapshot = D1 (MetaData "CopySnapshot" "Network.AWS.ElastiCache.CopySnapshot" "amazonka-elasticache-1.4.4-2twekknVMZVASvs2nniZE5" False) (C1 (MetaCons "CopySnapshot'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csTargetBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_csSourceSnapshotName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_csTargetSnapshotName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CopySnapshot

type Rs CopySnapshot = CopySnapshotResponse

Request Lenses

csTargetBucket :: Lens' CopySnapshot (Maybe Text)

The Amazon S3 bucket to which the snapshot will be 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.

Error Messages:

You could receive one of the following error messages.

Erorr Messages

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions permissions on the bucket.

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• 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.

• 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.

• 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.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

csSourceSnapshotName :: Lens' CopySnapshot Text

The name of an existing snapshot from which to make a copy.

csTargetSnapshotName :: Lens' CopySnapshot Text

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.

Error Message

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

Destructuring the Response

copySnapshotResponse

Arguments

:: Int

csrsResponseStatus

-> CopySnapshotResponse

Creates a value of CopySnapshotResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csrsSnapshot
• csrsResponseStatus

data CopySnapshotResponse

See: copySnapshotResponse smart constructor.

Instances

Eq CopySnapshotResponse

Methods

(==) :: CopySnapshotResponse -> CopySnapshotResponse -> Bool

(/=) :: CopySnapshotResponse -> CopySnapshotResponse -> Bool

Data CopySnapshotResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CopySnapshotResponse -> c CopySnapshotResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CopySnapshotResponse

toConstr :: CopySnapshotResponse -> Constr

dataTypeOf :: CopySnapshotResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CopySnapshotResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CopySnapshotResponse)

gmapT :: (forall b. Data b => b -> b) -> CopySnapshotResponse -> CopySnapshotResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CopySnapshotResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CopySnapshotResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CopySnapshotResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CopySnapshotResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CopySnapshotResponse -> m CopySnapshotResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CopySnapshotResponse -> m CopySnapshotResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CopySnapshotResponse -> m CopySnapshotResponse

Read CopySnapshotResponse

Methods

readsPrec :: Int -> ReadS CopySnapshotResponse

readList :: ReadS [CopySnapshotResponse]

readPrec :: ReadPrec CopySnapshotResponse

readListPrec :: ReadPrec [CopySnapshotResponse]

Show CopySnapshotResponse

Methods

showsPrec :: Int -> CopySnapshotResponse -> ShowS

show :: CopySnapshotResponse -> String

showList :: [CopySnapshotResponse] -> ShowS

Generic CopySnapshotResponse

Associated Types

type Rep CopySnapshotResponse :: * -> *

Methods

from :: CopySnapshotResponse -> Rep CopySnapshotResponse x

to :: Rep CopySnapshotResponse x -> CopySnapshotResponse

NFData CopySnapshotResponse

Methods

rnf :: CopySnapshotResponse -> ()

type Rep CopySnapshotResponse

type Rep CopySnapshotResponse = D1 (MetaData "CopySnapshotResponse" "Network.AWS.ElastiCache.CopySnapshot" "amazonka-elasticache-1.4.4-2twekknVMZVASvs2nniZE5" False) (C1 (MetaCons "CopySnapshotResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csrsSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Snapshot))) (S1 (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

csrsSnapshot :: Lens' CopySnapshotResponse (Maybe Snapshot)

Undocumented member.

csrsResponseStatus :: Lens' CopySnapshotResponse Int

The response status code.