File Coverage

blib/lib/Paws/RDS/FailoverDBCluster.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RDS::FailoverDBCluster;
3 1     1   611 use Moose;
  1         8  
  1         10  
4             has DBClusterIdentifier => (is => 'ro', isa => 'Str');
5             has TargetDBInstanceIdentifier => (is => 'ro', isa => 'Str');
6              
7 1     1   11185 use MooseX::ClassAttribute;
  1         4  
  1         13  
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 Paws::RDS
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method FailoverDBCluster on the
23             Amazon Relational Database Service 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             As an example:
29              
30             $service_obj->FailoverDBCluster(Att1 => $value1, Att2 => $value2, ...);
31              
32             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.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 DBClusterIdentifier => Str
38              
39             A DB cluster identifier to force a failover for. This parameter is not
40             case-sensitive.
41              
42             Constraints:
43              
44             =over
45              
46             =item *
47              
48             Must contain from 1 to 63 alphanumeric characters or hyphens
49              
50             =item *
51              
52             First character must be a letter
53              
54             =item *
55              
56             Cannot end with a hyphen or contain two consecutive hyphens
57              
58             =back
59              
60              
61              
62              
63             =head2 TargetDBInstanceIdentifier => Str
64              
65             The name of the instance to promote to the primary instance.
66              
67             You must specify the instance identifier for an Aurora Replica in the
68             DB cluster. For example, C<mydbcluster-replica1>.
69              
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, documenting arguments for method FailoverDBCluster in L<Paws::RDS>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84