« blib/lib/Paws/Neptune/DescribeDBParameterGroups.pm
↑ Summary
blib/lib/Paws/Neptune/DescribeDBSubnetGroups.pm »
| 1 | |||
| 2 | package Paws::Neptune::DescribeDBParameters; | ||
| 3 | use Moose; | ||
| 4 | has DBParameterGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Filter]'); | ||
| 6 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 8 | has Source => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBParameters'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::DBParameterGroupDetails'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBParametersResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Neptune::DescribeDBParameters - Arguments for method DescribeDBParameters on L<Paws::Neptune> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeDBParameters on the | ||
| 26 | L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeDBParameters. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBParameters. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rds = Paws->service('Neptune'); | ||
| 34 | my $DBParameterGroupDetails = $rds->DescribeDBParameters( | ||
| 35 | DBParameterGroupName => 'MyString', | ||
| 36 | Filters => [ | ||
| 37 | { | ||
| 38 | Name => 'MyString', | ||
| 39 | Values => [ 'MyString', ... ], | ||
| 40 | |||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], # OPTIONAL | ||
| 44 | Marker => 'MyString', # OPTIONAL | ||
| 45 | MaxRecords => 1, # OPTIONAL | ||
| 46 | Source => 'MyString', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $Marker = $DBParameterGroupDetails->Marker; | ||
| 51 | my $Parameters = $DBParameterGroupDetails->Parameters; | ||
| 52 | |||
| 53 | # Returns a L<Paws::Neptune::DBParameterGroupDetails> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBParameters> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> DBParameterGroupName => Str | ||
| 62 | |||
| 63 | The name of a specific DB parameter group to return details for. | ||
| 64 | |||
| 65 | Constraints: | ||
| 66 | |||
| 67 | =over | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | If supplied, must match the name of an existing DBParameterGroup. | ||
| 72 | |||
| 73 | =back | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 Filters => ArrayRef[L<Paws::Neptune::Filter>] | ||
| 79 | |||
| 80 | This parameter is not currently supported. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 Marker => Str | ||
| 85 | |||
| 86 | An optional pagination token provided by a previous | ||
| 87 | C<DescribeDBParameters> request. If this parameter is specified, the | ||
| 88 | response includes only records beyond the marker, up to the value | ||
| 89 | specified by C<MaxRecords>. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 MaxRecords => Int | ||
| 94 | |||
| 95 | The maximum number of records to include in the response. If more | ||
| 96 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 97 | token called a marker is included in the response so that the remaining | ||
| 98 | results can be retrieved. | ||
| 99 | |||
| 100 | Default: 100 | ||
| 101 | |||
| 102 | Constraints: Minimum 20, maximum 100. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 Source => Str | ||
| 107 | |||
| 108 | The parameter types to return. | ||
| 109 | |||
| 110 | Default: All parameter types returned | ||
| 111 | |||
| 112 | Valid Values: C<user | system | engine-default> | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head1 SEE ALSO | ||
| 118 | |||
| 119 | This class forms part of L<Paws>, documenting arguments for method DescribeDBParameters in L<Paws::Neptune> | ||
| 120 | |||
| 121 | =head1 BUGS and CONTRIBUTIONS | ||
| 122 | |||
| 123 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 124 | |||
| 125 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 126 | |||
| 127 | =cut | ||
| 128 |