Paws::DocDB::DescribeDBInstances - Arguments for method DescribeDBInstances on Paws::DocDB
This class represents the parameters used for calling the method DescribeDBInstances on the Amazon DocumentDB with MongoDB compatibility service. Use the attributes of this class as arguments to method DescribeDBInstances.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBInstances.
my $rds = Paws->service('DocDB'); my $DBInstanceMessage = $rds->DescribeDBInstances( DBInstanceIdentifier => 'MyString', # OPTIONAL Filters => [ { Name => 'MyString', Values => [ 'MyString', ... ], }, ... ], # OPTIONAL Marker => 'MyString', # OPTIONAL MaxRecords => 1, # OPTIONAL ); # Results: my $DBInstances = $DBInstanceMessage->DBInstances; my $Marker = $DBInstanceMessage->Marker; # Returns a L<Paws::DocDB::DBInstanceMessage> 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/DescribeDBInstances
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
Constraints:
If provided, must match the identifier of an existing DBInstance.
DBInstance
A filter that specifies one or more instances to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
db-cluster-id
db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
db-instance-id
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
This class forms part of Paws, documenting arguments for method DescribeDBInstances 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
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.