@Generated(value="software.amazon.awssdk:codegen") public final class Snapshot extends Object implements ToCopyableBuilder<Snapshot.Builder,Snapshot>
Describes a snapshot.
Modifier and Type | Class and Description |
---|---|
static interface |
Snapshot.Builder |
Modifier and Type | Method and Description |
---|---|
List<AccountWithRestoreAccess> |
accountsWithRestoreAccess()
A list of the AWS customer accounts authorized to restore the snapshot.
|
Double |
actualIncrementalBackupSizeInMegaBytes()
The size of the incremental backup.
|
String |
availabilityZone()
The Availability Zone in which the cluster was created.
|
Double |
backupProgressInMegaBytes()
The number of megabytes that have been transferred to the snapshot backup.
|
static Snapshot.Builder |
builder() |
Instant |
clusterCreateTime()
The time (UTC) when the cluster was originally created.
|
String |
clusterIdentifier()
The identifier of the cluster for which the snapshot was taken.
|
String |
clusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
|
Double |
currentBackupRateInMegaBytesPerSecond()
The number of megabytes per second being transferred to the snapshot backup.
|
String |
dbName()
The name of the database that was created when the cluster was created.
|
Long |
elapsedTimeInSeconds()
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed
backup to finish.
|
Boolean |
encrypted()
If
true , the data in the snapshot is encrypted at rest. |
Boolean |
encryptedWithHSM()
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
|
Boolean |
enhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
boolean |
equals(Object obj) |
Long |
estimatedSecondsToCompletion()
The estimate of the time remaining before the snapshot backup will complete.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
kmsKeyId()
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.
|
String |
masterUsername()
The master user name for the cluster.
|
String |
nodeType()
The node type of the nodes in the cluster.
|
Integer |
numberOfNodes()
The number of nodes in the cluster.
|
String |
ownerAccount()
For manual snapshots, the AWS customer account used to create or copy the snapshot.
|
Integer |
port()
The port that the cluster is listening on.
|
List<String> |
restorableNodeTypes()
The list of node types that this cluster snapshot is able to restore into.
|
static Class<? extends Snapshot.Builder> |
serializableBuilderClass() |
Instant |
snapshotCreateTime()
The time (UTC) when Amazon Redshift began the snapshot.
|
String |
snapshotIdentifier()
The snapshot identifier that is provided in the request.
|
String |
snapshotType()
The snapshot type.
|
String |
sourceRegion()
The source region from which the snapshot was copied.
|
String |
status()
The snapshot status.
|
List<Tag> |
tags()
The list of tags for the cluster snapshot.
|
Snapshot.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Double |
totalBackupSizeInMegaBytes()
The size of the complete set of backup data that would be used to restore the cluster.
|
String |
vpcId()
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
|
copy
public String snapshotIdentifier()
The snapshot identifier that is provided in the request.
public String clusterIdentifier()
The identifier of the cluster for which the snapshot was taken.
public Instant snapshotCreateTime()
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
public String status()
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".
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
public Integer port()
The port that the cluster is listening on.
public String availabilityZone()
The Availability Zone in which the cluster was created.
public Instant clusterCreateTime()
The time (UTC) when the cluster was originally created.
public String masterUsername()
The master user name for the cluster.
public String clusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
public String snapshotType()
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
public String nodeType()
The node type of the nodes in the cluster.
public Integer numberOfNodes()
The number of nodes in the cluster.
public String dbName()
The name of the database that was created when the cluster was created.
public String vpcId()
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
public Boolean encrypted()
If true
, the data in the snapshot is encrypted at rest.
true
, the data in the snapshot is encrypted at rest.public String kmsKeyId()
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.
public Boolean encryptedWithHSM()
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.
true
indicates that the data is encrypted using HSM keys.public List<AccountWithRestoreAccess> accountsWithRestoreAccess()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
null
if no
accounts are authorized. Visible only to the snapshot owner.public String ownerAccount()
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.
public Double totalBackupSizeInMegaBytes()
The size of the complete set of backup data that would be used to restore the cluster.
public Double actualIncrementalBackupSizeInMegaBytes()
The size of the incremental backup.
public Double backupProgressInMegaBytes()
The number of megabytes that have been transferred to the snapshot backup.
public Double currentBackupRateInMegaBytesPerSecond()
The number of megabytes per second being transferred to the snapshot backup. Returns 0
for a
completed backup.
0
for a
completed backup.public Long estimatedSecondsToCompletion()
The estimate of the time remaining before the snapshot backup will complete. Returns 0
for a
completed backup.
0
for a
completed backup.public Long elapsedTimeInSeconds()
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
public String sourceRegion()
The source region from which the snapshot was copied.
public List<Tag> tags()
The list of tags for the cluster snapshot.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> restorableNodeTypes()
The list of node types that this cluster snapshot is able to restore into.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean enhancedVpcRouting()
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 in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Snapshot.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>
public static Snapshot.Builder builder()
public static Class<? extends Snapshot.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.