| 1 | |||
| 2 | package Paws::RDS::RebootDBInstance; | ||
| 3 | use Moose; | ||
| 4 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ForceFailover => (is => 'ro', isa => 'Bool'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RebootDBInstance'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RebootDBInstanceResult'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'RebootDBInstanceResult'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::RDS::RebootDBInstance - Arguments for method RebootDBInstance on L<Paws::RDS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method RebootDBInstance on the | ||
| 23 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 24 | as arguments to method RebootDBInstance. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RebootDBInstance. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $rds = Paws->service('RDS'); | ||
| 31 | # To reboot a DB instance | ||
| 32 | # This example reboots the specified DB instance without forcing a failover. | ||
| 33 | my $RebootDBInstanceResult = $rds->RebootDBInstance( | ||
| 34 | 'DBInstanceIdentifier' => 'mymysqlinstance', | ||
| 35 | 'ForceFailover' => 0 | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $DBInstance = $RebootDBInstanceResult->DBInstance; | ||
| 40 | |||
| 41 | # Returns a L<Paws::RDS::RebootDBInstanceResult> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RebootDBInstance> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> DBInstanceIdentifier => Str | ||
| 50 | |||
| 51 | The DB instance identifier. This parameter is stored as a lowercase | ||
| 52 | string. | ||
| 53 | |||
| 54 | Constraints: | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | Must match the identifier of an existing DBInstance. | ||
| 61 | |||
| 62 | =back | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 ForceFailover => Bool | ||
| 68 | |||
| 69 | A value that indicates whether the reboot is conducted through a | ||
| 70 | Multi-AZ failover. | ||
| 71 | |||
| 72 | Constraint: You can't enable force failover if the instance isn't | ||
| 73 | configured for Multi-AZ. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method RebootDBInstance in L<Paws::RDS> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |