com.amazonaws.services.rds.model.RestoreDBClusterToPointInTimeRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2012-2017 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.rds.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 RestoreDBClusterToPointInTimeRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the new DB cluster to be created.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*/
private String dBClusterIdentifier;
/**
*
* The identifier of the source DB cluster from which to restore.
*
*
* Constraints:
*
*
* -
*
* Must be the identifier of an existing database instance
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*/
private String sourceDBClusterIdentifier;
/**
*
* The date and time to restore the DB cluster to.
*
*
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the DB instance
*
*
* -
*
* Cannot be specified if UseLatestRestorableTime parameter is true
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*
*/
private java.util.Date restoreToTime;
/**
*
* A value that is set to true to restore the DB cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
*
*/
private Boolean useLatestRestorableTime;
/**
*
* The port number on which the new DB cluster accepts connections.
*
*
* Constraints: Value must be 1150-65535
*
*
* Default: The same port as the original DB cluster.
*
*/
private Integer port;
/**
*
* The DB subnet group name to use for the new DB cluster.
*
*
* Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens.
* Must not be default.
*
*
* Example: mySubnetgroup
*
*/
private String dBSubnetGroupName;
/**
*
* The name of the option group for the new DB cluster.
*
*/
private String optionGroupName;
/**
*
* A lst of VPC security groups that the new DB cluster belongs to.
*
*/
private com.amazonaws.internal.SdkInternalList vpcSecurityGroupIds;
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
*
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB
* cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you
* can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS
* key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by
* the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following will occur:
*
*
* -
*
* If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to
* encrypt the source DB cluster.
*
*
* -
*
* If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is
* rejected.
*
*/
private String kmsKeyId;
/**
*
* The name of the new DB cluster to be created.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @param dBClusterIdentifier
* The name of the new DB cluster to be created.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public void setDBClusterIdentifier(String dBClusterIdentifier) {
this.dBClusterIdentifier = dBClusterIdentifier;
}
/**
*
* The name of the new DB cluster to be created.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @return The name of the new DB cluster to be created.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public String getDBClusterIdentifier() {
return this.dBClusterIdentifier;
}
/**
*
* The name of the new DB cluster to be created.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @param dBClusterIdentifier
* The name of the new DB cluster to be created.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withDBClusterIdentifier(String dBClusterIdentifier) {
setDBClusterIdentifier(dBClusterIdentifier);
return this;
}
/**
*
* The identifier of the source DB cluster from which to restore.
*
*
* Constraints:
*
*
* -
*
* Must be the identifier of an existing database instance
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @param sourceDBClusterIdentifier
* The identifier of the source DB cluster from which to restore.
*
* Constraints:
*
*
* -
*
* Must be the identifier of an existing database instance
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public void setSourceDBClusterIdentifier(String sourceDBClusterIdentifier) {
this.sourceDBClusterIdentifier = sourceDBClusterIdentifier;
}
/**
*
* The identifier of the source DB cluster from which to restore.
*
*
* Constraints:
*
*
* -
*
* Must be the identifier of an existing database instance
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @return The identifier of the source DB cluster from which to restore.
*
* Constraints:
*
*
* -
*
* Must be the identifier of an existing database instance
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public String getSourceDBClusterIdentifier() {
return this.sourceDBClusterIdentifier;
}
/**
*
* The identifier of the source DB cluster from which to restore.
*
*
* Constraints:
*
*
* -
*
* Must be the identifier of an existing database instance
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @param sourceDBClusterIdentifier
* The identifier of the source DB cluster from which to restore.
*
* Constraints:
*
*
* -
*
* Must be the identifier of an existing database instance
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withSourceDBClusterIdentifier(String sourceDBClusterIdentifier) {
setSourceDBClusterIdentifier(sourceDBClusterIdentifier);
return this;
}
/**
*
* The date and time to restore the DB cluster to.
*
*
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the DB instance
*
*
* -
*
* Cannot be specified if UseLatestRestorableTime parameter is true
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*
*
* @param restoreToTime
* The date and time to restore the DB cluster to.
*
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the DB instance
*
*
* -
*
* Cannot be specified if UseLatestRestorableTime parameter is true
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*/
public void setRestoreToTime(java.util.Date restoreToTime) {
this.restoreToTime = restoreToTime;
}
/**
*
* The date and time to restore the DB cluster to.
*
*
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the DB instance
*
*
* -
*
* Cannot be specified if UseLatestRestorableTime parameter is true
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*
*
* @return The date and time to restore the DB cluster to.
*
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the DB instance
*
*
* -
*
* Cannot be specified if UseLatestRestorableTime parameter is true
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*/
public java.util.Date getRestoreToTime() {
return this.restoreToTime;
}
/**
*
* The date and time to restore the DB cluster to.
*
*
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the DB instance
*
*
* -
*
* Cannot be specified if UseLatestRestorableTime parameter is true
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*
*
* @param restoreToTime
* The date and time to restore the DB cluster to.
*
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the DB instance
*
*
* -
*
* Cannot be specified if UseLatestRestorableTime parameter is true
*
*
*
*
* Example: 2015-03-07T23:45:00Z
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withRestoreToTime(java.util.Date restoreToTime) {
setRestoreToTime(restoreToTime);
return this;
}
/**
*
* A value that is set to true to restore the DB cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
*
*
* @param useLatestRestorableTime
* A value that is set to true to restore the DB cluster to the latest restorable backup time,
* and false otherwise.
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
*/
public void setUseLatestRestorableTime(Boolean useLatestRestorableTime) {
this.useLatestRestorableTime = useLatestRestorableTime;
}
/**
*
* A value that is set to true to restore the DB cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
*
*
* @return A value that is set to true to restore the DB cluster to the latest restorable backup time,
* and false otherwise.
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
*/
public Boolean getUseLatestRestorableTime() {
return this.useLatestRestorableTime;
}
/**
*
* A value that is set to true to restore the DB cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
*
*
* @param useLatestRestorableTime
* A value that is set to true to restore the DB cluster to the latest restorable backup time,
* and false otherwise.
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withUseLatestRestorableTime(Boolean useLatestRestorableTime) {
setUseLatestRestorableTime(useLatestRestorableTime);
return this;
}
/**
*
* A value that is set to true to restore the DB cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
*
*
* @return A value that is set to true to restore the DB cluster to the latest restorable backup time,
* and false otherwise.
*
* Default: false
*
*
* Constraints: Cannot be specified if RestoreToTime parameter is provided.
*/
public Boolean isUseLatestRestorableTime() {
return this.useLatestRestorableTime;
}
/**
*
* The port number on which the new DB cluster accepts connections.
*
*
* Constraints: Value must be 1150-65535
*
*
* Default: The same port as the original DB cluster.
*
*
* @param port
* The port number on which the new DB cluster accepts connections.
*
* Constraints: Value must be 1150-65535
*
*
* Default: The same port as the original DB cluster.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port number on which the new DB cluster accepts connections.
*
*
* Constraints: Value must be 1150-65535
*
*
* Default: The same port as the original DB cluster.
*
*
* @return The port number on which the new DB cluster accepts connections.
*
* Constraints: Value must be 1150-65535
*
*
* Default: The same port as the original DB cluster.
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port number on which the new DB cluster accepts connections.
*
*
* Constraints: Value must be 1150-65535
*
*
* Default: The same port as the original DB cluster.
*
*
* @param port
* The port number on which the new DB cluster accepts connections.
*
* Constraints: Value must be 1150-65535
*
*
* Default: The same port as the original DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* The DB subnet group name to use for the new DB cluster.
*
*
* Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens.
* Must not be default.
*
*
* Example: mySubnetgroup
*
*
* @param dBSubnetGroupName
* The DB subnet group name to use for the new DB cluster.
*
* Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or
* hyphens. Must not be default.
*
*
* Example: mySubnetgroup
*/
public void setDBSubnetGroupName(String dBSubnetGroupName) {
this.dBSubnetGroupName = dBSubnetGroupName;
}
/**
*
* The DB subnet group name to use for the new DB cluster.
*
*
* Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens.
* Must not be default.
*
*
* Example: mySubnetgroup
*
*
* @return The DB subnet group name to use for the new DB cluster.
*
* Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or
* hyphens. Must not be default.
*
*
* Example: mySubnetgroup
*/
public String getDBSubnetGroupName() {
return this.dBSubnetGroupName;
}
/**
*
* The DB subnet group name to use for the new DB cluster.
*
*
* Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens.
* Must not be default.
*
*
* Example: mySubnetgroup
*
*
* @param dBSubnetGroupName
* The DB subnet group name to use for the new DB cluster.
*
* Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or
* hyphens. Must not be default.
*
*
* Example: mySubnetgroup
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withDBSubnetGroupName(String dBSubnetGroupName) {
setDBSubnetGroupName(dBSubnetGroupName);
return this;
}
/**
*
* The name of the option group for the new DB cluster.
*
*
* @param optionGroupName
* The name of the option group for the new DB cluster.
*/
public void setOptionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
}
/**
*
* The name of the option group for the new DB cluster.
*
*
* @return The name of the option group for the new DB cluster.
*/
public String getOptionGroupName() {
return this.optionGroupName;
}
/**
*
* The name of the option group for the new DB cluster.
*
*
* @param optionGroupName
* The name of the option group for the new DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withOptionGroupName(String optionGroupName) {
setOptionGroupName(optionGroupName);
return this;
}
/**
*
* A lst of VPC security groups that the new DB cluster belongs to.
*
*
* @return A lst of VPC security groups that the new DB cluster belongs to.
*/
public java.util.List getVpcSecurityGroupIds() {
if (vpcSecurityGroupIds == null) {
vpcSecurityGroupIds = new com.amazonaws.internal.SdkInternalList();
}
return vpcSecurityGroupIds;
}
/**
*
* A lst of VPC security groups that the new DB cluster belongs to.
*
*
* @param vpcSecurityGroupIds
* A lst of VPC security groups that the new DB cluster belongs to.
*/
public void setVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
if (vpcSecurityGroupIds == null) {
this.vpcSecurityGroupIds = null;
return;
}
this.vpcSecurityGroupIds = new com.amazonaws.internal.SdkInternalList(vpcSecurityGroupIds);
}
/**
*
* A lst of VPC security groups that the new DB cluster belongs to.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setVpcSecurityGroupIds(java.util.Collection)} or {@link #withVpcSecurityGroupIds(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param vpcSecurityGroupIds
* A lst of VPC security groups that the new DB cluster belongs to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds) {
if (this.vpcSecurityGroupIds == null) {
setVpcSecurityGroupIds(new com.amazonaws.internal.SdkInternalList(vpcSecurityGroupIds.length));
}
for (String ele : vpcSecurityGroupIds) {
this.vpcSecurityGroupIds.add(ele);
}
return this;
}
/**
*
* A lst of VPC security groups that the new DB cluster belongs to.
*
*
* @param vpcSecurityGroupIds
* A lst of VPC security groups that the new DB cluster belongs to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
setVpcSecurityGroupIds(vpcSecurityGroupIds);
return this;
}
/**
* @return
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
* @param tags
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
*
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB
* cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you
* can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS
* key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by
* the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following will occur:
*
*
* -
*
* If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to
* encrypt the source DB cluster.
*
*
* -
*
* If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is
* rejected.
*
*
* @param kmsKeyId
* The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring
* a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB
* cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than
* the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key
* identified by the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following will occur:
*
*
* -
*
* If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used
* to encrypt the source DB cluster.
*
*
* -
*
* If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore
* request is rejected.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
*
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB
* cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you
* can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS
* key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by
* the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following will occur:
*
*
* -
*
* If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to
* encrypt the source DB cluster.
*
*
* -
*
* If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is
* rejected.
*
*
* @return The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring
* a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB
* cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than
* the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key
* identified by the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following will occur:
*
*
* -
*
* If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used
* to encrypt the source DB cluster.
*
*
* -
*
* If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore
* request is rejected.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
*
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB
* cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you
* can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS
* key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by
* the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following will occur:
*
*
* -
*
* If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to
* encrypt the source DB cluster.
*
*
* -
*
* If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is
* rejected.
*
*
* @param kmsKeyId
* The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring
* a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB
* cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than
* the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key
* identified by the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following will occur:
*
*
* -
*
* If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used
* to encrypt the source DB cluster.
*
*
* -
*
* If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore
* request is rejected.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDBClusterIdentifier() != null)
sb.append("DBClusterIdentifier: ").append(getDBClusterIdentifier()).append(",");
if (getSourceDBClusterIdentifier() != null)
sb.append("SourceDBClusterIdentifier: ").append(getSourceDBClusterIdentifier()).append(",");
if (getRestoreToTime() != null)
sb.append("RestoreToTime: ").append(getRestoreToTime()).append(",");
if (getUseLatestRestorableTime() != null)
sb.append("UseLatestRestorableTime: ").append(getUseLatestRestorableTime()).append(",");
if (getPort() != null)
sb.append("Port: ").append(getPort()).append(",");
if (getDBSubnetGroupName() != null)
sb.append("DBSubnetGroupName: ").append(getDBSubnetGroupName()).append(",");
if (getOptionGroupName() != null)
sb.append("OptionGroupName: ").append(getOptionGroupName()).append(",");
if (getVpcSecurityGroupIds() != null)
sb.append("VpcSecurityGroupIds: ").append(getVpcSecurityGroupIds()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RestoreDBClusterToPointInTimeRequest == false)
return false;
RestoreDBClusterToPointInTimeRequest other = (RestoreDBClusterToPointInTimeRequest) obj;
if (other.getDBClusterIdentifier() == null ^ this.getDBClusterIdentifier() == null)
return false;
if (other.getDBClusterIdentifier() != null && other.getDBClusterIdentifier().equals(this.getDBClusterIdentifier()) == false)
return false;
if (other.getSourceDBClusterIdentifier() == null ^ this.getSourceDBClusterIdentifier() == null)
return false;
if (other.getSourceDBClusterIdentifier() != null && other.getSourceDBClusterIdentifier().equals(this.getSourceDBClusterIdentifier()) == false)
return false;
if (other.getRestoreToTime() == null ^ this.getRestoreToTime() == null)
return false;
if (other.getRestoreToTime() != null && other.getRestoreToTime().equals(this.getRestoreToTime()) == false)
return false;
if (other.getUseLatestRestorableTime() == null ^ this.getUseLatestRestorableTime() == null)
return false;
if (other.getUseLatestRestorableTime() != null && other.getUseLatestRestorableTime().equals(this.getUseLatestRestorableTime()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null && other.getPort().equals(this.getPort()) == false)
return false;
if (other.getDBSubnetGroupName() == null ^ this.getDBSubnetGroupName() == null)
return false;
if (other.getDBSubnetGroupName() != null && other.getDBSubnetGroupName().equals(this.getDBSubnetGroupName()) == false)
return false;
if (other.getOptionGroupName() == null ^ this.getOptionGroupName() == null)
return false;
if (other.getOptionGroupName() != null && other.getOptionGroupName().equals(this.getOptionGroupName()) == false)
return false;
if (other.getVpcSecurityGroupIds() == null ^ this.getVpcSecurityGroupIds() == null)
return false;
if (other.getVpcSecurityGroupIds() != null && other.getVpcSecurityGroupIds().equals(this.getVpcSecurityGroupIds()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBClusterIdentifier() == null) ? 0 : getDBClusterIdentifier().hashCode());
hashCode = prime * hashCode + ((getSourceDBClusterIdentifier() == null) ? 0 : getSourceDBClusterIdentifier().hashCode());
hashCode = prime * hashCode + ((getRestoreToTime() == null) ? 0 : getRestoreToTime().hashCode());
hashCode = prime * hashCode + ((getUseLatestRestorableTime() == null) ? 0 : getUseLatestRestorableTime().hashCode());
hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime * hashCode + ((getDBSubnetGroupName() == null) ? 0 : getDBSubnetGroupName().hashCode());
hashCode = prime * hashCode + ((getOptionGroupName() == null) ? 0 : getOptionGroupName().hashCode());
hashCode = prime * hashCode + ((getVpcSecurityGroupIds() == null) ? 0 : getVpcSecurityGroupIds().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
return hashCode;
}
@Override
public RestoreDBClusterToPointInTimeRequest clone() {
return (RestoreDBClusterToPointInTimeRequest) super.clone();
}
}