File Coverage

blib/lib/Paws/RedShift/ClusterParameterStatus.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             package Paws::RedShift::ClusterParameterStatus;
2 1     1   865 use Moose;
  1     1   6  
  1         11  
  1         638  
  1         3  
  1         8  
3             has ParameterApplyErrorDescription => (is => 'ro', isa => 'Str');
4             has ParameterApplyStatus => (is => 'ro', isa => 'Str');
5             has ParameterName => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::RedShift::ClusterParameterStatus
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::RedShift::ClusterParameterStatus object:
24              
25             $service_obj->Method(Att1 => { ParameterApplyErrorDescription => $value, ..., ParameterName => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::RedShift::ClusterParameterStatus object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->ParameterApplyErrorDescription
33              
34             =head1 DESCRIPTION
35              
36             Describes the status of a parameter group.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 ParameterApplyErrorDescription => Str
42              
43             The error that prevented the parameter from being applied to the
44             database.
45              
46              
47             =head2 ParameterApplyStatus => Str
48              
49             The status of the parameter that indicates whether the parameter is in
50             sync with the database, waiting for a cluster reboot, or encountered an
51             error when being applied.
52              
53             The following are possible statuses and descriptions.
54              
55             =over
56              
57             =item *
58              
59             C<in-sync>: The parameter value is in sync with the database.
60              
61             =item *
62              
63             C<pending-reboot>: The parameter value will be applied after the
64             cluster reboots.
65              
66             =item *
67              
68             C<applying>: The parameter value is being applied to the database.
69              
70             =item *
71              
72             C<invalid-parameter>: Cannot apply the parameter value because it has
73             an invalid value or syntax.
74              
75             =item *
76              
77             C<apply-deferred>: The parameter contains static property changes. The
78             changes are deferred until the cluster reboots.
79              
80             =item *
81              
82             C<apply-error>: Cannot connect to the cluster. The parameter change
83             will be applied after the cluster reboots.
84              
85             =item *
86              
87             C<unknown-error>: Cannot apply the parameter change right now. The
88             change will be applied after the cluster reboots.
89              
90             =back
91              
92              
93              
94             =head2 ParameterName => Str
95              
96             The name of the parameter.
97              
98              
99              
100             =head1 SEE ALSO
101              
102             This class forms part of L<Paws>, describing an object used in L<Paws::RedShift>
103              
104             =head1 BUGS and CONTRIBUTIONS
105              
106             The source code is located here: https://github.com/pplu/aws-sdk-perl
107              
108             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
109              
110             =cut
111