Network.AWS.RDS.CopyDBSnapshot

Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.

If you are copying from a shared manual DB snapshot, the SourceDBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Creating a Request

copyDBSnapshot

Arguments

:: Text

cdsSourceDBSnapshotIdentifier

-> Text

cdsTargetDBSnapshotIdentifier

-> CopyDBSnapshot

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

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

• cdsCopyTags - True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.
• cdsKMSKeyId - The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key. If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key. If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId .
• cdsTags - Undocumented member.
• cdsSourceDBSnapshotIdentifier - The identifier for the source DB snapshot. If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot. Constraints: * Must specify a valid system snapshot in the "available" state. * If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier. * If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot . Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
• cdsTargetDBSnapshotIdentifier - The identifier for the copied snapshot. Constraints: * Cannot be null, empty, or blank * Must contain from 1 to 255 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot

data CopyDBSnapshot

See: copyDBSnapshot smart constructor.

Instances

Eq CopyDBSnapshot

Methods

(==) :: CopyDBSnapshot -> CopyDBSnapshot -> Bool

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

Data CopyDBSnapshot

Methods

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

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

toConstr :: CopyDBSnapshot -> Constr

dataTypeOf :: CopyDBSnapshot -> DataType

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

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

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

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

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

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

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

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

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

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

Read CopyDBSnapshot

Methods

readsPrec :: Int -> ReadS CopyDBSnapshot

readList :: ReadS [CopyDBSnapshot]

readPrec :: ReadPrec CopyDBSnapshot

readListPrec :: ReadPrec [CopyDBSnapshot]

Show CopyDBSnapshot

Methods

showsPrec :: Int -> CopyDBSnapshot -> ShowS

show :: CopyDBSnapshot -> String

showList :: [CopyDBSnapshot] -> ShowS

Generic CopyDBSnapshot

Associated Types

type Rep CopyDBSnapshot :: * -> *

Methods

from :: CopyDBSnapshot -> Rep CopyDBSnapshot x

to :: Rep CopyDBSnapshot x -> CopyDBSnapshot

Hashable CopyDBSnapshot

Methods

hashWithSalt :: Int -> CopyDBSnapshot -> Int

hash :: CopyDBSnapshot -> Int

NFData CopyDBSnapshot

Methods

rnf :: CopyDBSnapshot -> ()

AWSRequest CopyDBSnapshot

Associated Types

type Rs CopyDBSnapshot :: *

Methods

request :: CopyDBSnapshot -> Request CopyDBSnapshot

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

ToPath CopyDBSnapshot

Methods

toPath :: CopyDBSnapshot -> ByteString

ToHeaders CopyDBSnapshot

Methods

toHeaders :: CopyDBSnapshot -> [Header]

ToQuery CopyDBSnapshot

Methods

toQuery :: CopyDBSnapshot -> QueryString

type Rep CopyDBSnapshot

type Rep CopyDBSnapshot = D1 (MetaData "CopyDBSnapshot" "Network.AWS.RDS.CopyDBSnapshot" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "CopyDBSnapshot'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdsCopyTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_cdsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) ((:*:) (S1 (MetaSel (Just Symbol "_cdsSourceDBSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cdsTargetDBSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CopyDBSnapshot

type Rs CopyDBSnapshot = CopyDBSnapshotResponse

Request Lenses

cdsCopyTags :: Lens' CopyDBSnapshot (Maybe Bool)

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

cdsKMSKeyId :: Lens' CopyDBSnapshot (Maybe Text)

The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key. If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key. If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId .

cdsTags :: Lens' CopyDBSnapshot [Tag]

Undocumented member.

cdsSourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text

The identifier for the source DB snapshot. If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot. Constraints: * Must specify a valid system snapshot in the "available" state. * If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier. * If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot . Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

cdsTargetDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text

The identifier for the copied snapshot. Constraints: * Cannot be null, empty, or blank * Must contain from 1 to 255 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot

Destructuring the Response

copyDBSnapshotResponse

Arguments

:: Int

cdsrsResponseStatus

-> CopyDBSnapshotResponse

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

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

• cdsrsDBSnapshot - Undocumented member.
• cdsrsResponseStatus - -- | The response status code.

data CopyDBSnapshotResponse

See: copyDBSnapshotResponse smart constructor.

Instances

Eq CopyDBSnapshotResponse

Methods

(==) :: CopyDBSnapshotResponse -> CopyDBSnapshotResponse -> Bool

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

Data CopyDBSnapshotResponse

Methods

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

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

toConstr :: CopyDBSnapshotResponse -> Constr

dataTypeOf :: CopyDBSnapshotResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CopyDBSnapshotResponse

Methods

readsPrec :: Int -> ReadS CopyDBSnapshotResponse

readList :: ReadS [CopyDBSnapshotResponse]

readPrec :: ReadPrec CopyDBSnapshotResponse

readListPrec :: ReadPrec [CopyDBSnapshotResponse]

Show CopyDBSnapshotResponse

Methods

showsPrec :: Int -> CopyDBSnapshotResponse -> ShowS

show :: CopyDBSnapshotResponse -> String

showList :: [CopyDBSnapshotResponse] -> ShowS

Generic CopyDBSnapshotResponse

Associated Types

type Rep CopyDBSnapshotResponse :: * -> *

Methods

from :: CopyDBSnapshotResponse -> Rep CopyDBSnapshotResponse x

to :: Rep CopyDBSnapshotResponse x -> CopyDBSnapshotResponse

NFData CopyDBSnapshotResponse

Methods

rnf :: CopyDBSnapshotResponse -> ()

type Rep CopyDBSnapshotResponse

type Rep CopyDBSnapshotResponse = D1 (MetaData "CopyDBSnapshotResponse" "Network.AWS.RDS.CopyDBSnapshot" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "CopyDBSnapshotResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cdsrsDBSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBSnapshot))) (S1 (MetaSel (Just Symbol "_cdsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cdsrsDBSnapshot :: Lens' CopyDBSnapshotResponse (Maybe DBSnapshot)

Undocumented member.

cdsrsResponseStatus :: Lens' CopyDBSnapshotResponse Int

• - | The response status code.