Package software.amazon.awssdk.services.redshiftserverless.model

Interface RestoreFromSnapshotRequest.Builder

    • Method Detail

      • adminPasswordSecretKmsKeyId

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

      • manageAdminPassword

        RestoreFromSnapshotRequest.Builder manageAdminPassword​(Boolean manageAdminPassword)

        If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.

        Parameters:
        manageAdminPassword - If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • namespaceName

        RestoreFromSnapshotRequest.Builder namespaceName​(String namespaceName)

        The name of the namespace to restore the snapshot to.

        Parameters:
        namespaceName - The name of the namespace to restore the snapshot to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ownerAccount

        RestoreFromSnapshotRequest.Builder ownerAccount​(String ownerAccount)

        The Amazon Web Services account that owns the snapshot.

        Parameters:
        ownerAccount - The Amazon Web Services account that owns the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotArn

        RestoreFromSnapshotRequest.Builder snapshotArn​(String snapshotArn)

        The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.

        The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier> ;/<snapshot_identifier>.

        Parameters:
        snapshotArn - The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.

        The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier >/<snapshot_identifier>.

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

      • snapshotName

        RestoreFromSnapshotRequest.Builder snapshotName​(String snapshotName)

        The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

        Parameters:
        snapshotName - The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • workgroupName

        RestoreFromSnapshotRequest.Builder workgroupName​(String workgroupName)

        The name of the workgroup used to restore the snapshot.

        Parameters:
        workgroupName - The name of the workgroup used to restore the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.