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

Description

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.

Synopsis

Creating a Request

data ModifyDBSnapshot Source #

See: newModifyDBSnapshot smart constructor.

Constructors

ModifyDBSnapshot' 

Fields

  • engineVersion :: Maybe Text

    The engine version to upgrade the DB snapshot to.

    The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

    MySQL

    • 5.5.46 (supported for 5.1 DB snapshots)

    Oracle

    • 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
    • 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
    • 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    PostgreSQL

    For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.

  • optionGroupName :: Maybe Text

    The option group to identify with the upgraded DB snapshot.

    You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.

  • dbSnapshotIdentifier :: Text

    The identifier of the DB snapshot to modify.

Instances

Instances details
ToHeaders ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

toHeaders :: ModifyDBSnapshot -> [Header] #

ToPath ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

toPath :: ModifyDBSnapshot -> ByteString #

ToQuery ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

toQuery :: ModifyDBSnapshot -> QueryString #

AWSRequest ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Associated Types

type AWSResponse ModifyDBSnapshot #

Methods

request :: (Service -> Service) -> ModifyDBSnapshot -> Request ModifyDBSnapshot #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyDBSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyDBSnapshot))) #

Generic ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Associated Types

type Rep ModifyDBSnapshot :: Type -> Type #

Methods

from :: ModifyDBSnapshot -> Rep ModifyDBSnapshot x #

to :: Rep ModifyDBSnapshot x -> ModifyDBSnapshot #

Read ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

readsPrec :: Int -> ReadS ModifyDBSnapshot #

readList :: ReadS [ModifyDBSnapshot] #

readPrec :: ReadPrec ModifyDBSnapshot #

readListPrec :: ReadPrec [ModifyDBSnapshot] #

Show ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

showsPrec :: Int -> ModifyDBSnapshot -> ShowS #

show :: ModifyDBSnapshot -> String #

showList :: [ModifyDBSnapshot] -> ShowS #

NFData ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

rnf :: ModifyDBSnapshot -> () #

Eq ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

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

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

Hashable ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

hashWithSalt :: Int -> ModifyDBSnapshot -> Int #

hash :: ModifyDBSnapshot -> Int #

type AWSResponse ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

type AWSResponse ModifyDBSnapshot = ModifyDBSnapshotResponse
type Rep ModifyDBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

type Rep ModifyDBSnapshot = D1 ('MetaData "ModifyDBSnapshot" "Amazonka.RDS.ModifyDBSnapshot" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyDBSnapshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifyDBSnapshot Source #

Arguments

:: Text

ModifyDBSnapshot

-> ModifyDBSnapshot 

Create a value of ModifyDBSnapshot 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:

ModifyDBSnapshot, modifyDBSnapshot_engineVersion - The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

  • 5.5.46 (supported for 5.1 DB snapshots)

Oracle

  • 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
  • 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
  • 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

PostgreSQL

For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.

ModifyDBSnapshot, modifyDBSnapshot_optionGroupName - The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.

ModifyDBSnapshot, modifyDBSnapshot_dbSnapshotIdentifier - The identifier of the DB snapshot to modify.

Request Lenses

modifyDBSnapshot_engineVersion :: Lens' ModifyDBSnapshot (Maybe Text) Source #

The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

  • 5.5.46 (supported for 5.1 DB snapshots)

Oracle

  • 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
  • 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
  • 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

PostgreSQL

For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.

modifyDBSnapshot_optionGroupName :: Lens' ModifyDBSnapshot (Maybe Text) Source #

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.

modifyDBSnapshot_dbSnapshotIdentifier :: Lens' ModifyDBSnapshot Text Source #

The identifier of the DB snapshot to modify.

Destructuring the Response

data ModifyDBSnapshotResponse Source #

See: newModifyDBSnapshotResponse smart constructor.

Constructors

ModifyDBSnapshotResponse' 

Fields

Instances

Instances details
Generic ModifyDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Associated Types

type Rep ModifyDBSnapshotResponse :: Type -> Type #

Methods

from :: ModifyDBSnapshotResponse -> Rep ModifyDBSnapshotResponse x #

to :: Rep ModifyDBSnapshotResponse x -> ModifyDBSnapshotResponse #

Read ModifyDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

readsPrec :: Int -> ReadS ModifyDBSnapshotResponse #

readList :: ReadS [ModifyDBSnapshotResponse] #

readPrec :: ReadPrec ModifyDBSnapshotResponse #

readListPrec :: ReadPrec [ModifyDBSnapshotResponse] #

Show ModifyDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

showsPrec :: Int -> ModifyDBSnapshotResponse -> ShowS #

show :: ModifyDBSnapshotResponse -> String #

showList :: [ModifyDBSnapshotResponse] -> ShowS #

NFData ModifyDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

rnf :: ModifyDBSnapshotResponse -> () #

Eq ModifyDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

Methods

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

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

type Rep ModifyDBSnapshotResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBSnapshot

type Rep ModifyDBSnapshotResponse = D1 ('MetaData "ModifyDBSnapshotResponse" "Amazonka.RDS.ModifyDBSnapshot" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyDBSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyDBSnapshotResponse Source #

Arguments

:: Int

$sel:httpStatus:ModifyDBSnapshotResponse'

-> ModifyDBSnapshotResponse 

Create a value of ModifyDBSnapshotResponse 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:ModifyDBSnapshotResponse', modifyDBSnapshotResponse_dbSnapshot - Undocumented member.

$sel:httpStatus:ModifyDBSnapshotResponse', modifyDBSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

modifyDBSnapshotResponse_dbSnapshot :: Lens' ModifyDBSnapshotResponse (Maybe DBSnapshot) Source #

Undocumented member.

modifyDBSnapshotResponse_httpStatus :: Lens' ModifyDBSnapshotResponse Int Source #

The response's http status code.