« blib/lib/Paws/RDS/FailoverDBClusterResult.pm
↑ Summary
blib/lib/Paws/RDS/FailoverGlobalClusterResult.pm »
| 1 | |||
| 2 | package Paws::RDS::FailoverGlobalCluster; | ||
| 3 | use Moose; | ||
| 4 | has GlobalClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has TargetDbClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'FailoverGlobalCluster'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::FailoverGlobalClusterResult'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'FailoverGlobalClusterResult'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::RDS::FailoverGlobalCluster - Arguments for method FailoverGlobalCluster on L<Paws::RDS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method FailoverGlobalCluster on the | ||
| 23 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 24 | as arguments to method FailoverGlobalCluster. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to FailoverGlobalCluster. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $rds = Paws->service('RDS'); | ||
| 31 | my $FailoverGlobalClusterResult = $rds->FailoverGlobalCluster( | ||
| 32 | GlobalClusterIdentifier => 'MyGlobalClusterIdentifier', | ||
| 33 | TargetDbClusterIdentifier => 'MyDBClusterIdentifier', | ||
| 34 | |||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $GlobalCluster = $FailoverGlobalClusterResult->GlobalCluster; | ||
| 39 | |||
| 40 | # Returns a L<Paws::RDS::FailoverGlobalClusterResult> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/FailoverGlobalCluster> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> GlobalClusterIdentifier => Str | ||
| 49 | |||
| 50 | Identifier of the Aurora global database (GlobalCluster) that should be | ||
| 51 | failed over. The identifier is the unique key assigned by the user when | ||
| 52 | the Aurora global database was created. In other words, it's the name | ||
| 53 | of the Aurora global database that you want to fail over. | ||
| 54 | |||
| 55 | Constraints: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | Must match the identifier of an existing GlobalCluster (Aurora global | ||
| 62 | database). | ||
| 63 | |||
| 64 | =back | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> TargetDbClusterIdentifier => Str | ||
| 70 | |||
| 71 | Identifier of the secondary Aurora DB cluster that you want to promote | ||
| 72 | to primary for the Aurora global database (GlobalCluster.) Use the | ||
| 73 | Amazon Resource Name (ARN) for the identifier so that Aurora can locate | ||
| 74 | the cluster in its Amazon Web Services Region. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, documenting arguments for method FailoverGlobalCluster in L<Paws::RDS> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |