« blib/lib/Paws/RDS/DescribeOptionGroupOptions.pm
↑ Summary
blib/lib/Paws/RDS/DescribePendingMaintenanceActions.pm »
| 1 | |||
| 2 | package Paws::RDS::DescribeOrderableDBInstanceOptions; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZoneGroup => (is => 'ro', isa => 'Str'); | ||
| 5 | has DBInstanceClass => (is => 'ro', isa => 'Str'); | ||
| 6 | has Engine => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 8 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]'); | ||
| 9 | has LicenseModel => (is => 'ro', isa => 'Str'); | ||
| 10 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 11 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 12 | has Vpc => (is => 'ro', isa => 'Bool'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeOrderableDBInstanceOptions'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::OrderableDBInstanceOptionsMessage'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeOrderableDBInstanceOptionsResult'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::RDS::DescribeOrderableDBInstanceOptions - Arguments for method DescribeOrderableDBInstanceOptions on L<Paws::RDS> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method DescribeOrderableDBInstanceOptions on the | ||
| 30 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 31 | as arguments to method DescribeOrderableDBInstanceOptions. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeOrderableDBInstanceOptions. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $rds = Paws->service('RDS'); | ||
| 38 | # To list information about orderable DB instance options | ||
| 39 | # This example lists information for all orderable DB instance options for the | ||
| 40 | # specified DB engine, engine version, DB instance class, license model, and VPC | ||
| 41 | # settings. | ||
| 42 | my $OrderableDBInstanceOptionsMessage = | ||
| 43 | $rds->DescribeOrderableDBInstanceOptions( | ||
| 44 | 'DBInstanceClass' => 'db.t2.micro', | ||
| 45 | 'Engine' => 'mysql', | ||
| 46 | 'EngineVersion' => '5.6.27', | ||
| 47 | 'LicenseModel' => 'general-public-license', | ||
| 48 | 'Vpc' => 1 | ||
| 49 | ); | ||
| 50 | |||
| 51 | |||
| 52 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeOrderableDBInstanceOptions> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AvailabilityZoneGroup => Str | ||
| 59 | |||
| 60 | The Availability Zone group associated with a Local Zone. Specify this | ||
| 61 | parameter to retrieve available offerings for the Local Zones in the | ||
| 62 | group. | ||
| 63 | |||
| 64 | Omit this parameter to show the available offerings in the specified | ||
| 65 | Amazon Web Services Region. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 DBInstanceClass => Str | ||
| 70 | |||
| 71 | The DB instance class filter value. Specify this parameter to show only | ||
| 72 | the available offerings matching the specified DB instance class. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> Engine => Str | ||
| 77 | |||
| 78 | The name of the engine to retrieve DB instance options for. | ||
| 79 | |||
| 80 | Valid Values: | ||
| 81 | |||
| 82 | =over | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<aurora> (for MySQL 5.6-compatible Aurora) | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | C<aurora-mysql> (for MySQL 5.7-compatible Aurora) | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<aurora-postgresql> | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<mariadb> | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<mysql> | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<oracle-ee> | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<oracle-ee-cdb> | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<oracle-se2> | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | C<oracle-se2-cdb> | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<postgres> | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<sqlserver-ee> | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | C<sqlserver-se> | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | C<sqlserver-ex> | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | C<sqlserver-web> | ||
| 139 | |||
| 140 | =back | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 EngineVersion => Str | ||
| 146 | |||
| 147 | The engine version filter value. Specify this parameter to show only | ||
| 148 | the available offerings matching the specified engine version. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 Filters => ArrayRef[L<Paws::RDS::Filter>] | ||
| 153 | |||
| 154 | This parameter isn't currently supported. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 LicenseModel => Str | ||
| 159 | |||
| 160 | The license model filter value. Specify this parameter to show only the | ||
| 161 | available offerings matching the specified license model. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 Marker => Str | ||
| 166 | |||
| 167 | An optional pagination token provided by a previous | ||
| 168 | DescribeOrderableDBInstanceOptions request. If this parameter is | ||
| 169 | specified, the response includes only records beyond the marker, up to | ||
| 170 | the value specified by C<MaxRecords> . | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 MaxRecords => Int | ||
| 175 | |||
| 176 | The maximum number of records to include in the response. If more | ||
| 177 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 178 | token called a marker is included in the response so that you can | ||
| 179 | retrieve the remaining results. | ||
| 180 | |||
| 181 | Default: 100 | ||
| 182 | |||
| 183 | Constraints: Minimum 20, maximum 100. | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | =head2 Vpc => Bool | ||
| 188 | |||
| 189 | A value that indicates whether to show only VPC or non-VPC offerings. | ||
| 190 | |||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | =head1 SEE ALSO | ||
| 195 | |||
| 196 | This class forms part of L<Paws>, documenting arguments for method DescribeOrderableDBInstanceOptions in L<Paws::RDS> | ||
| 197 | |||
| 198 | =head1 BUGS and CONTRIBUTIONS | ||
| 199 | |||
| 200 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 201 | |||
| 202 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 203 | |||
| 204 | =cut | ||
| 205 |