software.amazon.awssdk.services.redshiftserverless.model

Class RestoreFromSnapshotRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshiftserverless.model.RedshiftServerlessRequest

software.amazon.awssdk.services.redshiftserverless.model.RestoreFromSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RestoreFromSnapshotRequest.Builder,RestoreFromSnapshotRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreFromSnapshotRequest
extends RedshiftServerlessRequest
implements ToCopyableBuilder<RestoreFromSnapshotRequest.Builder,RestoreFromSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RestoreFromSnapshotRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	adminPasswordSecretKmsKeyId() The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
static RestoreFromSnapshotRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	manageAdminPassword() If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials.
String	namespaceName() The name of the namespace to restore the snapshot to.
String	ownerAccount() The Amazon Web Services account that owns the snapshot.
List<SdkField<?>>	sdkFields()
static Class<? extends RestoreFromSnapshotRequest.Builder>	serializableBuilderClass()
String	snapshotArn() The Amazon Resource Name (ARN) of the snapshot to restore from.
String	snapshotName() The name of the snapshot to restore from.
RestoreFromSnapshotRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workgroupName() The name of the workgroup used to restore the snapshot.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

adminPasswordSecretKmsKeyId

public final String adminPasswordSecretKmsKeyId()

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

Returns:

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

manageAdminPassword

public final 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.

Returns:

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.

namespaceName

public final String namespaceName()

The name of the namespace to restore the snapshot to.

Returns:

The name of the namespace to restore the snapshot to.

ownerAccount

public final String ownerAccount()

The Amazon Web Services account that owns the snapshot.

Returns:

The Amazon Web Services account that owns the snapshot.

snapshotArn

public final 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>.

Returns:

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

snapshotName

public final String snapshotName()

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

Returns:

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

workgroupName

public final String workgroupName()

The name of the workgroup used to restore the snapshot.

Returns:

The name of the workgroup used to restore the snapshot.

toBuilder

public RestoreFromSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RestoreFromSnapshotRequest.Builder,RestoreFromSnapshotRequest>

Specified by:

toBuilder in class RedshiftServerlessRequest

builder

public static RestoreFromSnapshotRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RestoreFromSnapshotRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo