| 1 | |||
| 2 | package Paws::RDS::FailoverDBCluster; | ||
| 3 | use Moose; | ||
| 4 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has TargetDBInstanceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'FailoverDBCluster'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::FailoverDBClusterResult'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'FailoverDBClusterResult'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::RDS::FailoverDBCluster - Arguments for method FailoverDBCluster on L<Paws::RDS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method FailoverDBCluster on the | ||
| 23 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 24 | as arguments to method FailoverDBCluster. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to FailoverDBCluster. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $rds = Paws->service('RDS'); | ||
| 31 | # To perform a failover for a DB cluster | ||
| 32 | # This example performs a failover for the specified DB cluster to the specified | ||
| 33 | # DB instance. | ||
| 34 | my $FailoverDBClusterResult = $rds->FailoverDBCluster( | ||
| 35 | 'DBClusterIdentifier' => 'myaurorainstance-cluster', | ||
| 36 | 'TargetDBInstanceIdentifier' => 'myaurorareplica' | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $DBCluster = $FailoverDBClusterResult->DBCluster; | ||
| 41 | |||
| 42 | # Returns a L<Paws::RDS::FailoverDBClusterResult> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/FailoverDBCluster> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 51 | |||
| 52 | A DB cluster identifier to force a failover for. This parameter isn't | ||
| 53 | case-sensitive. | ||
| 54 | |||
| 55 | Constraints: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | Must match the identifier of an existing DBCluster. | ||
| 62 | |||
| 63 | =back | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 TargetDBInstanceIdentifier => Str | ||
| 69 | |||
| 70 | The name of the instance to promote to the primary instance. | ||
| 71 | |||
| 72 | You must specify the instance identifier for an Aurora Replica in the | ||
| 73 | DB cluster. For example, C<mydbcluster-replica1>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method FailoverDBCluster 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 |