software.amazon.awssdk.services.redshift.model

Interface Snapshot.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Snapshot.Builder,Snapshot>, SdkBuilder<Snapshot.Builder,Snapshot>, SdkPojo

Enclosing class:

Snapshot

public static interface Snapshot.Builder
extends SdkPojo, CopyableBuilder<Snapshot.Builder,Snapshot>

Method Summary

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	accountsWithRestoreAccess(Consumer<AccountWithRestoreAccess.Builder>... 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	maintenanceTrackName(String maintenanceTrackName) The name of the maintenance track for the snapshot.
Snapshot.Builder	manualSnapshotRemainingDays(Integer manualSnapshotRemainingDays) The number of days until a manual snapshot will pass its retention period.
Snapshot.Builder	manualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod) The number of days that a manual snapshot is retained.
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 (in UTC format) when Amazon Redshift began the snapshot.
Snapshot.Builder	snapshotIdentifier(String snapshotIdentifier) The snapshot identifier that is provided in the request.
Snapshot.Builder	snapshotRetentionStartTime(Instant snapshotRetentionStartTime) A timestamp representing the start of the retention period for the snapshot.
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(Consumer<Tag.Builder>... 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.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

snapshotIdentifier

Snapshot.Builder snapshotIdentifier(String snapshotIdentifier)

The snapshot identifier that is provided in the request.

Parameters:

snapshotIdentifier - The snapshot identifier that is provided in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterIdentifier

Snapshot.Builder clusterIdentifier(String clusterIdentifier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotCreateTime

Snapshot.Builder snapshotCreateTime(Instant 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

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".

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

port

Snapshot.Builder port(Integer port)

The port that the cluster is listening on.

Parameters:

port - The port that the cluster is listening on.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZone

Snapshot.Builder availabilityZone(String availabilityZone)

The Availability Zone in which the cluster was created.

Parameters:

availabilityZone - The Availability Zone in which the cluster was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterCreateTime

Snapshot.Builder clusterCreateTime(Instant clusterCreateTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

masterUsername

Snapshot.Builder masterUsername(String masterUsername)

The master user name for the cluster.

Parameters:

masterUsername - The master user name for the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterVersion

Snapshot.Builder clusterVersion(String clusterVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotType

Snapshot.Builder snapshotType(String snapshotType)

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

Parameters:

snapshotType - The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

Returns:

Returns a reference to this object so that method calls can be chained together.

nodeType

Snapshot.Builder nodeType(String nodeType)

The node type of the nodes in the cluster.

Parameters:

nodeType - The node type of the nodes in the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

numberOfNodes

Snapshot.Builder numberOfNodes(Integer numberOfNodes)

The number of nodes in the cluster.

Parameters:

numberOfNodes - The number of nodes in the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

dbName

Snapshot.Builder dbName(String dbName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcId

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

encrypted

Snapshot.Builder encrypted(Boolean encrypted)

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

Parameters:

encrypted - If true, the data in the snapshot is encrypted at rest.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptedWithHSM

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

accountsWithRestoreAccess

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

accountsWithRestoreAccess

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

accountsWithRestoreAccess

Snapshot.Builder accountsWithRestoreAccess(Consumer<AccountWithRestoreAccess.Builder>... 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #accountsWithRestoreAccess(List).

Parameters:

accountsWithRestoreAccess - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#accountsWithRestoreAccess(List)

ownerAccount

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

totalBackupSizeInMegaBytes

Snapshot.Builder totalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

actualIncrementalBackupSizeInMegaBytes

Snapshot.Builder actualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)

The size of the incremental backup.

Parameters:

actualIncrementalBackupSizeInMegaBytes - The size of the incremental backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

backupProgressInMegaBytes

Snapshot.Builder backupProgressInMegaBytes(Double backupProgressInMegaBytes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

currentBackupRateInMegaBytesPerSecond

Snapshot.Builder currentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)

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

Parameters:

currentBackupRateInMegaBytesPerSecond - The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

estimatedSecondsToCompletion

Snapshot.Builder estimatedSecondsToCompletion(Long estimatedSecondsToCompletion)

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

Parameters:

estimatedSecondsToCompletion - The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

elapsedTimeInSeconds

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceRegion

Snapshot.Builder sourceRegion(String sourceRegion)

The source region from which the snapshot was copied.

Parameters:

sourceRegion - The source region from which the snapshot was copied.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Snapshot.Builder tags(Collection<Tag> tags)

The list of tags for the cluster snapshot.

Parameters:

tags - The list of tags for the cluster snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Snapshot.Builder tags(Tag... tags)

The list of tags for the cluster snapshot.

Parameters:

tags - The list of tags for the cluster snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Snapshot.Builder tags(Consumer<Tag.Builder>... tags)

The list of tags for the cluster snapshot.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

restorableNodeTypes

Snapshot.Builder restorableNodeTypes(Collection<String> restorableNodeTypes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

restorableNodeTypes

Snapshot.Builder restorableNodeTypes(String... restorableNodeTypes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

enhancedVpcRouting

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maintenanceTrackName

Snapshot.Builder maintenanceTrackName(String maintenanceTrackName)

The name of the maintenance track for the snapshot.

Parameters:

maintenanceTrackName - The name of the maintenance track for the snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

manualSnapshotRetentionPeriod

Snapshot.Builder manualSnapshotRetentionPeriod(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

manualSnapshotRemainingDays

Snapshot.Builder manualSnapshotRemainingDays(Integer manualSnapshotRemainingDays)

The number of days until a manual snapshot will pass its retention period.

Parameters:

manualSnapshotRemainingDays - The number of days until a manual snapshot will pass its retention period.

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotRetentionStartTime

Snapshot.Builder snapshotRetentionStartTime(Instant snapshotRetentionStartTime)

A timestamp representing the start of the retention period for the snapshot.

Parameters:

snapshotRetentionStartTime - A timestamp representing the start of the retention period for the snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.