« blib/lib/Paws/RDS/DescribeInstallationMedia.pm
↑ Summary
blib/lib/Paws/RDS/DescribeOrderableDBInstanceOptions.pm »
| 1 | |||
| 2 | package Paws::RDS::DescribeOptionGroupOptions; | ||
| 3 | use Moose; | ||
| 4 | has EngineName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]'); | ||
| 6 | has MajorEngineVersion => (is => 'ro', isa => 'Str'); | ||
| 7 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeOptionGroupOptions'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::OptionGroupOptionsMessage'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeOptionGroupOptionsResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::RDS::DescribeOptionGroupOptions - Arguments for method DescribeOptionGroupOptions on L<Paws::RDS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeOptionGroupOptions on the | ||
| 26 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeOptionGroupOptions. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeOptionGroupOptions. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rds = Paws->service('RDS'); | ||
| 34 | # To list information about DB option group options | ||
| 35 | # This example lists information for all option group options for the specified | ||
| 36 | # DB engine. | ||
| 37 | my $OptionGroupOptionsMessage = $rds->DescribeOptionGroupOptions( | ||
| 38 | 'EngineName' => 'mysql', | ||
| 39 | 'MajorEngineVersion' => 5.6 | ||
| 40 | ); | ||
| 41 | |||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeOptionGroupOptions> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> EngineName => Str | ||
| 50 | |||
| 51 | A required parameter. Options available for the given engine name are | ||
| 52 | described. | ||
| 53 | |||
| 54 | Valid Values: | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | C<mariadb> | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | C<mysql> | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<oracle-ee> | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<oracle-ee-cdb> | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<oracle-se2> | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<oracle-se2-cdb> | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<postgres> | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<sqlserver-ee> | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<sqlserver-se> | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<sqlserver-ex> | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<sqlserver-web> | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 Filters => ArrayRef[L<Paws::RDS::Filter>] | ||
| 108 | |||
| 109 | This parameter isn't currently supported. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 MajorEngineVersion => Str | ||
| 114 | |||
| 115 | If specified, filters the results to include only options for the | ||
| 116 | specified major engine version. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 Marker => Str | ||
| 121 | |||
| 122 | An optional pagination token provided by a previous request. If this | ||
| 123 | parameter is specified, the response includes only records beyond the | ||
| 124 | marker, up to the value specified by C<MaxRecords>. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 MaxRecords => Int | ||
| 129 | |||
| 130 | The maximum number of records to include in the response. If more | ||
| 131 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 132 | token called a marker is included in the response so that you can | ||
| 133 | retrieve the remaining results. | ||
| 134 | |||
| 135 | Default: 100 | ||
| 136 | |||
| 137 | Constraints: Minimum 20, maximum 100. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head1 SEE ALSO | ||
| 143 | |||
| 144 | This class forms part of L<Paws>, documenting arguments for method DescribeOptionGroupOptions in L<Paws::RDS> | ||
| 145 | |||
| 146 | =head1 BUGS and CONTRIBUTIONS | ||
| 147 | |||
| 148 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 149 | |||
| 150 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 151 | |||
| 152 | =cut | ||
| 153 |