amazonka-elasticache-1.6.1: Amazon ElastiCache SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.CopySnapshot

Contents

Description

Makes a copy of an existing snapshot.

Important: 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 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 .

  • 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 UploadDelete permissions on the bucket. For more information, see <http:docs.aws.amazon.comAmazonElastiCachelatestUserGuide/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess 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

Creating a Request

copySnapshot Source #

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 - 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 .
  • csSourceSnapshotName - The name of an existing snapshot from which to make a copy.
  • csTargetSnapshotName - 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.

data CopySnapshot Source #

Represents the input of a CopySnapshotMessage operation.

See: copySnapshot smart constructor.

Instances
Eq CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Data CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.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 Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Show CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Generic CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Associated Types

type Rep CopySnapshot :: Type -> Type #

Hashable CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

AWSRequest CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Associated Types

type Rs CopySnapshot :: Type #

ToHeaders CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

ToPath CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

ToQuery CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

NFData CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Methods

rnf :: CopySnapshot -> () #

type Rep CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

type Rep CopySnapshot = D1 (MetaData "CopySnapshot" "Network.AWS.ElastiCache.CopySnapshot" "amazonka-elasticache-1.6.1-7qPjCRJV7Sp8jKm0QWBmxX" False) (C1 (MetaCons "CopySnapshot'" PrefixI True) (S1 (MetaSel (Just "_csTargetBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_csSourceSnapshotName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_csTargetSnapshotName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs CopySnapshot Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Request Lenses

csTargetBucket :: 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 .

csSourceSnapshotName :: Lens' CopySnapshot Text Source #

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

csTargetSnapshotName :: 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

copySnapshotResponse Source #

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:

data CopySnapshotResponse Source #

See: copySnapshotResponse smart constructor.

Instances
Eq CopySnapshotResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Data CopySnapshotResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

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 Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Show CopySnapshotResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Generic CopySnapshotResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Associated Types

type Rep CopySnapshotResponse :: Type -> Type #

NFData CopySnapshotResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

Methods

rnf :: CopySnapshotResponse -> () #

type Rep CopySnapshotResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CopySnapshot

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

Response Lenses

csrsResponseStatus :: Lens' CopySnapshotResponse Int Source #

  • - | The response status code.