« blib/lib/Paws/Neptune/DescribeEvents.pm
↑ Summary
blib/lib/Paws/Neptune/DescribePendingMaintenanceActions.pm »
| 1 | |||
| 2 | package Paws::Neptune::DescribeOrderableDBInstanceOptions; | ||
| 3 | use Moose; | ||
| 4 | has DBInstanceClass => (is => 'ro', isa => 'Str'); | ||
| 5 | has Engine => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 7 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Filter]'); | ||
| 8 | has LicenseModel => (is => 'ro', isa => 'Str'); | ||
| 9 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 10 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 11 | has Vpc => (is => 'ro', isa => 'Bool'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeOrderableDBInstanceOptions'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::OrderableDBInstanceOptionsMessage'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeOrderableDBInstanceOptionsResult'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Neptune::DescribeOrderableDBInstanceOptions - Arguments for method DescribeOrderableDBInstanceOptions on L<Paws::Neptune> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method DescribeOrderableDBInstanceOptions on the | ||
| 29 | L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class | ||
| 30 | as arguments to method DescribeOrderableDBInstanceOptions. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeOrderableDBInstanceOptions. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $rds = Paws->service('Neptune'); | ||
| 37 | my $OrderableDBInstanceOptionsMessage = | ||
| 38 | $rds->DescribeOrderableDBInstanceOptions( | ||
| 39 | Engine => 'MyString', | ||
| 40 | DBInstanceClass => 'MyString', # OPTIONAL | ||
| 41 | EngineVersion => 'MyString', # OPTIONAL | ||
| 42 | Filters => [ | ||
| 43 | { | ||
| 44 | Name => 'MyString', | ||
| 45 | Values => [ 'MyString', ... ], | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | LicenseModel => 'MyString', # OPTIONAL | ||
| 51 | Marker => 'MyString', # OPTIONAL | ||
| 52 | MaxRecords => 1, # OPTIONAL | ||
| 53 | Vpc => 1, # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $Marker = $OrderableDBInstanceOptionsMessage->Marker; | ||
| 58 | my $OrderableDBInstanceOptions = | ||
| 59 | $OrderableDBInstanceOptionsMessage->OrderableDBInstanceOptions; | ||
| 60 | |||
| 61 | # Returns a L<Paws::Neptune::OrderableDBInstanceOptionsMessage> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeOrderableDBInstanceOptions> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 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 | |||
| 81 | |||
| 82 | =head2 EngineVersion => Str | ||
| 83 | |||
| 84 | The engine version filter value. Specify this parameter to show only | ||
| 85 | the available offerings matching the specified engine version. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Filters => ArrayRef[L<Paws::Neptune::Filter>] | ||
| 90 | |||
| 91 | This parameter is not currently supported. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 LicenseModel => Str | ||
| 96 | |||
| 97 | The license model filter value. Specify this parameter to show only the | ||
| 98 | available offerings matching the specified license model. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 Marker => Str | ||
| 103 | |||
| 104 | An optional pagination token provided by a previous | ||
| 105 | DescribeOrderableDBInstanceOptions request. If this parameter is | ||
| 106 | specified, the response includes only records beyond the marker, up to | ||
| 107 | the value specified by C<MaxRecords> . | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 MaxRecords => Int | ||
| 112 | |||
| 113 | The maximum number of records to include in the response. If more | ||
| 114 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 115 | token called a marker is included in the response so that the remaining | ||
| 116 | results can be retrieved. | ||
| 117 | |||
| 118 | Default: 100 | ||
| 119 | |||
| 120 | Constraints: Minimum 20, maximum 100. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 Vpc => Bool | ||
| 125 | |||
| 126 | The VPC filter value. Specify this parameter to show only the available | ||
| 127 | VPC or non-VPC offerings. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, documenting arguments for method DescribeOrderableDBInstanceOptions in L<Paws::Neptune> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |