/ 
Paws-0.20
⭐ Starred 171 / Paws::RDS::DescribeDBSnapshots

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method DescribeDBSnapshots on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method DescribeDBSnapshots.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBSnapshots.

As an example:

$service_obj->DescribeDBSnapshots(Att1 => $value1, Att2 => $value2, ...);

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.

ATTRIBUTES

DBInstanceIdentifier => Str

A DB instance identifier to retrieve the list of DB snapshots for. This
parameter cannot be used in conjunction with C<DBSnapshotIdentifier>.
This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

DBSnapshotIdentifier => Str

A specific DB snapshot identifier to describe. This parameter cannot be
used in conjunction with C<DBInstanceIdentifier>. This value is stored
as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.

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

This parameter is not currently supported.

IncludePublic => Bool

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

An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.

IncludeShared => Bool

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

An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.

Marker => Str

An optional pagination token provided by a previous
C<DescribeDBSnapshots> request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by C<MaxRecords>.

MaxRecords => Int

The maximum number of records to include in the response. If more
records exist than the specified C<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 snapshots that will be returned. You can specify one of the
following values:

  • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

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

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public - Return all DB snapshots that have been marked as public.

If you do not specify a SnapshotType, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters do not apply for SnapshotType values of manual or automated. The IncludePublic paramter does not apply when SnapshotType is set to shared. the IncludeShared parameter does not apply when SnapshotType is set to public.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeDBSnapshots in Paws::RDS

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