Amazonka.RDS.PromoteReadReplica

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.

Creating a Request

data PromoteReadReplica

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

ToHeaders PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Methods

toHeaders :: PromoteReadReplica -> [Header]

ToPath PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Methods

toPath :: PromoteReadReplica -> ByteString

ToQuery PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Methods

toQuery :: PromoteReadReplica -> QueryString

AWSRequest PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Associated Types

type AWSResponse PromoteReadReplica

Methods

request :: (Service -> Service) -> PromoteReadReplica -> Request PromoteReadReplica

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

Generic PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Associated Types

type Rep PromoteReadReplica :: Type -> Type

Methods

from :: PromoteReadReplica -> Rep PromoteReadReplica x

to :: Rep PromoteReadReplica x -> PromoteReadReplica

Read PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Methods

readsPrec :: Int -> ReadS PromoteReadReplica

readList :: ReadS [PromoteReadReplica]

readPrec :: ReadPrec PromoteReadReplica

readListPrec :: ReadPrec [PromoteReadReplica]

Show PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Methods

showsPrec :: Int -> PromoteReadReplica -> ShowS

show :: PromoteReadReplica -> String

showList :: [PromoteReadReplica] -> ShowS

NFData PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Methods

rnf :: PromoteReadReplica -> ()

Eq PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Methods

(==) :: PromoteReadReplica -> PromoteReadReplica -> Bool

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

Hashable PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

Methods

hashWithSalt :: Int -> PromoteReadReplica -> Int

hash :: PromoteReadReplica -> Int

type AWSResponse PromoteReadReplica

Defined in Amazonka.RDS.PromoteReadReplica

type AWSResponse PromoteReadReplica = PromoteReadReplicaResponse

type Rep PromoteReadReplica

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

Arguments

:: Text

PromoteReadReplica

-> PromoteReadReplica

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)

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)

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

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

See: newPromoteReadReplicaResponse smart constructor.

Constructors

PromoteReadReplicaResponse'

Fields

• dbInstance :: Maybe DBInstance
• httpStatus :: Int

  The response's http status code.

Instances

Generic PromoteReadReplicaResponse

Defined in Amazonka.RDS.PromoteReadReplica

Associated Types

type Rep PromoteReadReplicaResponse :: Type -> Type

Methods

from :: PromoteReadReplicaResponse -> Rep PromoteReadReplicaResponse x

to :: Rep PromoteReadReplicaResponse x -> PromoteReadReplicaResponse

Read PromoteReadReplicaResponse

Defined in Amazonka.RDS.PromoteReadReplica

Methods

readsPrec :: Int -> ReadS PromoteReadReplicaResponse

readList :: ReadS [PromoteReadReplicaResponse]

readPrec :: ReadPrec PromoteReadReplicaResponse

readListPrec :: ReadPrec [PromoteReadReplicaResponse]

Show PromoteReadReplicaResponse

Defined in Amazonka.RDS.PromoteReadReplica

Methods

showsPrec :: Int -> PromoteReadReplicaResponse -> ShowS

show :: PromoteReadReplicaResponse -> String

showList :: [PromoteReadReplicaResponse] -> ShowS

NFData PromoteReadReplicaResponse

Defined in Amazonka.RDS.PromoteReadReplica

Methods

rnf :: PromoteReadReplicaResponse -> ()

Eq PromoteReadReplicaResponse

Defined in Amazonka.RDS.PromoteReadReplica

Methods

(==) :: PromoteReadReplicaResponse -> PromoteReadReplicaResponse -> Bool

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

type Rep PromoteReadReplicaResponse

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

Arguments

:: Int

$sel:httpStatus:PromoteReadReplicaResponse'

-> PromoteReadReplicaResponse

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

promoteReadReplicaResponse_dbInstance :: Lens' PromoteReadReplicaResponse (Maybe DBInstance)

Undocumented member.

promoteReadReplicaResponse_httpStatus :: Lens' PromoteReadReplicaResponse Int

The response's http status code.