« blib/lib/Paws/Neptune/DescribeDBClusters.pm
↑ Summary
blib/lib/Paws/Neptune/DescribeDBInstances.pm »
| 1 | |||
| 2 | package Paws::Neptune::DescribeDBEngineVersions; | ||
| 3 | use Moose; | ||
| 4 | has DBParameterGroupFamily => (is => 'ro', isa => 'Str'); | ||
| 5 | has DefaultOnly => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Engine => (is => 'ro', isa => 'Str'); | ||
| 7 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 8 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Filter]'); | ||
| 9 | has ListSupportedCharacterSets => (is => 'ro', isa => 'Bool'); | ||
| 10 | has ListSupportedTimezones => (is => 'ro', isa => 'Bool'); | ||
| 11 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 12 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBEngineVersions'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::DBEngineVersionMessage'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBEngineVersionsResult'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Neptune::DescribeDBEngineVersions - Arguments for method DescribeDBEngineVersions on L<Paws::Neptune> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method DescribeDBEngineVersions on the | ||
| 30 | L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class | ||
| 31 | as arguments to method DescribeDBEngineVersions. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBEngineVersions. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $rds = Paws->service('Neptune'); | ||
| 38 | my $DBEngineVersionMessage = $rds->DescribeDBEngineVersions( | ||
| 39 | DBParameterGroupFamily => 'MyString', # OPTIONAL | ||
| 40 | DefaultOnly => 1, # OPTIONAL | ||
| 41 | Engine => 'MyString', # OPTIONAL | ||
| 42 | EngineVersion => 'MyString', # OPTIONAL | ||
| 43 | Filters => [ | ||
| 44 | { | ||
| 45 | Name => 'MyString', | ||
| 46 | Values => [ 'MyString', ... ], | ||
| 47 | |||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # OPTIONAL | ||
| 51 | ListSupportedCharacterSets => 1, # OPTIONAL | ||
| 52 | ListSupportedTimezones => 1, # OPTIONAL | ||
| 53 | Marker => 'MyString', # OPTIONAL | ||
| 54 | MaxRecords => 1, # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $DBEngineVersions = $DBEngineVersionMessage->DBEngineVersions; | ||
| 59 | my $Marker = $DBEngineVersionMessage->Marker; | ||
| 60 | |||
| 61 | # Returns a L<Paws::Neptune::DBEngineVersionMessage> 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/DescribeDBEngineVersions> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 DBParameterGroupFamily => Str | ||
| 70 | |||
| 71 | The name of a specific DB parameter group family to return details for. | ||
| 72 | |||
| 73 | Constraints: | ||
| 74 | |||
| 75 | =over | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | If supplied, must match an existing DBParameterGroupFamily. | ||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 DefaultOnly => Bool | ||
| 87 | |||
| 88 | Indicates that only the default version of the specified engine or | ||
| 89 | engine and major version combination is returned. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Engine => Str | ||
| 94 | |||
| 95 | The database engine to return. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 EngineVersion => Str | ||
| 100 | |||
| 101 | The database engine version to return. | ||
| 102 | |||
| 103 | Example: C<5.1.49> | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 Filters => ArrayRef[L<Paws::Neptune::Filter>] | ||
| 108 | |||
| 109 | Not currently supported. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 ListSupportedCharacterSets => Bool | ||
| 114 | |||
| 115 | If this parameter is specified and the requested engine supports the | ||
| 116 | C<CharacterSetName> parameter for C<CreateDBInstance>, the response | ||
| 117 | includes a list of supported character sets for each engine version. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 ListSupportedTimezones => Bool | ||
| 122 | |||
| 123 | If this parameter is specified and the requested engine supports the | ||
| 124 | C<TimeZone> parameter for C<CreateDBInstance>, the response includes a | ||
| 125 | list of supported time zones for each engine version. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 Marker => Str | ||
| 130 | |||
| 131 | An optional pagination token provided by a previous request. If this | ||
| 132 | parameter is specified, the response includes only records beyond the | ||
| 133 | marker, up to the value specified by C<MaxRecords>. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 MaxRecords => Int | ||
| 138 | |||
| 139 | The maximum number of records to include in the response. If more than | ||
| 140 | the C<MaxRecords> value is available, a pagination token called a | ||
| 141 | marker is included in the response so that the following results can be | ||
| 142 | retrieved. | ||
| 143 | |||
| 144 | Default: 100 | ||
| 145 | |||
| 146 | Constraints: Minimum 20, maximum 100. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head1 SEE ALSO | ||
| 152 | |||
| 153 | This class forms part of L<Paws>, documenting arguments for method DescribeDBEngineVersions in L<Paws::Neptune> | ||
| 154 | |||
| 155 | =head1 BUGS and CONTRIBUTIONS | ||
| 156 | |||
| 157 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 158 | |||
| 159 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 160 | |||
| 161 | =cut | ||
| 162 |