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

Amazonka.RDS.CreateDBSnapshot

Description

Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

Synopsis

Creating a Request

data CreateDBSnapshot Source #

See: newCreateDBSnapshot smart constructor.

Constructors

CreateDBSnapshot' 

Fields

  • tags :: Maybe [Tag]
     
  • dbSnapshotIdentifier :: Text

    The identifier for the DB snapshot.

    Constraints:

    • Can't be null, empty, or blank
    • Must contain from 1 to 255 letters, numbers, or hyphens
    • First character must be a letter
    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

  • dbInstanceIdentifier :: Text

    The identifier of the DB instance that you want to create the snapshot of.

    Constraints:

    • Must match the identifier of an existing DBInstance.

Instances

Instances details
Eq CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

(==) :: CreateDBSnapshot -> CreateDBSnapshot -> Bool #

(/=) :: CreateDBSnapshot -> CreateDBSnapshot -> Bool #

Read CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

readsPrec :: Int -> ReadS CreateDBSnapshot #

readList :: ReadS [CreateDBSnapshot] #

readPrec :: ReadPrec CreateDBSnapshot #

readListPrec :: ReadPrec [CreateDBSnapshot] #

Show CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

showsPrec :: Int -> CreateDBSnapshot -> ShowS #

show :: CreateDBSnapshot -> String #

showList :: [CreateDBSnapshot] -> ShowS #

Generic CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Associated Types

type Rep CreateDBSnapshot :: Type -> Type #

Methods

from :: CreateDBSnapshot -> Rep CreateDBSnapshot x #

to :: Rep CreateDBSnapshot x -> CreateDBSnapshot #

NFData CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

rnf :: CreateDBSnapshot -> () #

Hashable CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

hashWithSalt :: Int -> CreateDBSnapshot -> Int #

hash :: CreateDBSnapshot -> Int #

AWSRequest CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Associated Types

type AWSResponse CreateDBSnapshot #

Methods

request :: CreateDBSnapshot -> Request CreateDBSnapshot #

response :: MonadResource m => Logger -> Service -> Proxy CreateDBSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDBSnapshot))) #

ToHeaders CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

toHeaders :: CreateDBSnapshot -> [Header] #

ToPath CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

toPath :: CreateDBSnapshot -> ByteString #

ToQuery CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

toQuery :: CreateDBSnapshot -> QueryString #

type Rep CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

type Rep CreateDBSnapshot = D1 ('MetaData "CreateDBSnapshot" "Amazonka.RDS.CreateDBSnapshot" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CreateDBSnapshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "dbSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

type AWSResponse CreateDBSnapshot = CreateDBSnapshotResponse

newCreateDBSnapshot Source #

Arguments

:: Text

$sel:dbSnapshotIdentifier:CreateDBSnapshot'

-> Text

$sel:dbInstanceIdentifier:CreateDBSnapshot'

-> CreateDBSnapshot 

Create a value of CreateDBSnapshot 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:tags:CreateDBSnapshot', createDBSnapshot_tags - Undocumented member.

$sel:dbSnapshotIdentifier:CreateDBSnapshot', createDBSnapshot_dbSnapshotIdentifier - The identifier for the DB snapshot.

Constraints:

  • Can't be null, empty, or blank
  • Must contain from 1 to 255 letters, numbers, or hyphens
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

$sel:dbInstanceIdentifier:CreateDBSnapshot', createDBSnapshot_dbInstanceIdentifier - The identifier of the DB instance that you want to create the snapshot of.

Constraints:

  • Must match the identifier of an existing DBInstance.

Request Lenses

createDBSnapshot_tags :: Lens' CreateDBSnapshot (Maybe [Tag]) Source #

Undocumented member.

createDBSnapshot_dbSnapshotIdentifier :: Lens' CreateDBSnapshot Text Source #

The identifier for the DB snapshot.

Constraints:

  • Can't be null, empty, or blank
  • Must contain from 1 to 255 letters, numbers, or hyphens
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

createDBSnapshot_dbInstanceIdentifier :: Lens' CreateDBSnapshot Text Source #

The identifier of the DB instance that you want to create the snapshot of.

Constraints:

  • Must match the identifier of an existing DBInstance.

Destructuring the Response

data CreateDBSnapshotResponse Source #

See: newCreateDBSnapshotResponse smart constructor.

Constructors

CreateDBSnapshotResponse' 

Fields

Instances

Instances details
Eq CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

(==) :: CreateDBSnapshotResponse -> CreateDBSnapshotResponse -> Bool #

(/=) :: CreateDBSnapshotResponse -> CreateDBSnapshotResponse -> Bool #

Read CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

readsPrec :: Int -> ReadS CreateDBSnapshotResponse #

readList :: ReadS [CreateDBSnapshotResponse] #

readPrec :: ReadPrec CreateDBSnapshotResponse #

readListPrec :: ReadPrec [CreateDBSnapshotResponse] #

Show CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

showsPrec :: Int -> CreateDBSnapshotResponse -> ShowS #

show :: CreateDBSnapshotResponse -> String #

showList :: [CreateDBSnapshotResponse] -> ShowS #

Generic CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Associated Types

type Rep CreateDBSnapshotResponse :: Type -> Type #

Methods

from :: CreateDBSnapshotResponse -> Rep CreateDBSnapshotResponse x #

to :: Rep CreateDBSnapshotResponse x -> CreateDBSnapshotResponse #

NFData CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

rnf :: CreateDBSnapshotResponse -> () #

type Rep CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

type Rep CreateDBSnapshotResponse = D1 ('MetaData "CreateDBSnapshotResponse" "Amazonka.RDS.CreateDBSnapshot" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CreateDBSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBSnapshotResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateDBSnapshotResponse'

-> CreateDBSnapshotResponse 

Create a value of CreateDBSnapshotResponse 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:dbSnapshot:CreateDBSnapshotResponse', createDBSnapshotResponse_dbSnapshot - Undocumented member.

$sel:httpStatus:CreateDBSnapshotResponse', createDBSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

createDBSnapshotResponse_dbSnapshot :: Lens' CreateDBSnapshotResponse (Maybe DBSnapshot) Source #

Undocumented member.

createDBSnapshotResponse_httpStatus :: Lens' CreateDBSnapshotResponse Int Source #

The response's http status code.