Paws::DocDB::DescribeDBClusterSnapshots - Arguments for method DescribeDBClusterSnapshots on Paws::DocDB
This class represents the parameters used for calling the method DescribeDBClusterSnapshots on the Amazon DocumentDB with MongoDB compatibility service. Use the attributes of this class as arguments to method DescribeDBClusterSnapshots.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBClusterSnapshots.
my $rds = Paws->service('DocDB'); my $DBClusterSnapshotMessage = $rds->DescribeDBClusterSnapshots( DBClusterIdentifier => 'MyString', # OPTIONAL DBClusterSnapshotIdentifier => 'MyString', # OPTIONAL Filters => [ { Name => 'MyString', Values => [ 'MyString', ... ], }, ... ], # OPTIONAL IncludePublic => 1, # OPTIONAL IncludeShared => 1, # OPTIONAL Marker => 'MyString', # OPTIONAL MaxRecords => 1, # OPTIONAL SnapshotType => 'MyString', # OPTIONAL ); # Results: my $DBClusterSnapshots = $DBClusterSnapshotMessage->DBClusterSnapshots; my $Marker = $DBClusterSnapshotMessage->Marker; # Returns a L<Paws::DocDB::DBClusterSnapshotMessage> 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/DescribeDBClusterSnapshots
The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
DBClusterSnapshotIdentifier
Constraints:
If provided, must match the identifier of an existing DBCluster.
DBCluster
A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
DBClusterIdentifier
If provided, must match the identifier of an existing DBClusterSnapshot.
DBClusterSnapshot
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
SnapshotType
This parameter is not currently supported.
Set to true to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise false. The default is false.
true
false
Set to true to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise false. The default is false.
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.
The type of cluster snapshots to be returned. You can specify one of the following values:
automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your account.
automated
manual - Return all cluster snapshots that you have manually created for your account.
manual
shared - Return all manual cluster snapshots that have been shared to your account.
shared
public - Return all cluster snapshots that have been marked as public.
public
If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.
IncludeShared
IncludePublic
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
This class forms part of Paws, documenting arguments for method DescribeDBClusterSnapshots 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.