Class: Aws::RDS::Types::PromoteReadReplicaMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass PromoteReadReplicaMessage data as a hash:

{
  db_instance_identifier: "String", # required
  backup_retention_period: 1,
  preferred_backup_window: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_retention_periodInteger

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.

Returns:

  • (Integer)

16968
16969
16970
16971
16972
16973
16974
# File 'lib/aws-sdk-rds/types.rb', line 16968

class PromoteReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :backup_retention_period,
  :preferred_backup_window)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifierString

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`

Returns:

  • (String)

16968
16969
16970
16971
16972
16973
16974
# File 'lib/aws-sdk-rds/types.rb', line 16968

class PromoteReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :backup_retention_period,
  :preferred_backup_window)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_windowString

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.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html

Returns:

  • (String)

16968
16969
16970
16971
16972
16973
16974
# File 'lib/aws-sdk-rds/types.rb', line 16968

class PromoteReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :backup_retention_period,
  :preferred_backup_window)
  SENSITIVE = []
  include Aws::Structure
end