public static interface Snapshot.Builder extends CopyableBuilder<Snapshot.Builder,Snapshot>
Modifier and Type | Method and Description |
---|---|
Snapshot.Builder |
accountsWithRestoreAccess(AccountWithRestoreAccess... accountsWithRestoreAccess)
A list of the AWS customer accounts authorized to restore the snapshot.
|
Snapshot.Builder |
accountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the AWS customer accounts authorized to restore the snapshot.
|
Snapshot.Builder |
actualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.
|
Snapshot.Builder |
availabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.
|
Snapshot.Builder |
backupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.
|
Snapshot.Builder |
clusterCreateTime(Instant clusterCreateTime)
The time (UTC) when the cluster was originally created.
|
Snapshot.Builder |
clusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which the snapshot was taken.
|
Snapshot.Builder |
clusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
|
Snapshot.Builder |
currentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup.
|
Snapshot.Builder |
dbName(String dbName)
The name of the database that was created when the cluster was created.
|
Snapshot.Builder |
elapsedTimeInSeconds(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.Builder |
encrypted(Boolean encrypted)
If
true , the data in the snapshot is encrypted at rest. |
Snapshot.Builder |
encryptedWithHSM(Boolean encryptedWithHSM)
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
|
Snapshot.Builder |
enhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Snapshot.Builder |
estimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete.
|
Snapshot.Builder |
kmsKeyId(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.
|
Snapshot.Builder |
masterUsername(String masterUsername)
The master user name for the cluster.
|
Snapshot.Builder |
nodeType(String nodeType)
The node type of the nodes in the cluster.
|
Snapshot.Builder |
numberOfNodes(Integer numberOfNodes)
The number of nodes in the cluster.
|
Snapshot.Builder |
ownerAccount(String ownerAccount)
For manual snapshots, the AWS customer account used to create or copy the snapshot.
|
Snapshot.Builder |
port(Integer port)
The port that the cluster is listening on.
|
Snapshot.Builder |
restorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
|
Snapshot.Builder |
restorableNodeTypes(String... restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
|
Snapshot.Builder |
snapshotCreateTime(Instant snapshotCreateTime)
The time (UTC) when Amazon Redshift began the snapshot.
|
Snapshot.Builder |
snapshotIdentifier(String snapshotIdentifier)
The snapshot identifier that is provided in the request.
|
Snapshot.Builder |
snapshotType(String snapshotType)
The snapshot type.
|
Snapshot.Builder |
sourceRegion(String sourceRegion)
The source region from which the snapshot was copied.
|
Snapshot.Builder |
status(String status)
The snapshot status.
|
Snapshot.Builder |
tags(Collection<Tag> tags)
The list of tags for the cluster snapshot.
|
Snapshot.Builder |
tags(Tag... tags)
The list of tags for the cluster snapshot.
|
Snapshot.Builder |
totalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.
|
Snapshot.Builder |
vpcId(String vpcId)
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
|
copy
apply, build
Snapshot.Builder snapshotIdentifier(String snapshotIdentifier)
The snapshot identifier that is provided in the request.
snapshotIdentifier
- The snapshot identifier that is provided in the request.Snapshot.Builder clusterIdentifier(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.Snapshot.Builder snapshotCreateTime(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.
snapshotCreateTime
- The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data
as of this exact time.Snapshot.Builder status(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".
Snapshot.Builder port(Integer port)
The port that the cluster is listening on.
port
- The port that the cluster is listening on.Snapshot.Builder availabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.
availabilityZone
- The Availability Zone in which the cluster was created.Snapshot.Builder clusterCreateTime(Instant clusterCreateTime)
The time (UTC) when the cluster was originally created.
clusterCreateTime
- The time (UTC) when the cluster was originally created.Snapshot.Builder masterUsername(String masterUsername)
The master user name for the cluster.
masterUsername
- The master user name for the cluster.Snapshot.Builder clusterVersion(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.Snapshot.Builder snapshotType(String snapshotType)
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
snapshotType
- The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot
will be of type "manual".Snapshot.Builder nodeType(String nodeType)
The node type of the nodes in the cluster.
nodeType
- The node type of the nodes in the cluster.Snapshot.Builder numberOfNodes(Integer numberOfNodes)
The number of nodes in the cluster.
numberOfNodes
- The number of nodes in the cluster.Snapshot.Builder dbName(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.Snapshot.Builder vpcId(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.Snapshot.Builder encrypted(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.Snapshot.Builder kmsKeyId(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.
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.Snapshot.Builder encryptedWithHSM(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.Snapshot.Builder accountsWithRestoreAccess(Collection<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.
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.Snapshot.Builder accountsWithRestoreAccess(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.
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.Snapshot.Builder ownerAccount(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.
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.Snapshot.Builder totalBackupSizeInMegaBytes(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.Snapshot.Builder actualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.
actualIncrementalBackupSizeInMegaBytes
- The size of the incremental backup.Snapshot.Builder backupProgressInMegaBytes(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.Snapshot.Builder currentBackupRateInMegaBytesPerSecond(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.Snapshot.Builder estimatedSecondsToCompletion(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.Snapshot.Builder elapsedTimeInSeconds(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.Snapshot.Builder sourceRegion(String sourceRegion)
The source region from which the snapshot was copied.
sourceRegion
- The source region from which the snapshot was copied.Snapshot.Builder tags(Collection<Tag> tags)
The list of tags for the cluster snapshot.
tags
- The list of tags for the cluster snapshot.Snapshot.Builder tags(Tag... tags)
The list of tags for the cluster snapshot.
tags
- The list of tags for the cluster snapshot.Snapshot.Builder restorableNodeTypes(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.Snapshot.Builder restorableNodeTypes(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.Snapshot.Builder enhancedVpcRouting(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
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.