/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ElastiCache::DescribeSnapshots

NAME

Paws::ElastiCache::DescribeSnapshots - Arguments for method DescribeSnapshots on Paws::ElastiCache

DESCRIPTION

This class represents the parameters used for calling the method DescribeSnapshots on the Amazon ElastiCache service. Use the attributes of this class as arguments to method DescribeSnapshots.

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

SYNOPSIS

my $elasticache = Paws->service('ElastiCache');
# DescribeSnapshots
# Returns information about the snapshot mysnapshot. By default.
my $DescribeSnapshotsListMessage =
  $elasticache->DescribeSnapshots( 'SnapshotName' => 'snapshot-20161212' );

# Results:
my $Marker    = $DescribeSnapshotsListMessage->Marker;
my $Snapshots = $DescribeSnapshotsListMessage->Snapshots;

# Returns a L<Paws::ElastiCache::DescribeSnapshotsListMessage> 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/elasticache/DescribeSnapshots

ATTRIBUTES

CacheClusterId => Str

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

Marker => Str

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

ReplicationGroupId => Str

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

ShowNodeGroupConfig => Bool

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

SnapshotName => Str

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

SnapshotSource => Str

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeSnapshots in Paws::ElastiCache

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