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->AccountsWithRestoreAccessDESCRIPTION
Describes a snapshot.
ATTRIBUTES
AccountsWithRestoreAccess => ArrayRef[Paws::RedShift::AccountWithRestoreAccess]
A list of the AWS customer accounts authorized to restore the snapshot. Returns 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 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 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. true indicates that the data is encrypted using HSM keys.
EngineFullVersion => Str
The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
EnhancedVpcRouting => Bool
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
EstimatedSecondsToCompletion => Int
The estimate of the time remaining before the snapshot backup will complete. Returns 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.
MaintenanceTrackName => Str
The name of the maintenance track for the snapshot.
ManualSnapshotRemainingDays => Int
The number of days until a manual snapshot will pass its retention period.
ManualSnapshotRetentionPeriod => Int
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
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|Undef]
The list of node types that this cluster snapshot is able to restore into.
SnapshotCreateTime => Str
The time (in UTC format) 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.
SnapshotRetentionStartTime => Str
A timestamp representing the start of the retention period for the snapshot.
SnapshotType => Str
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are 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