File Coverage

blib/lib/Paws/ElasticBeanstalk/ConfigurationOptionDescription.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::ElasticBeanstalk::ConfigurationOptionDescription;
2 1     1   534 use Moose;
  1     1   5  
  1         8  
  1         593  
  1         6  
  1         7  
3             has ChangeSeverity => (is => 'ro', isa => 'Str');
4             has DefaultValue => (is => 'ro', isa => 'Str');
5             has MaxLength => (is => 'ro', isa => 'Int');
6             has MaxValue => (is => 'ro', isa => 'Int');
7             has MinValue => (is => 'ro', isa => 'Int');
8             has Name => (is => 'ro', isa => 'Str');
9             has Namespace => (is => 'ro', isa => 'Str');
10             has Regex => (is => 'ro', isa => 'Paws::ElasticBeanstalk::OptionRestrictionRegex');
11             has UserDefined => (is => 'ro', isa => 'Bool');
12             has ValueOptions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13             has ValueType => (is => 'ro', isa => 'Str');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::ElasticBeanstalk::ConfigurationOptionDescription
21              
22             =head1 USAGE
23              
24             This class represents one of two things:
25              
26             =head3 Arguments in a call to a service
27              
28             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29             Each attribute should be used as a named argument in the calls that expect this type of object.
30              
31             As an example, if Att1 is expected to be a Paws::ElasticBeanstalk::ConfigurationOptionDescription object:
32              
33             $service_obj->Method(Att1 => { ChangeSeverity => $value, ..., ValueType => $value });
34              
35             =head3 Results returned from an API call
36              
37             Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticBeanstalk::ConfigurationOptionDescription object:
38              
39             $result = $service_obj->Method(...);
40             $result->Att1->ChangeSeverity
41              
42             =head1 DESCRIPTION
43              
44             Describes the possible values for a configuration option.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 ChangeSeverity => Str
50              
51             An indication of which action is required if the value for this
52             configuration option changes:
53              
54             =over
55              
56             =item *
57              
58             C<NoInterruption> : There is no interruption to the environment or
59             application availability.
60              
61             =item *
62              
63             C<RestartEnvironment> : The environment is entirely restarted, all AWS
64             resources are deleted and recreated, and the environment is unavailable
65             during the process.
66              
67             =item *
68              
69             C<RestartApplicationServer> : The environment is available the entire
70             time. However, a short application outage occurs when the application
71             servers on the running Amazon EC2 instances are restarted.
72              
73             =back
74              
75              
76              
77             =head2 DefaultValue => Str
78              
79             The default value for this configuration option.
80              
81              
82             =head2 MaxLength => Int
83              
84             If specified, the configuration option must be a string value no longer
85             than this value.
86              
87              
88             =head2 MaxValue => Int
89              
90             If specified, the configuration option must be a numeric value less
91             than this value.
92              
93              
94             =head2 MinValue => Int
95              
96             If specified, the configuration option must be a numeric value greater
97             than this value.
98              
99              
100             =head2 Name => Str
101              
102             The name of the configuration option.
103              
104              
105             =head2 Namespace => Str
106              
107             A unique namespace identifying the option's associated AWS resource.
108              
109              
110             =head2 Regex => L<Paws::ElasticBeanstalk::OptionRestrictionRegex>
111              
112             If specified, the configuration option must be a string value that
113             satisfies this regular expression.
114              
115              
116             =head2 UserDefined => Bool
117              
118             An indication of whether the user defined this configuration option:
119              
120             =over
121              
122             =item *
123              
124             C<true> : This configuration option was defined by the user. It is a
125             valid choice for specifying if this as an C<Option to Remove> when
126             updating configuration settings.
127              
128             =item *
129              
130             C<false> : This configuration was not defined by the user.
131              
132             =back
133              
134             Constraint: You can remove only C<UserDefined> options from a
135             configuration.
136              
137             Valid Values: C<true> | C<false>
138              
139              
140             =head2 ValueOptions => ArrayRef[Str|Undef]
141              
142             If specified, values for the configuration option are selected from
143             this list.
144              
145              
146             =head2 ValueType => Str
147              
148             An indication of which type of values this option has and whether it is
149             allowable to select one or more than one of the possible values:
150              
151             =over
152              
153             =item *
154              
155             C<Scalar> : Values for this option are a single selection from the
156             possible values, or an unformatted string, or numeric value governed by
157             the C<MIN/MAX/Regex> constraints.
158              
159             =item *
160              
161             C<List> : Values for this option are multiple selections from the
162             possible values.
163              
164             =item *
165              
166             C<Boolean> : Values for this option are either C<true> or C<false> .
167              
168             =item *
169              
170             C<Json> : Values for this option are a JSON representation of a
171             C<ConfigDocument>.
172              
173             =back
174              
175              
176              
177              
178             =head1 SEE ALSO
179              
180             This class forms part of L<Paws>, describing an object used in L<Paws::ElasticBeanstalk>
181              
182             =head1 BUGS and CONTRIBUTIONS
183              
184             The source code is located here: https://github.com/pplu/aws-sdk-perl
185              
186             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
187              
188             =cut
189