Package 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 Details

    • 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:

      Parameters:
      status - The snapshot status. The value of the status depends on the API operation used:

      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 admin user name for the cluster.

      Parameters:
      masterUsername - The admin 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.

    • engineFullVersion

      Snapshot.Builder engineFullVersion(String engineFullVersion)

      The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

      Parameters:
      engineFullVersion - The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
      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 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 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

      This is a convenience method that creates an instance of the AccountWithRestoreAccess.Builder avoiding the need to create one manually via AccountWithRestoreAccess.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accountsWithRestoreAccess(List<AccountWithRestoreAccess>).

      Parameters:
      accountsWithRestoreAccess - a consumer that will call methods on AccountWithRestoreAccess.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ownerAccount

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

      Parameters:
      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.
      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 method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • masterPasswordSecretArn

      Snapshot.Builder masterPasswordSecretArn(String masterPasswordSecretArn)

      The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

      Parameters:
      masterPasswordSecretArn - The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterPasswordSecretKmsKeyId

      Snapshot.Builder masterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)

      The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

      Parameters:
      masterPasswordSecretKmsKeyId - The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snapshotArn

      Snapshot.Builder snapshotArn(String snapshotArn)

      The Amazon Resource Name (ARN) of the snapshot.

      Parameters:
      snapshotArn - The Amazon Resource Name (ARN) of the snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.