NAME

Paws::RDS::DescribeDBClusterSnapshots - Arguments for method DescribeDBClusterSnapshots on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method DescribeDBClusterSnapshots on the Amazon Relational Database Service 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.

SYNOPSIS

    my $rds = Paws->service('RDS');
    # To list DB cluster snapshots
    # This example lists settings for the specified, manually-created cluster
    # snapshot.
    my $DBClusterSnapshotMessage = $rds->DescribeDBClusterSnapshots(
      'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot',
      'SnapshotType'                => 'manual'
    );

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>

ATTRIBUTES

DBClusterIdentifier => Str

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the "DBClusterSnapshotIdentifier" parameter. This parameter isn't case-sensitive.

Constraints:

•: If supplied, must match the identifier of an existing DBCluster.

DBClusterSnapshotIdentifier => Str

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the "DBClusterIdentifier" parameter. This value is stored as a lowercase string.

Constraints:

If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the "SnapshotType" parameter must also be specified.

Filters => ArrayRef[Paws::RDS::Filter]

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

"db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
"db-cluster-snapshot-id" - Accepts DB cluster snapshot identifiers.
"snapshot-type" - Accepts types of DB cluster snapshots.
"engine" - Accepts names of database engines.

IncludePublic => Bool

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

IncludeShared => Bool

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the "ModifyDBClusterSnapshotAttribute" API action.

Marker => Str

An optional pagination token provided by a previous "DescribeDBClusterSnapshots" 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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

SnapshotType => Str

The type of DB cluster snapshots to be returned. You can specify one of the following values:

"automated" - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
"manual" - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
"shared" - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
"public" - Return all DB cluster snapshots that have been marked as public.

If you don't specify a "SnapshotType" value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the "IncludeShared" parameter. You can include public DB cluster snapshots with these results by enabling the "IncludePublic" parameter.

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

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>