| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::FailoverState; | ||
| 3 | use Moose; | ||
| 4 | has FromDbClusterArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has Status => (is => 'ro', isa => 'Str'); | ||
| 6 | has ToDbClusterArn => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::RDS::FailoverState | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::RDS::FailoverState object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { FromDbClusterArn => $value, ..., ToDbClusterArn => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::FailoverState object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->FromDbClusterArn | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Contains the state of scheduled or in-process failover operations on an | ||
| 39 | Aurora global database (GlobalCluster). This Data type is empty unless | ||
| 40 | a failover operation is scheduled or is currently underway on the | ||
| 41 | Aurora global database. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 FromDbClusterArn => Str | ||
| 47 | |||
| 48 | The Amazon Resource Name (ARN) of the Aurora DB cluster that is | ||
| 49 | currently being demoted, and which is associated with this state. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Status => Str | ||
| 53 | |||
| 54 | The current status of the Aurora global database (GlobalCluster). | ||
| 55 | Possible values are as follows: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | pending E<150> A request to fail over the Aurora global database | ||
| 62 | (GlobalCluster) has been received by the service. The | ||
| 63 | C<GlobalCluster>'s primary DB cluster and the specified secondary DB | ||
| 64 | cluster are being verified before the failover process can start. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | failing-over E<150> This status covers the range of Aurora internal | ||
| 69 | operations that take place during the failover process, such as | ||
| 70 | demoting the primary Aurora DB cluster, promoting the secondary Aurora | ||
| 71 | DB, and synchronizing replicas. | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | cancelling E<150> The request to fail over the Aurora global database | ||
| 76 | (GlobalCluster) was cancelled and the primary Aurora DB cluster and the | ||
| 77 | selected secondary Aurora DB cluster are returning to their previous | ||
| 78 | states. | ||
| 79 | |||
| 80 | =back | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 ToDbClusterArn => Str | ||
| 85 | |||
| 86 | The Amazon Resource Name (ARN) of the Aurora DB cluster that is | ||
| 87 | currently being promoted, and which is associated with this state. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |