« blib/lib/Paws/DocDB/DescribeEvents.pm
↑ Summary
blib/lib/Paws/DocDB/DescribeOrderableDBInstanceOptions.pm »
| 1 | |||
| 2 | package Paws::DocDB::DescribeGlobalClusters; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Filter]'); | ||
| 5 | has GlobalClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 6 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeGlobalClusters'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::GlobalClustersMessage'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeGlobalClustersResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::DocDB::DescribeGlobalClusters - Arguments for method DescribeGlobalClusters on L<Paws::DocDB> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeGlobalClusters on the | ||
| 25 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeGlobalClusters. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeGlobalClusters. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('DocDB'); | ||
| 33 | my $GlobalClustersMessage = $rds->DescribeGlobalClusters( | ||
| 34 | Filters => [ | ||
| 35 | { | ||
| 36 | Name => 'MyString', | ||
| 37 | Values => [ 'MyString', ... ], | ||
| 38 | |||
| 39 | }, | ||
| 40 | ... | ||
| 41 | ], # OPTIONAL | ||
| 42 | GlobalClusterIdentifier => 'MyGlobalClusterIdentifier', # OPTIONAL | ||
| 43 | Marker => 'MyString', # OPTIONAL | ||
| 44 | MaxRecords => 1, # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $GlobalClusters = $GlobalClustersMessage->GlobalClusters; | ||
| 49 | my $Marker = $GlobalClustersMessage->Marker; | ||
| 50 | |||
| 51 | # Returns a L<Paws::DocDB::GlobalClustersMessage> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeGlobalClusters> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Filters => ArrayRef[L<Paws::DocDB::Filter>] | ||
| 60 | |||
| 61 | A filter that specifies one or more global DB clusters to describe. | ||
| 62 | |||
| 63 | Supported filters: C<db-cluster-id> accepts cluster identifiers and | ||
| 64 | cluster Amazon Resource Names (ARNs). The results list will only | ||
| 65 | include information about the clusters identified by these ARNs. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 GlobalClusterIdentifier => Str | ||
| 70 | |||
| 71 | The user-supplied cluster identifier. If this parameter is specified, | ||
| 72 | information from only the specific cluster is returned. This parameter | ||
| 73 | isn't case-sensitive. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 Marker => Str | ||
| 78 | |||
| 79 | An optional pagination token provided by a previous | ||
| 80 | C<DescribeGlobalClusters> request. If this parameter is specified, the | ||
| 81 | response includes only records beyond the marker, up to the value | ||
| 82 | specified by C<MaxRecords>. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 MaxRecords => Int | ||
| 87 | |||
| 88 | The maximum number of records to include in the response. If more | ||
| 89 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 90 | token called a marker is included in the response so that you can | ||
| 91 | retrieve the remaining results. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method DescribeGlobalClusters in L<Paws::DocDB> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |