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   317 use Moose;
  1         1  
  1         7  
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             has RequiresAutoMinorEngineVersionUpgrade => (is => 'ro', isa => 'Bool');
17             has SupportsOptionVersionDowngrade => (is => 'ro', isa => 'Bool');
18             has VpcOnly => (is => 'ro', isa => 'Bool');
19             1;
20              
21             ### main pod documentation begin ###
22              
23             =head1 NAME
24              
25             Paws::RDS::OptionGroupOption
26              
27             =head1 USAGE
28              
29             This class represents one of two things:
30              
31             =head3 Arguments in a call to a service
32              
33             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
34             Each attribute should be used as a named argument in the calls that expect this type of object.
35              
36             As an example, if Att1 is expected to be a Paws::RDS::OptionGroupOption object:
37              
38             $service_obj->Method(Att1 => { DefaultPort => $value, ..., VpcOnly => $value });
39              
40             =head3 Results returned from an API call
41              
42             Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::OptionGroupOption object:
43              
44             $result = $service_obj->Method(...);
45             $result->Att1->DefaultPort
46              
47             =head1 DESCRIPTION
48              
49             Available option.
50              
51             =head1 ATTRIBUTES
52              
53              
54             =head2 DefaultPort => Int
55              
56             If the option requires a port, specifies the default port for the
57             option.
58              
59              
60             =head2 Description => Str
61              
62             The description of the option.
63              
64              
65             =head2 EngineName => Str
66              
67             The name of the engine that this option can be applied to.
68              
69              
70             =head2 MajorEngineVersion => Str
71              
72             Indicates the major engine version that the option is available for.
73              
74              
75             =head2 MinimumRequiredMinorEngineVersion => Str
76              
77             The minimum required engine version for the option to be applied.
78              
79              
80             =head2 Name => Str
81              
82             The name of the option.
83              
84              
85             =head2 OptionGroupOptionSettings => ArrayRef[L<Paws::RDS::OptionGroupOptionSetting>]
86              
87             The option settings that are available (and the default value) for each
88             option in an option group.
89              
90              
91             =head2 OptionGroupOptionVersions => ArrayRef[L<Paws::RDS::OptionVersion>]
92              
93             The versions that are available for the option.
94              
95              
96             =head2 OptionsConflictsWith => ArrayRef[Str|Undef]
97              
98             The options that conflict with this option.
99              
100              
101             =head2 OptionsDependedOn => ArrayRef[Str|Undef]
102              
103             The options that are prerequisites for this option.
104              
105              
106             =head2 Permanent => Bool
107              
108             Permanent options can never be removed from an option group. An option
109             group containing a permanent option can't be removed from a DB
110             instance.
111              
112              
113             =head2 Persistent => Bool
114              
115             Persistent options can't be removed from an option group while DB
116             instances are associated with the option group. If you disassociate all
117             DB instances from the option group, your can remove the persistent
118             option from the option group.
119              
120              
121             =head2 PortRequired => Bool
122              
123             Specifies whether the option requires a port.
124              
125              
126             =head2 RequiresAutoMinorEngineVersionUpgrade => Bool
127              
128             If true, you must enable the Auto Minor Version Upgrade setting for
129             your DB instance before you can use this option. You can enable Auto
130             Minor Version Upgrade when you first create your DB instance, or by
131             modifying your DB instance later.
132              
133              
134             =head2 SupportsOptionVersionDowngrade => Bool
135              
136             If true, you can change the option to an earlier version of the option.
137             This only applies to options that have different versions available.
138              
139              
140             =head2 VpcOnly => Bool
141              
142             If true, you can only use this option with a DB instance that is in a
143             VPC.
144              
145              
146              
147             =head1 SEE ALSO
148              
149             This class forms part of L<Paws>, describing an object used in L<Paws::RDS>
150              
151             =head1 BUGS and CONTRIBUTIONS
152              
153             The source code is located here: https://github.com/pplu/aws-sdk-perl
154              
155             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
156              
157             =cut
158