Interface Snapshot.Builder

    • Method Detail

      • accountsWithProvisionedRestoreAccess

        Snapshot.Builder accountsWithProvisionedRestoreAccess​(Collection<String> accountsWithProvisionedRestoreAccess)

        All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

        Parameters:
        accountsWithProvisionedRestoreAccess - All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • accountsWithProvisionedRestoreAccess

        Snapshot.Builder accountsWithProvisionedRestoreAccess​(String... accountsWithProvisionedRestoreAccess)

        All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

        Parameters:
        accountsWithProvisionedRestoreAccess - All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • accountsWithRestoreAccess

        Snapshot.Builder accountsWithRestoreAccess​(Collection<String> accountsWithRestoreAccess)

        All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

        Parameters:
        accountsWithRestoreAccess - All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • accountsWithRestoreAccess

        Snapshot.Builder accountsWithRestoreAccess​(String... accountsWithRestoreAccess)

        All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

        Parameters:
        accountsWithRestoreAccess - All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
        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 in megabytes.

        Parameters:
        actualIncrementalBackupSizeInMegaBytes - The size of the incremental backup in megabytes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • adminPasswordSecretArn

        Snapshot.Builder adminPasswordSecretArn​(String adminPasswordSecretArn)

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

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

        Snapshot.Builder adminPasswordSecretKmsKeyId​(String adminPasswordSecretKmsKeyId)

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

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

        Snapshot.Builder adminUsername​(String adminUsername)

        The username of the database within a snapshot.

        Parameters:
        adminUsername - The username of the database within a snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • backupProgressInMegaBytes

        Snapshot.Builder backupProgressInMegaBytes​(Double backupProgressInMegaBytes)

        The size in megabytes of the data that has been backed up to a snapshot.

        Parameters:
        backupProgressInMegaBytes - The size in megabytes of the data that has been backed up to a snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • currentBackupRateInMegaBytesPerSecond

        Snapshot.Builder currentBackupRateInMegaBytesPerSecond​(Double currentBackupRateInMegaBytesPerSecond)

        The rate at which data is backed up into a snapshot in megabytes per second.

        Parameters:
        currentBackupRateInMegaBytesPerSecond - The rate at which data is backed up into a snapshot in megabytes per second.
        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 it took to back up data into a snapshot.

        Parameters:
        elapsedTimeInSeconds - The amount of time it took to back up data into a snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • estimatedSecondsToCompletion

        Snapshot.Builder estimatedSecondsToCompletion​(Long estimatedSecondsToCompletion)

        The estimated amount of seconds until the snapshot completes backup.

        Parameters:
        estimatedSecondsToCompletion - The estimated amount of seconds until the snapshot completes backup.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • kmsKeyId

        Snapshot.Builder kmsKeyId​(String kmsKeyId)

        The unique identifier of the KMS key used to encrypt the snapshot.

        Parameters:
        kmsKeyId - The unique identifier of the KMS key used to encrypt the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • namespaceArn

        Snapshot.Builder namespaceArn​(String namespaceArn)

        The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

        Parameters:
        namespaceArn - The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • namespaceName

        Snapshot.Builder namespaceName​(String namespaceName)

        The name of the namepsace.

        Parameters:
        namespaceName - The name of the namepsace.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • ownerAccount

        Snapshot.Builder ownerAccount​(String ownerAccount)

        The owner Amazon Web Services; account of the snapshot.

        Parameters:
        ownerAccount - The owner Amazon Web Services; account of the snapshot.
        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.
      • snapshotCreateTime

        Snapshot.Builder snapshotCreateTime​(Instant snapshotCreateTime)

        The timestamp of when the snapshot was created.

        Parameters:
        snapshotCreateTime - The timestamp of when the snapshot was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • snapshotName

        Snapshot.Builder snapshotName​(String snapshotName)

        The name of the snapshot.

        Parameters:
        snapshotName - The name of the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • snapshotRemainingDays

        Snapshot.Builder snapshotRemainingDays​(Integer snapshotRemainingDays)

        The amount of days until the snapshot is deleted.

        Parameters:
        snapshotRemainingDays - The amount of days until the snapshot is deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • snapshotRetentionPeriod

        Snapshot.Builder snapshotRetentionPeriod​(Integer snapshotRetentionPeriod)

        The period of time, in days, of how long the snapshot is retained.

        Parameters:
        snapshotRetentionPeriod - The period of time, in days, of how long the snapshot is retained.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • snapshotRetentionStartTime

        Snapshot.Builder snapshotRetentionStartTime​(Instant snapshotRetentionStartTime)

        The timestamp of when data within the snapshot started getting retained.

        Parameters:
        snapshotRetentionStartTime - The timestamp of when data within the snapshot started getting retained.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • status

        Snapshot.Builder status​(String status)

        The status of the snapshot.

        Parameters:
        status - The status of the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SnapshotStatus, SnapshotStatus
      • totalBackupSizeInMegaBytes

        Snapshot.Builder totalBackupSizeInMegaBytes​(Double totalBackupSizeInMegaBytes)

        The total size, in megabytes, of how big the snapshot is.

        Parameters:
        totalBackupSizeInMegaBytes - The total size, in megabytes, of how big the snapshot is.
        Returns:
        Returns a reference to this object so that method calls can be chained together.