amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

Defined in Amazonka.RDS.CreateDBSnapshot

ToPath CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

ToQuery CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

AWSRequest CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Associated Types

type AWSResponse CreateDBSnapshot #

Generic CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Associated Types

type Rep CreateDBSnapshot :: Type -> Type #

Read CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Show CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

NFData CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Methods

rnf :: CreateDBSnapshot -> () #

Eq CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Hashable CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

type AWSResponse CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

type Rep CreateDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

type Rep CreateDBSnapshot = D1 ('MetaData "CreateDBSnapshot" "Amazonka.RDS.CreateDBSnapshot" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" '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))))

newCreateDBSnapshot Source #

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.

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

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

Defined in Amazonka.RDS.CreateDBSnapshot

Associated Types

type Rep CreateDBSnapshotResponse :: Type -> Type #

Read CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Show CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

NFData CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

Eq CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

type Rep CreateDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBSnapshot

type Rep CreateDBSnapshotResponse = D1 ('MetaData "CreateDBSnapshotResponse" "Amazonka.RDS.CreateDBSnapshot" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" '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 #

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