@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Snapshot extends Object implements Serializable, Cloneable
Describes a snapshot.
Constructor and Description |
---|
Snapshot() |
Modifier and Type | Method and Description |
---|---|
Snapshot |
clone() |
boolean |
equals(Object obj) |
List<AccountWithRestoreAccess> |
getAccountsWithRestoreAccess()
A list of the Amazon Web Services accounts authorized to restore the snapshot.
|
Double |
getActualIncrementalBackupSizeInMegaBytes()
The size of the incremental backup.
|
String |
getAvailabilityZone()
The Availability Zone in which the cluster was created.
|
Double |
getBackupProgressInMegaBytes()
The number of megabytes that have been transferred to the snapshot backup.
|
Date |
getClusterCreateTime()
The time (UTC) when the cluster was originally created.
|
String |
getClusterIdentifier()
The identifier of the cluster for which the snapshot was taken.
|
String |
getClusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
|
Double |
getCurrentBackupRateInMegaBytesPerSecond()
The number of megabytes per second being transferred to the snapshot backup.
|
String |
getDBName()
The name of the database that was created when the cluster was created.
|
Long |
getElapsedTimeInSeconds()
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 |
getEncrypted()
If
true , the data in the snapshot is encrypted at rest. |
Boolean |
getEncryptedWithHSM()
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
|
String |
getEngineFullVersion()
The cluster version of the cluster used to create the snapshot.
|
Boolean |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Long |
getEstimatedSecondsToCompletion()
The estimate of the time remaining before the snapshot backup will complete.
|
String |
getKmsKeyId()
The 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 |
getMaintenanceTrackName()
The name of the maintenance track for the snapshot.
|
Integer |
getManualSnapshotRemainingDays()
The number of days until a manual snapshot will pass its retention period.
|
Integer |
getManualSnapshotRetentionPeriod()
The number of days that a manual snapshot is retained.
|
String |
getMasterPasswordSecretArn()
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
|
String |
getMasterPasswordSecretKmsKeyId()
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
String |
getMasterUsername()
The admin user name for the cluster.
|
String |
getNodeType()
The node type of the nodes in the cluster.
|
Integer |
getNumberOfNodes()
The number of nodes in the cluster.
|
String |
getOwnerAccount()
For manual snapshots, the Amazon Web Services account used to create or copy the snapshot.
|
Integer |
getPort()
The port that the cluster is listening on.
|
List<String> |
getRestorableNodeTypes()
The list of node types that this cluster snapshot is able to restore into.
|
String |
getSnapshotArn()
The Amazon Resource Name (ARN) of the snapshot.
|
Date |
getSnapshotCreateTime()
The time (in UTC format) when Amazon Redshift began the snapshot.
|
String |
getSnapshotIdentifier()
The snapshot identifier that is provided in the request.
|
Date |
getSnapshotRetentionStartTime()
A timestamp representing the start of the retention period for the snapshot.
|
String |
getSnapshotType()
The snapshot type.
|
String |
getSourceRegion()
The source region from which the snapshot was copied.
|
String |
getStatus()
The snapshot status.
|
List<Tag> |
getTags()
The list of tags for the cluster snapshot.
|
Double |
getTotalBackupSizeInMegaBytes()
The size of the complete set of backup data that would be used to restore the cluster.
|
String |
getVpcId()
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
|
int |
hashCode() |
Boolean |
isEncrypted()
If
true , the data in the snapshot is encrypted at rest. |
Boolean |
isEncryptedWithHSM()
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
|
Boolean |
isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
void |
setAccountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the Amazon Web Services accounts authorized to restore the snapshot.
|
void |
setActualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.
|
void |
setAvailabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.
|
void |
setBackupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.
|
void |
setClusterCreateTime(Date clusterCreateTime)
The time (UTC) when the cluster was originally created.
|
void |
setClusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which the snapshot was taken.
|
void |
setClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
|
void |
setCurrentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup.
|
void |
setDBName(String dBName)
The name of the database that was created when the cluster was created.
|
void |
setElapsedTimeInSeconds(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.
|
void |
setEncrypted(Boolean encrypted)
If
true , the data in the snapshot is encrypted at rest. |
void |
setEncryptedWithHSM(Boolean encryptedWithHSM)
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
|
void |
setEngineFullVersion(String engineFullVersion)
The cluster version of the cluster used to create the snapshot.
|
void |
setEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
void |
setEstimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete.
|
void |
setKmsKeyId(String kmsKeyId)
The 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.
|
void |
setMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the snapshot.
|
void |
setManualSnapshotRemainingDays(Integer manualSnapshotRemainingDays)
The number of days until a manual snapshot will pass its retention period.
|
void |
setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The number of days that a manual snapshot is retained.
|
void |
setMasterPasswordSecretArn(String masterPasswordSecretArn)
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
|
void |
setMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
void |
setMasterUsername(String masterUsername)
The admin user name for the cluster.
|
void |
setNodeType(String nodeType)
The node type of the nodes in the cluster.
|
void |
setNumberOfNodes(Integer numberOfNodes)
The number of nodes in the cluster.
|
void |
setOwnerAccount(String ownerAccount)
For manual snapshots, the Amazon Web Services account used to create or copy the snapshot.
|
void |
setPort(Integer port)
The port that the cluster is listening on.
|
void |
setRestorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
|
void |
setSnapshotArn(String snapshotArn)
The Amazon Resource Name (ARN) of the snapshot.
|
void |
setSnapshotCreateTime(Date snapshotCreateTime)
The time (in UTC format) when Amazon Redshift began the snapshot.
|
void |
setSnapshotIdentifier(String snapshotIdentifier)
The snapshot identifier that is provided in the request.
|
void |
setSnapshotRetentionStartTime(Date snapshotRetentionStartTime)
A timestamp representing the start of the retention period for the snapshot.
|
void |
setSnapshotType(String snapshotType)
The snapshot type.
|
void |
setSourceRegion(String sourceRegion)
The source region from which the snapshot was copied.
|
void |
setStatus(String status)
The snapshot status.
|
void |
setTags(Collection<Tag> tags)
The list of tags for the cluster snapshot.
|
void |
setTotalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.
|
void |
setVpcId(String vpcId)
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
|
String |
toString()
Returns a string representation of this object.
|
Snapshot |
withAccountsWithRestoreAccess(AccountWithRestoreAccess... accountsWithRestoreAccess)
A list of the Amazon Web Services accounts authorized to restore the snapshot.
|
Snapshot |
withAccountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the Amazon Web Services accounts authorized to restore the snapshot.
|
Snapshot |
withActualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.
|
Snapshot |
withAvailabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.
|
Snapshot |
withBackupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.
|
Snapshot |
withClusterCreateTime(Date clusterCreateTime)
The time (UTC) when the cluster was originally created.
|
Snapshot |
withClusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which the snapshot was taken.
|
Snapshot |
withClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
|
Snapshot |
withCurrentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup.
|
Snapshot |
withDBName(String dBName)
The name of the database that was created when the cluster was created.
|
Snapshot |
withElapsedTimeInSeconds(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.
|
Snapshot |
withEncrypted(Boolean encrypted)
If
true , the data in the snapshot is encrypted at rest. |
Snapshot |
withEncryptedWithHSM(Boolean encryptedWithHSM)
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
|
Snapshot |
withEngineFullVersion(String engineFullVersion)
The cluster version of the cluster used to create the snapshot.
|
Snapshot |
withEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Snapshot |
withEstimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete.
|
Snapshot |
withKmsKeyId(String kmsKeyId)
The 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.
|
Snapshot |
withMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the snapshot.
|
Snapshot |
withManualSnapshotRemainingDays(Integer manualSnapshotRemainingDays)
The number of days until a manual snapshot will pass its retention period.
|
Snapshot |
withManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The number of days that a manual snapshot is retained.
|
Snapshot |
withMasterPasswordSecretArn(String masterPasswordSecretArn)
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
|
Snapshot |
withMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
Snapshot |
withMasterUsername(String masterUsername)
The admin user name for the cluster.
|
Snapshot |
withNodeType(String nodeType)
The node type of the nodes in the cluster.
|
Snapshot |
withNumberOfNodes(Integer numberOfNodes)
The number of nodes in the cluster.
|
Snapshot |
withOwnerAccount(String ownerAccount)
For manual snapshots, the Amazon Web Services account used to create or copy the snapshot.
|
Snapshot |
withPort(Integer port)
The port that the cluster is listening on.
|
Snapshot |
withRestorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
|
Snapshot |
withRestorableNodeTypes(String... restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
|
Snapshot |
withSnapshotArn(String snapshotArn)
The Amazon Resource Name (ARN) of the snapshot.
|
Snapshot |
withSnapshotCreateTime(Date snapshotCreateTime)
The time (in UTC format) when Amazon Redshift began the snapshot.
|
Snapshot |
withSnapshotIdentifier(String snapshotIdentifier)
The snapshot identifier that is provided in the request.
|
Snapshot |
withSnapshotRetentionStartTime(Date snapshotRetentionStartTime)
A timestamp representing the start of the retention period for the snapshot.
|
Snapshot |
withSnapshotType(String snapshotType)
The snapshot type.
|
Snapshot |
withSourceRegion(String sourceRegion)
The source region from which the snapshot was copied.
|
Snapshot |
withStatus(String status)
The snapshot status.
|
Snapshot |
withTags(Collection<Tag> tags)
The list of tags for the cluster snapshot.
|
Snapshot |
withTags(Tag... tags)
The list of tags for the cluster snapshot.
|
Snapshot |
withTotalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.
|
Snapshot |
withVpcId(String vpcId)
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
|
public void setSnapshotIdentifier(String snapshotIdentifier)
The snapshot identifier that is provided in the request.
snapshotIdentifier
- The snapshot identifier that is provided in the request.public String getSnapshotIdentifier()
The snapshot identifier that is provided in the request.
public Snapshot withSnapshotIdentifier(String snapshotIdentifier)
The snapshot identifier that is provided in the request.
snapshotIdentifier
- The snapshot identifier that is provided in the request.public void setClusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which the snapshot was taken.
clusterIdentifier
- The identifier of the cluster for which the snapshot was taken.public String getClusterIdentifier()
The identifier of the cluster for which the snapshot was taken.
public Snapshot withClusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which the snapshot was taken.
clusterIdentifier
- The identifier of the cluster for which the snapshot was taken.public void setSnapshotCreateTime(Date snapshotCreateTime)
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.
snapshotCreateTime
- 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.public Date getSnapshotCreateTime()
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.
public Snapshot withSnapshotCreateTime(Date snapshotCreateTime)
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.
snapshotCreateTime
- 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.public void setStatus(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".
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".
public String getStatus()
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 Snapshot withStatus(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".
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".
public void setPort(Integer port)
The port that the cluster is listening on.
port
- The port that the cluster is listening on.public Integer getPort()
The port that the cluster is listening on.
public Snapshot withPort(Integer port)
The port that the cluster is listening on.
port
- The port that the cluster is listening on.public void setAvailabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.
availabilityZone
- The Availability Zone in which the cluster was created.public String getAvailabilityZone()
The Availability Zone in which the cluster was created.
public Snapshot withAvailabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.
availabilityZone
- The Availability Zone in which the cluster was created.public void setClusterCreateTime(Date clusterCreateTime)
The time (UTC) when the cluster was originally created.
clusterCreateTime
- The time (UTC) when the cluster was originally created.public Date getClusterCreateTime()
The time (UTC) when the cluster was originally created.
public Snapshot withClusterCreateTime(Date clusterCreateTime)
The time (UTC) when the cluster was originally created.
clusterCreateTime
- The time (UTC) when the cluster was originally created.public void setMasterUsername(String masterUsername)
The admin user name for the cluster.
masterUsername
- The admin user name for the cluster.public String getMasterUsername()
The admin user name for the cluster.
public Snapshot withMasterUsername(String masterUsername)
The admin user name for the cluster.
masterUsername
- The admin user name for the cluster.public void setClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
clusterVersion
- The version ID of the Amazon Redshift engine that is running on the cluster.public String getClusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
public Snapshot withClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
clusterVersion
- The version ID of the Amazon Redshift engine that is running on the cluster.public void setEngineFullVersion(String engineFullVersion)
The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
engineFullVersion
- The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.public String getEngineFullVersion()
The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
public Snapshot withEngineFullVersion(String engineFullVersion)
The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
engineFullVersion
- The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.public void setSnapshotType(String snapshotType)
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".
snapshotType
- The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are
of type "manual".public String getSnapshotType()
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".
public Snapshot withSnapshotType(String snapshotType)
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".
snapshotType
- The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are
of type "manual".public void setNodeType(String nodeType)
The node type of the nodes in the cluster.
nodeType
- The node type of the nodes in the cluster.public String getNodeType()
The node type of the nodes in the cluster.
public Snapshot withNodeType(String nodeType)
The node type of the nodes in the cluster.
nodeType
- The node type of the nodes in the cluster.public void setNumberOfNodes(Integer numberOfNodes)
The number of nodes in the cluster.
numberOfNodes
- The number of nodes in the cluster.public Integer getNumberOfNodes()
The number of nodes in the cluster.
public Snapshot withNumberOfNodes(Integer numberOfNodes)
The number of nodes in the cluster.
numberOfNodes
- The number of nodes in the cluster.public void setDBName(String dBName)
The name of the database that was created when the cluster was created.
dBName
- The name of the database that was created when the cluster was created.public String getDBName()
The name of the database that was created when the cluster was created.
public Snapshot withDBName(String dBName)
The name of the database that was created when the cluster was created.
dBName
- The name of the database that was created when the cluster was created.public void setVpcId(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.
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 String getVpcId()
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 Snapshot withVpcId(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.
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 void setEncrypted(Boolean encrypted)
If true
, the data in the snapshot is encrypted at rest.
encrypted
- If true
, the data in the snapshot is encrypted at rest.public Boolean getEncrypted()
If true
, the data in the snapshot is encrypted at rest.
true
, the data in the snapshot is encrypted at rest.public Snapshot withEncrypted(Boolean encrypted)
If true
, the data in the snapshot is encrypted at rest.
encrypted
- If true
, the data in the snapshot is encrypted at rest.public Boolean isEncrypted()
If true
, the data in the snapshot is encrypted at rest.
true
, the data in the snapshot is encrypted at rest.public void setKmsKeyId(String kmsKeyId)
The 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.
kmsKeyId
- The 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 String getKmsKeyId()
The 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 Snapshot withKmsKeyId(String kmsKeyId)
The 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.
kmsKeyId
- The 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 void setEncryptedWithHSM(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.
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.public Boolean getEncryptedWithHSM()
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 Snapshot withEncryptedWithHSM(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.
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.public Boolean isEncryptedWithHSM()
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> getAccountsWithRestoreAccess()
A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null
if no
accounts are authorized. Visible only to the snapshot owner.
null
if no accounts are authorized. Visible only to the snapshot owner.public void setAccountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null
if no
accounts are authorized. Visible only to the snapshot owner.
accountsWithRestoreAccess
- A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null
if no accounts are authorized. Visible only to the snapshot owner.public Snapshot withAccountsWithRestoreAccess(AccountWithRestoreAccess... accountsWithRestoreAccess)
A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null
if no
accounts are authorized. Visible only to the snapshot owner.
NOTE: This method appends the values to the existing list (if any). Use
setAccountsWithRestoreAccess(java.util.Collection)
or
withAccountsWithRestoreAccess(java.util.Collection)
if you want to override the existing values.
accountsWithRestoreAccess
- A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null
if no accounts are authorized. Visible only to the snapshot owner.public Snapshot withAccountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null
if no
accounts are authorized. Visible only to the snapshot owner.
accountsWithRestoreAccess
- A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null
if no accounts are authorized. Visible only to the snapshot owner.public void setOwnerAccount(String ownerAccount)
For manual snapshots, the Amazon Web Services 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.
ownerAccount
- For manual snapshots, the Amazon Web Services 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 String getOwnerAccount()
For manual snapshots, the Amazon Web Services 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 Snapshot withOwnerAccount(String ownerAccount)
For manual snapshots, the Amazon Web Services 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.
ownerAccount
- For manual snapshots, the Amazon Web Services 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 void setTotalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.
totalBackupSizeInMegaBytes
- The size of the complete set of backup data that would be used to restore the cluster.public Double getTotalBackupSizeInMegaBytes()
The size of the complete set of backup data that would be used to restore the cluster.
public Snapshot withTotalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.
totalBackupSizeInMegaBytes
- The size of the complete set of backup data that would be used to restore the cluster.public void setActualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.
actualIncrementalBackupSizeInMegaBytes
- The size of the incremental backup.public Double getActualIncrementalBackupSizeInMegaBytes()
The size of the incremental backup.
public Snapshot withActualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.
actualIncrementalBackupSizeInMegaBytes
- The size of the incremental backup.public void setBackupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.
backupProgressInMegaBytes
- The number of megabytes that have been transferred to the snapshot backup.public Double getBackupProgressInMegaBytes()
The number of megabytes that have been transferred to the snapshot backup.
public Snapshot withBackupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.
backupProgressInMegaBytes
- The number of megabytes that have been transferred to the snapshot backup.public void setCurrentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup. Returns 0
for a
completed backup.
currentBackupRateInMegaBytesPerSecond
- The number of megabytes per second being transferred to the snapshot backup. Returns 0
for a
completed backup.public Double getCurrentBackupRateInMegaBytesPerSecond()
The number of megabytes per second being transferred to the snapshot backup. Returns 0
for a
completed backup.
0
for a
completed backup.public Snapshot withCurrentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup. Returns 0
for a
completed backup.
currentBackupRateInMegaBytesPerSecond
- The number of megabytes per second being transferred to the snapshot backup. Returns 0
for a
completed backup.public void setEstimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete. Returns 0
for a
completed backup.
estimatedSecondsToCompletion
- The estimate of the time remaining before the snapshot backup will complete. Returns 0
for a
completed backup.public Long getEstimatedSecondsToCompletion()
The estimate of the time remaining before the snapshot backup will complete. Returns 0
for a
completed backup.
0
for a
completed backup.public Snapshot withEstimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete. Returns 0
for a
completed backup.
estimatedSecondsToCompletion
- The estimate of the time remaining before the snapshot backup will complete. Returns 0
for a
completed backup.public void setElapsedTimeInSeconds(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.
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 Long getElapsedTimeInSeconds()
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 Snapshot withElapsedTimeInSeconds(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.
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 void setSourceRegion(String sourceRegion)
The source region from which the snapshot was copied.
sourceRegion
- The source region from which the snapshot was copied.public String getSourceRegion()
The source region from which the snapshot was copied.
public Snapshot withSourceRegion(String sourceRegion)
The source region from which the snapshot was copied.
sourceRegion
- The source region from which the snapshot was copied.public List<Tag> getTags()
The list of tags for the cluster snapshot.
public void setTags(Collection<Tag> tags)
The list of tags for the cluster snapshot.
tags
- The list of tags for the cluster snapshot.public Snapshot withTags(Tag... tags)
The list of tags for the cluster snapshot.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The list of tags for the cluster snapshot.public Snapshot withTags(Collection<Tag> tags)
The list of tags for the cluster snapshot.
tags
- The list of tags for the cluster snapshot.public List<String> getRestorableNodeTypes()
The list of node types that this cluster snapshot is able to restore into.
public void setRestorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
restorableNodeTypes
- The list of node types that this cluster snapshot is able to restore into.public Snapshot withRestorableNodeTypes(String... restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
NOTE: This method appends the values to the existing list (if any). Use
setRestorableNodeTypes(java.util.Collection)
or withRestorableNodeTypes(java.util.Collection)
if you want to override the existing values.
restorableNodeTypes
- The list of node types that this cluster snapshot is able to restore into.public Snapshot withRestorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
restorableNodeTypes
- The list of node types that this cluster snapshot is able to restore into.public void setEnhancedVpcRouting(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
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
public Boolean getEnhancedVpcRouting()
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 withEnhancedVpcRouting(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
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
public Boolean isEnhancedVpcRouting()
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 void setMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the snapshot.
maintenanceTrackName
- The name of the maintenance track for the snapshot.public String getMaintenanceTrackName()
The name of the maintenance track for the snapshot.
public Snapshot withMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the snapshot.
maintenanceTrackName
- The name of the maintenance track for the snapshot.public void setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
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.
manualSnapshotRetentionPeriod
- 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.
public Integer getManualSnapshotRetentionPeriod()
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.
The value must be either -1 or an integer between 1 and 3,653.
public Snapshot withManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
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.
manualSnapshotRetentionPeriod
- 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.
public void setManualSnapshotRemainingDays(Integer manualSnapshotRemainingDays)
The number of days until a manual snapshot will pass its retention period.
manualSnapshotRemainingDays
- The number of days until a manual snapshot will pass its retention period.public Integer getManualSnapshotRemainingDays()
The number of days until a manual snapshot will pass its retention period.
public Snapshot withManualSnapshotRemainingDays(Integer manualSnapshotRemainingDays)
The number of days until a manual snapshot will pass its retention period.
manualSnapshotRemainingDays
- The number of days until a manual snapshot will pass its retention period.public void setSnapshotRetentionStartTime(Date snapshotRetentionStartTime)
A timestamp representing the start of the retention period for the snapshot.
snapshotRetentionStartTime
- A timestamp representing the start of the retention period for the snapshot.public Date getSnapshotRetentionStartTime()
A timestamp representing the start of the retention period for the snapshot.
public Snapshot withSnapshotRetentionStartTime(Date snapshotRetentionStartTime)
A timestamp representing the start of the retention period for the snapshot.
snapshotRetentionStartTime
- A timestamp representing the start of the retention period for the snapshot.public void setMasterPasswordSecretArn(String masterPasswordSecretArn)
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
masterPasswordSecretArn
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.public String getMasterPasswordSecretArn()
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
public Snapshot withMasterPasswordSecretArn(String masterPasswordSecretArn)
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
masterPasswordSecretArn
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.public void setMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret.public String getMasterPasswordSecretKmsKeyId()
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
public Snapshot withMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret.public void setSnapshotArn(String snapshotArn)
The Amazon Resource Name (ARN) of the snapshot.
snapshotArn
- The Amazon Resource Name (ARN) of the snapshot.public String getSnapshotArn()
The Amazon Resource Name (ARN) of the snapshot.
public Snapshot withSnapshotArn(String snapshotArn)
The Amazon Resource Name (ARN) of the snapshot.
snapshotArn
- The Amazon Resource Name (ARN) of the snapshot.public String toString()
toString
in class Object
Object.toString()