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