You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#backup_retention_periodInteger

The number of days to retain automated backups. 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 8

^

Returns:

  • (Integer)


10287
10288
10289
10290
10291
10292
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10287

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

#db_instance_identifierString

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

Constraints:

  • Must be the identifier for an existing Read Replica DB instance

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: mydbinstance

Returns:

  • (String)


10287
10288
10289
10290
10291
10292
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10287

class PromoteReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :backup_retention_period,
  :preferred_backup_window)
  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.

Default: A 30-minute window selected at random from an 8-hour block of time per AWS 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.

  • Times should be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Returns:

  • (String)


10287
10288
10289
10290
10291
10292
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10287

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