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