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