Interface RestoreFromSnapshotRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<RestoreFromSnapshotRequest.Builder,
,RestoreFromSnapshotRequest> RedshiftServerlessRequest.Builder
,SdkBuilder<RestoreFromSnapshotRequest.Builder,
,RestoreFromSnapshotRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
RestoreFromSnapshotRequest
-
Method Summary
Modifier and TypeMethodDescriptionadminPasswordSecretKmsKeyId
(String adminPasswordSecretKmsKeyId) The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.manageAdminPassword
(Boolean manageAdminPassword) Iftrue
, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials.namespaceName
(String namespaceName) The name of the namespace to restore the snapshot to.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.ownerAccount
(String ownerAccount) The Amazon Web Services account that owns the snapshot.snapshotArn
(String snapshotArn) The Amazon Resource Name (ARN) of the snapshot to restore from.snapshotName
(String snapshotName) The name of the snapshot to restore from.workgroupName
(String workgroupName) The name of the workgroup used to restore the snapshot.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.redshiftserverless.model.RedshiftServerlessRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
If
true
, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. IfMmanageAdminPassword
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
- Iftrue
, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. IfMmanageAdminPassword
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
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
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
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_identifierinvalid input: '>' ;/<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 assnapshotName
.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
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 assnapshotArn
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
overrideConfiguration
RestoreFromSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
RestoreFromSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-