File Coverage

blib/lib/Paws/RDS/OptionGroupOption.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::RDS::OptionGroupOption;
2 1     1   729 use Moose;
  1         3  
  1         11  
3             has DefaultPort => (is => 'ro', isa => 'Int');
4             has Description => (is => 'ro', isa => 'Str');
5             has EngineName => (is => 'ro', isa => 'Str');
6             has MajorEngineVersion => (is => 'ro', isa => 'Str');
7             has MinimumRequiredMinorEngineVersion => (is => 'ro', isa => 'Str');
8             has Name => (is => 'ro', isa => 'Str');
9             has OptionGroupOptionSettings => (is => 'ro', isa => 'ArrayRef[Paws::RDS::OptionGroupOptionSetting]', request_name => 'OptionGroupOptionSetting', traits => ['NameInRequest']);
10             has OptionGroupOptionVersions => (is => 'ro', isa => 'ArrayRef[Paws::RDS::OptionVersion]', request_name => 'OptionVersion', traits => ['NameInRequest']);
11             has OptionsConflictsWith => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'OptionConflictName', traits => ['NameInRequest']);
12             has OptionsDependedOn => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'OptionName', traits => ['NameInRequest']);
13             has Permanent => (is => 'ro', isa => 'Bool');
14             has Persistent => (is => 'ro', isa => 'Bool');
15             has PortRequired => (is => 'ro', isa => 'Bool');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::RDS::OptionGroupOption
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::RDS::OptionGroupOption object:
34              
35             $service_obj->Method(Att1 => { DefaultPort => $value, ..., PortRequired => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::OptionGroupOption object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->DefaultPort
43              
44             =head1 DESCRIPTION
45              
46             Available option.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 DefaultPort => Int
52              
53             If the option requires a port, specifies the default port for the
54             option.
55              
56              
57             =head2 Description => Str
58              
59             The description of the option.
60              
61              
62             =head2 EngineName => Str
63              
64             The name of the engine that this option can be applied to.
65              
66              
67             =head2 MajorEngineVersion => Str
68              
69             Indicates the major engine version that the option is available for.
70              
71              
72             =head2 MinimumRequiredMinorEngineVersion => Str
73              
74             The minimum required engine version for the option to be applied.
75              
76              
77             =head2 Name => Str
78              
79             The name of the option.
80              
81              
82             =head2 OptionGroupOptionSettings => ArrayRef[L<Paws::RDS::OptionGroupOptionSetting>]
83              
84             The option settings that are available (and the default value) for each
85             option in an option group.
86              
87              
88             =head2 OptionGroupOptionVersions => ArrayRef[L<Paws::RDS::OptionVersion>]
89              
90             The versions that are available for the option.
91              
92              
93             =head2 OptionsConflictsWith => ArrayRef[Str|Undef]
94              
95             The options that conflict with this option.
96              
97              
98             =head2 OptionsDependedOn => ArrayRef[Str|Undef]
99              
100             The options that are prerequisites for this option.
101              
102              
103             =head2 Permanent => Bool
104              
105             Permanent options can never be removed from an option group. An option
106             group containing a permanent option can't be removed from a DB
107             instance.
108              
109              
110             =head2 Persistent => Bool
111              
112             Persistent options can't be removed from an option group while DB
113             instances are associated with the option group. If you disassociate all
114             DB instances from the option group, your can remove the persistent
115             option from the option group.
116              
117              
118             =head2 PortRequired => Bool
119              
120             Specifies whether the option requires a port.
121              
122              
123              
124             =head1 SEE ALSO
125              
126             This class forms part of L<Paws>, describing an object used in L<Paws::RDS>
127              
128             =head1 BUGS and CONTRIBUTIONS
129              
130             The source code is located here: https://github.com/pplu/aws-sdk-perl
131              
132             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
133              
134             =cut
135