/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RDS::PromoteReadReplica

NAME

Paws::RDS::PromoteReadReplica - Arguments for method PromoteReadReplica on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method PromoteReadReplica on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method PromoteReadReplica.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PromoteReadReplica.

SYNOPSIS

my $rds = Paws->service('RDS');
# To promote a read replica
# This example promotes the specified read replica and sets its backup retention
# period and preferred backup window.
my $PromoteReadReplicaResult = $rds->PromoteReadReplica(
  'BackupRetentionPeriod' => 1,
  'DBInstanceIdentifier'  => 'mydbreadreplica',
  'PreferredBackupWindow' => '03:30-04:00'
);

# Results:
my $DBInstance = $PromoteReadReplicaResult->DBInstance;

# Returns a L<Paws::RDS::PromoteReadReplicaResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/PromoteReadReplica

ATTRIBUTES

BackupRetentionPeriod => 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.

REQUIRED DBInstanceIdentifier => Str

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

PreferredBackupWindow => Str

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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method PromoteReadReplica in Paws::RDS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues