com.amazonaws.services.redshiftserverless.model

Class RestoreFromSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshiftserverless.model.RestoreFromSnapshotRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RestoreFromSnapshotRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RestoreFromSnapshotRequest()

Method Summary

Modifier and Type	Method and Description
RestoreFromSnapshotRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAdminPasswordSecretKmsKeyId() The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
Boolean	getManageAdminPassword() If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials.
String	getNamespaceName() The name of the namespace to restore the snapshot to.
String	getOwnerAccount() The Amazon Web Services account that owns the snapshot.
String	getSnapshotArn() The Amazon Resource Name (ARN) of the snapshot to restore from.
String	getSnapshotName() The name of the snapshot to restore from.
String	getWorkgroupName() The name of the workgroup used to restore the snapshot.
int	hashCode()
Boolean	isManageAdminPassword() If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials.
void	setAdminPasswordSecretKmsKeyId(String adminPasswordSecretKmsKeyId) The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
void	setManageAdminPassword(Boolean manageAdminPassword) If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials.
void	setNamespaceName(String namespaceName) The name of the namespace to restore the snapshot to.
void	setOwnerAccount(String ownerAccount) The Amazon Web Services account that owns the snapshot.
void	setSnapshotArn(String snapshotArn) The Amazon Resource Name (ARN) of the snapshot to restore from.
void	setSnapshotName(String snapshotName) The name of the snapshot to restore from.
void	setWorkgroupName(String workgroupName) The name of the workgroup used to restore the snapshot.
String	toString() Returns a string representation of this object.
RestoreFromSnapshotRequest	withAdminPasswordSecretKmsKeyId(String adminPasswordSecretKmsKeyId) The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
RestoreFromSnapshotRequest	withManageAdminPassword(Boolean manageAdminPassword) If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials.
RestoreFromSnapshotRequest	withNamespaceName(String namespaceName) The name of the namespace to restore the snapshot to.
RestoreFromSnapshotRequest	withOwnerAccount(String ownerAccount) The Amazon Web Services account that owns the snapshot.
RestoreFromSnapshotRequest	withSnapshotArn(String snapshotArn) The Amazon Resource Name (ARN) of the snapshot to restore from.
RestoreFromSnapshotRequest	withSnapshotName(String snapshotName) The name of the snapshot to restore from.
RestoreFromSnapshotRequest	withWorkgroupName(String workgroupName) The name of the workgroup used to restore the snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreFromSnapshotRequest

public RestoreFromSnapshotRequest()

Method Detail

setAdminPasswordSecretKmsKeyId

public void setAdminPasswordSecretKmsKeyId(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.

getAdminPasswordSecretKmsKeyId

public String getAdminPasswordSecretKmsKeyId()

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.

withAdminPasswordSecretKmsKeyId

public RestoreFromSnapshotRequest withAdminPasswordSecretKmsKeyId(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.

setManageAdminPassword

public void setManageAdminPassword(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.

getManageAdminPassword

public Boolean getManageAdminPassword()

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.

withManageAdminPassword

public RestoreFromSnapshotRequest withManageAdminPassword(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.

isManageAdminPassword

public Boolean isManageAdminPassword()

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.

setNamespaceName

public void setNamespaceName(String namespaceName)

The name of the namespace to restore the snapshot to.

Parameters:

namespaceName - The name of the namespace to restore the snapshot to.

getNamespaceName

public String getNamespaceName()

The name of the namespace to restore the snapshot to.

Returns:

The name of the namespace to restore the snapshot to.

withNamespaceName

public RestoreFromSnapshotRequest withNamespaceName(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.

setOwnerAccount

public void setOwnerAccount(String ownerAccount)

The Amazon Web Services account that owns the snapshot.

Parameters:

ownerAccount - The Amazon Web Services account that owns the snapshot.

getOwnerAccount

public String getOwnerAccount()

The Amazon Web Services account that owns the snapshot.

Returns:

The Amazon Web Services account that owns the snapshot.

withOwnerAccount

public RestoreFromSnapshotRequest withOwnerAccount(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.

setSnapshotArn

public void setSnapshotArn(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>.

getSnapshotArn

public String getSnapshotArn()

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

withSnapshotArn

public RestoreFromSnapshotRequest withSnapshotArn(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.

setSnapshotName

public void setSnapshotName(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.

getSnapshotName

public String getSnapshotName()

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.

withSnapshotName

public RestoreFromSnapshotRequest withSnapshotName(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.

setWorkgroupName

public void setWorkgroupName(String workgroupName)

The name of the workgroup used to restore the snapshot.

Parameters:

workgroupName - The name of the workgroup used to restore the snapshot.

getWorkgroupName

public String getWorkgroupName()

The name of the workgroup used to restore the snapshot.

Returns:

The name of the workgroup used to restore the snapshot.

withWorkgroupName

public RestoreFromSnapshotRequest withWorkgroupName(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RestoreFromSnapshotRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()