com.amazonaws.services.redshiftserverless.model.RestoreFromSnapshotRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-redshiftserverless Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.redshiftserverless.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RestoreFromSnapshotRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials
* secret.
*
*/
private String adminPasswordSecretKmsKeyId;
/**
*
* 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.
*
*/
private Boolean manageAdminPassword;
/**
*
* The name of the namespace to restore the snapshot to.
*
*/
private String namespaceName;
/**
*
* The Amazon Web Services account that owns the snapshot.
*
*/
private String ownerAccount;
/**
*
* 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>.
*
*/
private String snapshotArn;
/**
*
* The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
*
*/
private String snapshotName;
/**
*
* The name of the workgroup used to restore the snapshot.
*
*/
private String workgroupName;
/**
*
* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials
* secret.
*
*
* @param adminPasswordSecretKmsKeyId
* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials
* secret.
*/
public void setAdminPasswordSecretKmsKeyId(String adminPasswordSecretKmsKeyId) {
this.adminPasswordSecretKmsKeyId = adminPasswordSecretKmsKeyId;
}
/**
*
* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials
* secret.
*
*
* @return The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin
* credentials secret.
*/
public String getAdminPasswordSecretKmsKeyId() {
return this.adminPasswordSecretKmsKeyId;
}
/**
*
* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials
* secret.
*
*
* @param adminPasswordSecretKmsKeyId
* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials
* secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreFromSnapshotRequest withAdminPasswordSecretKmsKeyId(String adminPasswordSecretKmsKeyId) {
setAdminPasswordSecretKmsKeyId(adminPasswordSecretKmsKeyId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setManageAdminPassword(Boolean manageAdminPassword) {
this.manageAdminPassword = 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.
*
*
* @return 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.
*/
public Boolean getManageAdminPassword() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreFromSnapshotRequest withManageAdminPassword(Boolean manageAdminPassword) {
setManageAdminPassword(manageAdminPassword);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isManageAdminPassword() {
return this.manageAdminPassword;
}
/**
*
* The name of the namespace to restore the snapshot to.
*
*
* @param namespaceName
* The name of the namespace to restore the snapshot to.
*/
public void setNamespaceName(String namespaceName) {
this.namespaceName = namespaceName;
}
/**
*
* The name of the namespace to restore the snapshot to.
*
*
* @return The name of the namespace to restore the snapshot to.
*/
public String getNamespaceName() {
return this.namespaceName;
}
/**
*
* The name of the namespace to restore the snapshot to.
*
*
* @param namespaceName
* The name of the namespace to restore the snapshot to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreFromSnapshotRequest withNamespaceName(String namespaceName) {
setNamespaceName(namespaceName);
return this;
}
/**
*
* The Amazon Web Services account that owns the snapshot.
*
*
* @param ownerAccount
* The Amazon Web Services account that owns the snapshot.
*/
public void setOwnerAccount(String ownerAccount) {
this.ownerAccount = ownerAccount;
}
/**
*
* The Amazon Web Services account that owns the snapshot.
*
*
* @return The Amazon Web Services account that owns the snapshot.
*/
public String getOwnerAccount() {
return this.ownerAccount;
}
/**
*
* The Amazon Web Services account that owns the snapshot.
*
*
* @param ownerAccount
* The Amazon Web Services account that owns the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreFromSnapshotRequest withOwnerAccount(String ownerAccount) {
setOwnerAccount(ownerAccount);
return this;
}
/**
*
* 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>.
*
*
* @param 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>.
*/
public void setSnapshotArn(String snapshotArn) {
this.snapshotArn = 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>.
*
*
* @return 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>.
*/
public String getSnapshotArn() {
return this.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>.
*
*
* @param 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>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreFromSnapshotRequest withSnapshotArn(String snapshotArn) {
setSnapshotArn(snapshotArn);
return this;
}
/**
*
* The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
*
*
* @param snapshotName
* The name of the snapshot to restore from. Must not be specified at the same time as
* snapshotArn.
*/
public void setSnapshotName(String snapshotName) {
this.snapshotName = snapshotName;
}
/**
*
* The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
*
*
* @return The name of the snapshot to restore from. Must not be specified at the same time as
* snapshotArn.
*/
public String getSnapshotName() {
return this.snapshotName;
}
/**
*
* The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
*
*
* @param snapshotName
* The name of the snapshot to restore from. Must not be specified at the same time as
* snapshotArn.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreFromSnapshotRequest withSnapshotName(String snapshotName) {
setSnapshotName(snapshotName);
return this;
}
/**
*
* The name of the workgroup used to restore the snapshot.
*
*
* @param workgroupName
* The name of the workgroup used to restore the snapshot.
*/
public void setWorkgroupName(String workgroupName) {
this.workgroupName = workgroupName;
}
/**
*
* The name of the workgroup used to restore the snapshot.
*
*
* @return The name of the workgroup used to restore the snapshot.
*/
public String getWorkgroupName() {
return this.workgroupName;
}
/**
*
* The name of the workgroup used to restore the snapshot.
*
*
* @param workgroupName
* The name of the workgroup used to restore the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreFromSnapshotRequest withWorkgroupName(String workgroupName) {
setWorkgroupName(workgroupName);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAdminPasswordSecretKmsKeyId() != null)
sb.append("AdminPasswordSecretKmsKeyId: ").append(getAdminPasswordSecretKmsKeyId()).append(",");
if (getManageAdminPassword() != null)
sb.append("ManageAdminPassword: ").append(getManageAdminPassword()).append(",");
if (getNamespaceName() != null)
sb.append("NamespaceName: ").append(getNamespaceName()).append(",");
if (getOwnerAccount() != null)
sb.append("OwnerAccount: ").append(getOwnerAccount()).append(",");
if (getSnapshotArn() != null)
sb.append("SnapshotArn: ").append(getSnapshotArn()).append(",");
if (getSnapshotName() != null)
sb.append("SnapshotName: ").append(getSnapshotName()).append(",");
if (getWorkgroupName() != null)
sb.append("WorkgroupName: ").append(getWorkgroupName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RestoreFromSnapshotRequest == false)
return false;
RestoreFromSnapshotRequest other = (RestoreFromSnapshotRequest) obj;
if (other.getAdminPasswordSecretKmsKeyId() == null ^ this.getAdminPasswordSecretKmsKeyId() == null)
return false;
if (other.getAdminPasswordSecretKmsKeyId() != null && other.getAdminPasswordSecretKmsKeyId().equals(this.getAdminPasswordSecretKmsKeyId()) == false)
return false;
if (other.getManageAdminPassword() == null ^ this.getManageAdminPassword() == null)
return false;
if (other.getManageAdminPassword() != null && other.getManageAdminPassword().equals(this.getManageAdminPassword()) == false)
return false;
if (other.getNamespaceName() == null ^ this.getNamespaceName() == null)
return false;
if (other.getNamespaceName() != null && other.getNamespaceName().equals(this.getNamespaceName()) == false)
return false;
if (other.getOwnerAccount() == null ^ this.getOwnerAccount() == null)
return false;
if (other.getOwnerAccount() != null && other.getOwnerAccount().equals(this.getOwnerAccount()) == false)
return false;
if (other.getSnapshotArn() == null ^ this.getSnapshotArn() == null)
return false;
if (other.getSnapshotArn() != null && other.getSnapshotArn().equals(this.getSnapshotArn()) == false)
return false;
if (other.getSnapshotName() == null ^ this.getSnapshotName() == null)
return false;
if (other.getSnapshotName() != null && other.getSnapshotName().equals(this.getSnapshotName()) == false)
return false;
if (other.getWorkgroupName() == null ^ this.getWorkgroupName() == null)
return false;
if (other.getWorkgroupName() != null && other.getWorkgroupName().equals(this.getWorkgroupName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAdminPasswordSecretKmsKeyId() == null) ? 0 : getAdminPasswordSecretKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getManageAdminPassword() == null) ? 0 : getManageAdminPassword().hashCode());
hashCode = prime * hashCode + ((getNamespaceName() == null) ? 0 : getNamespaceName().hashCode());
hashCode = prime * hashCode + ((getOwnerAccount() == null) ? 0 : getOwnerAccount().hashCode());
hashCode = prime * hashCode + ((getSnapshotArn() == null) ? 0 : getSnapshotArn().hashCode());
hashCode = prime * hashCode + ((getSnapshotName() == null) ? 0 : getSnapshotName().hashCode());
hashCode = prime * hashCode + ((getWorkgroupName() == null) ? 0 : getWorkgroupName().hashCode());
return hashCode;
}
@Override
public RestoreFromSnapshotRequest clone() {
return (RestoreFromSnapshotRequest) super.clone();
}
}