GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::DocDB::DescribeGlobalClusters(3) User Contributed Perl Documentation Paws::DocDB::DescribeGlobalClusters(3)

Paws::DocDB::DescribeGlobalClusters - Arguments for method DescribeGlobalClusters on Paws::DocDB

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.

    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>

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.

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

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".

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.

This class forms part of Paws, documenting arguments for method DescribeGlobalClusters in Paws::DocDB

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.