« blib/lib/Paws/Neptune/EventsMessage.pm
↑ Summary
blib/lib/Paws/Neptune/FailoverDBClusterResult.pm »
| 1 | |||
| 2 | package Paws::Neptune::FailoverDBCluster; | ||
| 3 | use Moose; | ||
| 4 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 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::Neptune::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::Neptune::FailoverDBCluster - Arguments for method FailoverDBCluster on L<Paws::Neptune> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method FailoverDBCluster on the | ||
| 23 | L<Amazon Neptune|Paws::Neptune> 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('Neptune'); | ||
| 31 | my $FailoverDBClusterResult = $rds->FailoverDBCluster( | ||
| 32 | DBClusterIdentifier => 'MyString', # OPTIONAL | ||
| 33 | TargetDBInstanceIdentifier => 'MyString', # OPTIONAL | ||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $DBCluster = $FailoverDBClusterResult->DBCluster; | ||
| 38 | |||
| 39 | # Returns a L<Paws::Neptune::FailoverDBClusterResult> object. | ||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/FailoverDBCluster> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 DBClusterIdentifier => Str | ||
| 48 | |||
| 49 | A DB cluster identifier to force a failover for. This parameter is not | ||
| 50 | case-sensitive. | ||
| 51 | |||
| 52 | Constraints: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | Must match the identifier of an existing DBCluster. | ||
| 59 | |||
| 60 | =back | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 TargetDBInstanceIdentifier => Str | ||
| 66 | |||
| 67 | The name of the instance to promote to the primary instance. | ||
| 68 | |||
| 69 | You must specify the instance identifier for an Read Replica in the DB | ||
| 70 | cluster. For example, C<mydbcluster-replica1>. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method FailoverDBCluster in L<Paws::Neptune> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |