NAME
Paws::DocDB::DescribeGlobalClusters - Arguments for method DescribeGlobalClusters on Paws::DocDB
DESCRIPTION
This class represents the parameters used for calling the method DescribeGlobalClusters on the Amazon DocumentDB with MongoDB compatibility service. Use the attributes of this class as arguments to method DescribeGlobalClusters.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeGlobalClusters.
SYNOPSIS
my $rds = Paws->service('DocDB');
my $GlobalClustersMessage = $rds->DescribeGlobalClusters(
Filters => [
{
Name => 'MyString',
Values => [ 'MyString', ... ],
},
...
], # OPTIONAL
GlobalClusterIdentifier => 'MyGlobalClusterIdentifier', # OPTIONAL
Marker => 'MyString', # OPTIONAL
MaxRecords => 1, # OPTIONAL
);
# Results:
my $GlobalClusters = $GlobalClustersMessage->GlobalClusters;
my $Marker = $GlobalClustersMessage->Marker;
# Returns a L<Paws::DocDB::GlobalClustersMessage> object.
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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeGlobalClusters
ATTRIBUTES
Filters => ArrayRef[Paws::DocDB::Filter]
A filter that specifies one or more global DB clusters to describe.
Supported filters: db-cluster-id
accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.
GlobalClusterIdentifier => Str
The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.
Marker => Str
An optional pagination token provided by a previous DescribeGlobalClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
MaxRecords => Int
The maximum number of records to include in the response. If more records exist than the specified MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
SEE ALSO
This class forms part of Paws, documenting arguments for method DescribeGlobalClusters in Paws::DocDB
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues