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

Description

Promotes a read replica DB instance to a standalone DB instance.

  • Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
  • This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
Synopsis

Creating a Request

data PromoteReadReplica Source #

See: newPromoteReadReplica smart constructor.

Constructors

PromoteReadReplica' 

Fields

  • backupRetentionPeriod :: Maybe Int

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Default: 1

    Constraints:

    • Must be a value from 0 to 35.
    • Can't be set to 0 if the DB instance is a source to read replicas.
  • preferredBackupWindow :: Maybe Text

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.
    • Must be in Universal Coordinated Time (UTC).
    • Must not conflict with the preferred maintenance window.
    • Must be at least 30 minutes.
  • dbInstanceIdentifier :: Text

    The DB instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing read replica DB instance.

    Example: mydbinstance

Instances

Instances details
ToHeaders PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

ToPath PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

ToQuery PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

AWSRequest PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

Associated Types

type AWSResponse PromoteReadReplica #

Generic PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

Associated Types

type Rep PromoteReadReplica :: Type -> Type #

Read PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

Show PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

NFData PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

Methods

rnf :: PromoteReadReplica -> () #

Eq PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

Hashable PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

type AWSResponse PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

type Rep PromoteReadReplica Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

type Rep PromoteReadReplica = D1 ('MetaData "PromoteReadReplica" "Amazonka.RDS.PromoteReadReplica" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "PromoteReadReplica'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPromoteReadReplica Source #

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

PromoteReadReplica, promoteReadReplica_backupRetentionPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 35.
  • Can't be set to 0 if the DB instance is a source to read replicas.

PromoteReadReplica, promoteReadReplica_preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

PromoteReadReplica, promoteReadReplica_dbInstanceIdentifier - The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Request Lenses

promoteReadReplica_backupRetentionPeriod :: Lens' PromoteReadReplica (Maybe Int) Source #

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 35.
  • Can't be set to 0 if the DB instance is a source to read replicas.

promoteReadReplica_preferredBackupWindow :: Lens' PromoteReadReplica (Maybe Text) Source #

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

promoteReadReplica_dbInstanceIdentifier :: Lens' PromoteReadReplica Text Source #

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Destructuring the Response

data PromoteReadReplicaResponse Source #

See: newPromoteReadReplicaResponse smart constructor.

Constructors

PromoteReadReplicaResponse' 

Fields

Instances

Instances details
Generic PromoteReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

Associated Types

type Rep PromoteReadReplicaResponse :: Type -> Type #

Read PromoteReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

Show PromoteReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

NFData PromoteReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

Eq PromoteReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

type Rep PromoteReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.PromoteReadReplica

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

newPromoteReadReplicaResponse Source #

Create a value of PromoteReadReplicaResponse 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:dbInstance:PromoteReadReplicaResponse', promoteReadReplicaResponse_dbInstance - Undocumented member.

$sel:httpStatus:PromoteReadReplicaResponse', promoteReadReplicaResponse_httpStatus - The response's http status code.

Response Lenses