/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Neptune::DescribeDBClusterSnapshots

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method DescribeDBClusterSnapshots on the Amazon Neptune 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('Neptune');
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::Neptune::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

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 is not 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::Neptune::Filter]

This parameter is not currently supported.

IncludePublic => Bool

True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is false. The default is false.

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

IncludeShared => Bool

True to include shared manual DB cluster snapshots from other Amazon accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon 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 that the remaining results can be retrieved.

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 Neptune for my Amazon account.

  • manual - Return all DB cluster snapshots that have been taken by my AWS account.

  • shared - Return all manual DB cluster snapshots that have been shared to my Amazon 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 setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeDBClusterSnapshots in Paws::Neptune

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