NAME

Paws::RedShift::Snapshot

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::RedShift::Snapshot object:

$service_obj->Method(Att1 => { AccountsWithRestoreAccess => $value, ..., VpcId => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::RedShift::Snapshot object:

$result = $service_obj->Method(...);
$result->Att1->AccountsWithRestoreAccess

DESCRIPTION

Describes a snapshot.

ATTRIBUTES

AccountsWithRestoreAccess => ArrayRef[Paws::RedShift::AccountWithRestoreAccess]

A list of the AWS customer accounts authorized to restore the snapshot.
Returns C<null> if no accounts are authorized. Visible only to the
snapshot owner.

ActualIncrementalBackupSizeInMegaBytes => Num

The size of the incremental backup.

AvailabilityZone => Str

The Availability Zone in which the cluster was created.

BackupProgressInMegaBytes => Num

The number of megabytes that have been transferred to the snapshot
backup.

ClusterCreateTime => Str

The time (UTC) when the cluster was originally created.

ClusterIdentifier => Str

The identifier of the cluster for which the snapshot was taken.

ClusterVersion => Str

The version ID of the Amazon Redshift engine that is running on the
cluster.

CurrentBackupRateInMegaBytesPerSecond => Num

The number of megabytes per second being transferred to the snapshot
backup. Returns C<0> for a completed backup.

DBName => Str

The name of the database that was created when the cluster was created.

ElapsedTimeInSeconds => Int

The amount of time an in-progress snapshot backup has been running, or
the amount of time it took a completed backup to finish.

Encrypted => Bool

If C<true>, the data in the snapshot is encrypted at rest.

EncryptedWithHSM => Bool

A boolean that indicates whether the snapshot data is encrypted using
the HSM keys of the source cluster. C<true> indicates that the data is
encrypted using HSM keys.

EstimatedSecondsToCompletion => Int

The estimate of the time remaining before the snapshot backup will
complete. Returns C<0> for a completed backup.

KmsKeyId => Str

The AWS Key Management Service (KMS) key ID of the encryption key that
was used to encrypt data in the cluster from which the snapshot was
taken.

MasterUsername => Str

The master user name for the cluster.

NodeType => Str

The node type of the nodes in the cluster.

NumberOfNodes => Int

The number of nodes in the cluster.

OwnerAccount => Str

For manual snapshots, the AWS customer account used to create or copy
the snapshot. For automatic snapshots, the owner of the cluster. The
owner can perform all snapshot actions, such as sharing a manual
snapshot.

Port => Int

The port that the cluster is listening on.

RestorableNodeTypes => ArrayRef[Str]

The list of node types that this cluster snapshot is able to restore
into.

SnapshotCreateTime => Str

The time (UTC) when Amazon Redshift began the snapshot. A snapshot
contains a copy of the cluster data as of this exact time.

SnapshotIdentifier => Str

The snapshot identifier that is provided in the request.

SnapshotType => Str

The snapshot type. Snapshots created using CreateClusterSnapshot and
CopyClusterSnapshot will be of type "manual".

SourceRegion => Str

The source region from which the snapshot was copied.

Status => Str

The snapshot status. The value of the status depends on the API
operation used.
  • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

  • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

  • DeleteClusterSnapshot returns status as "deleted".

Tags => ArrayRef[Paws::RedShift::Tag]

The list of tags for the cluster snapshot.

TotalBackupSizeInMegaBytes => Num

The size of the complete set of backup data that would be used to
restore the cluster.

VpcId => Str

The VPC identifier of the cluster if the snapshot is from a cluster in
a VPC. Otherwise, this field is not in the output.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::RedShift

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