package Paws::DocDB::DescribeDBClusterSnapshots; use Moose; has DBClusterIdentifier => (is => 'ro', isa => 'Str'); has DBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str'); has Filters => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Filter]'); has IncludePublic => (is => 'ro', isa => 'Bool'); has IncludeShared => (is => 'ro', isa => 'Bool'); has Marker => (is => 'ro', isa => 'Str'); has MaxRecords => (is => 'ro', isa => 'Int'); has SnapshotType => (is => 'ro', isa => 'Str'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBClusterSnapshots'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::DBClusterSnapshotMessage'); class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBClusterSnapshotsResult'); 1; ### main pod documentation begin ### =head1 NAME Paws::DocDB::DescribeDBClusterSnapshots - Arguments for method DescribeDBClusterSnapshots on L =head1 DESCRIPTION This class represents the parameters used for calling the method DescribeDBClusterSnapshots on the L 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. =head1 SYNOPSIS 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 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 L =head1 ATTRIBUTES =head2 DBClusterIdentifier => Str The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the C parameter. This parameter is not case sensitive. Constraints: =over =item * If provided, must match the identifier of an existing C. =back =head2 DBClusterSnapshotIdentifier => Str A specific cluster snapshot identifier to describe. This parameter can't be used with the C parameter. This value is stored as a lowercase string. Constraints: =over =item * If provided, must match the identifier of an existing C. =item * If this identifier is for an automated snapshot, the C parameter must also be specified. =back =head2 Filters => ArrayRef[L] This parameter is not currently supported. =head2 IncludePublic => Bool Set to C to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise C. The default is C. =head2 IncludeShared => Bool Set to C to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise C. The default is C. =head2 Marker => Str 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 C. =head2 MaxRecords => Int The maximum number of records to include in the response. If more records exist than the specified C 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. =head2 SnapshotType => Str The type of cluster snapshots to be returned. You can specify one of the following values: =over =item * C - Return all cluster snapshots that Amazon DocumentDB has automatically created for your account. =item * C - Return all cluster snapshots that you have manually created for your account. =item * C - Return all manual cluster snapshots that have been shared to your account. =item * C - Return all cluster snapshots that have been marked as public. =back If you don't specify a C value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the C parameter to C. You can include public cluster snapshots with these results by setting theC parameter to C. The C and C parameters don't apply for C values of C or C. The C parameter doesn't apply when C is set to C. The C parameter doesn't apply when C is set to C. =head1 SEE ALSO This class forms part of L, documenting arguments for method DescribeDBClusterSnapshots in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut