com.amazonaws.services.docdb.model.RestoreDBClusterToPointInTimeRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-docdb 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.docdb.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input to RestoreDBClusterToPointInTime.
*
*
* @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 cluster to be created.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*/
private String dBClusterIdentifier;
/**
*
* The type of restore to be performed. You can specify one of the following values:
*
*
* -
*
* full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
*
*
* -
*
* copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
*
*
*
*
* Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is
* earlier than 1.11.
*
*
* If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the
* source DB cluster.
*
*/
private String restoreType;
/**
*
* The identifier of the source cluster from which to restore.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*
*/
private String sourceDBClusterIdentifier;
/**
*
* The date and time to restore the cluster to.
*
*
* Valid values: A time in Universal Coordinated Time (UTC) format.
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the instance.
*
*
* -
*
* Must be specified if the UseLatestRestorableTime parameter is not provided.
*
*
* -
*
* Cannot be specified if the UseLatestRestorableTime parameter is true.
*
*
* -
*
* Cannot be specified if the RestoreType parameter is copy-on-write.
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*
*/
private java.util.Date restoreToTime;
/**
*
* A value that is set to true to restore the cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*
*/
private Boolean useLatestRestorableTime;
/**
*
* The port number on which the new cluster accepts connections.
*
*
* Constraints: Must be a value from 1150 to 65535.
*
*
* Default: The default port for the engine.
*
*/
private Integer port;
/**
*
* The subnet group name to use for the new cluster.
*
*
* Constraints: If provided, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*
*/
private String dBSubnetGroupName;
/**
*
* A list of VPC security groups that the new cluster belongs to.
*
*/
private java.util.List vpcSecurityGroupIds;
/**
*
* The tags to be assigned to the restored cluster.
*
*/
private java.util.List tags;
/**
*
* The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
*
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a
* cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new
* cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key
* used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the
* KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following occurs:
*
*
* -
*
* If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt
* the source cluster.
*
*
* -
*
* If the cluster is not encrypted, then the restored cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is
* rejected.
*
*/
private String kmsKeyId;
/**
*
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*
*/
private java.util.List enableCloudwatchLogsExports;
/**
*
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
* be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
* protects clusters from being accidentally deleted.
*
*/
private Boolean deletionProtection;
/**
*
* The storage type to associate with the DB cluster.
*
*
* For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
* Amazon DocumentDB Developer Guide.
*
*
* Valid values for storage type - standard | iopt1
*
*
* Default value is standard
*
*/
private String storageType;
/**
*
* The name of the new cluster to be created.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* @param dBClusterIdentifier
* The name of the new cluster to be created.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The 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 cluster to be created.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* @return The name of the new cluster to be created.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The 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 cluster to be created.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* @param dBClusterIdentifier
* The name of the new cluster to be created.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The 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 type of restore to be performed. You can specify one of the following values:
*
*
* -
*
* full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
*
*
* -
*
* copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
*
*
*
*
* Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is
* earlier than 1.11.
*
*
* If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the
* source DB cluster.
*
*
* @param restoreType
* The type of restore to be performed. You can specify one of the following values:
*
* -
*
* full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
*
*
* -
*
* copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
*
*
*
*
* Constraints: You can't specify copy-on-write if the engine version of the source DB cluster
* is earlier than 1.11.
*
*
* If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy
* of the source DB cluster.
*/
public void setRestoreType(String restoreType) {
this.restoreType = restoreType;
}
/**
*
* The type of restore to be performed. You can specify one of the following values:
*
*
* -
*
* full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
*
*
* -
*
* copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
*
*
*
*
* Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is
* earlier than 1.11.
*
*
* If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the
* source DB cluster.
*
*
* @return The type of restore to be performed. You can specify one of the following values:
*
* -
*
* full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
*
*
* -
*
* copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
*
*
*
*
* Constraints: You can't specify copy-on-write if the engine version of the source DB cluster
* is earlier than 1.11.
*
*
* If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy
* of the source DB cluster.
*/
public String getRestoreType() {
return this.restoreType;
}
/**
*
* The type of restore to be performed. You can specify one of the following values:
*
*
* -
*
* full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
*
*
* -
*
* copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
*
*
*
*
* Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is
* earlier than 1.11.
*
*
* If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the
* source DB cluster.
*
*
* @param restoreType
* The type of restore to be performed. You can specify one of the following values:
*
* -
*
* full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
*
*
* -
*
* copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
*
*
*
*
* Constraints: You can't specify copy-on-write if the engine version of the source DB cluster
* is earlier than 1.11.
*
*
* If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy
* of the source DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withRestoreType(String restoreType) {
setRestoreType(restoreType);
return this;
}
/**
*
* The identifier of the source cluster from which to restore.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*
*
* @param sourceDBClusterIdentifier
* The identifier of the source cluster from which to restore.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*/
public void setSourceDBClusterIdentifier(String sourceDBClusterIdentifier) {
this.sourceDBClusterIdentifier = sourceDBClusterIdentifier;
}
/**
*
* The identifier of the source cluster from which to restore.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*
*
* @return The identifier of the source cluster from which to restore.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*/
public String getSourceDBClusterIdentifier() {
return this.sourceDBClusterIdentifier;
}
/**
*
* The identifier of the source cluster from which to restore.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*
*
* @param sourceDBClusterIdentifier
* The identifier of the source cluster from which to restore.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
* @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 cluster to.
*
*
* Valid values: A time in Universal Coordinated Time (UTC) format.
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the instance.
*
*
* -
*
* Must be specified if the UseLatestRestorableTime parameter is not provided.
*
*
* -
*
* Cannot be specified if the UseLatestRestorableTime parameter is true.
*
*
* -
*
* Cannot be specified if the RestoreType parameter is copy-on-write.
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*
*
* @param restoreToTime
* The date and time to restore the cluster to.
*
* Valid values: A time in Universal Coordinated Time (UTC) format.
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the instance.
*
*
* -
*
* Must be specified if the UseLatestRestorableTime parameter is not provided.
*
*
* -
*
* Cannot be specified if the UseLatestRestorableTime parameter is true.
*
*
* -
*
* Cannot be specified if the RestoreType parameter is copy-on-write.
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*/
public void setRestoreToTime(java.util.Date restoreToTime) {
this.restoreToTime = restoreToTime;
}
/**
*
* The date and time to restore the cluster to.
*
*
* Valid values: A time in Universal Coordinated Time (UTC) format.
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the instance.
*
*
* -
*
* Must be specified if the UseLatestRestorableTime parameter is not provided.
*
*
* -
*
* Cannot be specified if the UseLatestRestorableTime parameter is true.
*
*
* -
*
* Cannot be specified if the RestoreType parameter is copy-on-write.
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*
*
* @return The date and time to restore the cluster to.
*
* Valid values: A time in Universal Coordinated Time (UTC) format.
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the instance.
*
*
* -
*
* Must be specified if the UseLatestRestorableTime parameter is not provided.
*
*
* -
*
* Cannot be specified if the UseLatestRestorableTime parameter is true.
*
*
* -
*
* Cannot be specified if the RestoreType parameter is copy-on-write.
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*/
public java.util.Date getRestoreToTime() {
return this.restoreToTime;
}
/**
*
* The date and time to restore the cluster to.
*
*
* Valid values: A time in Universal Coordinated Time (UTC) format.
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the instance.
*
*
* -
*
* Must be specified if the UseLatestRestorableTime parameter is not provided.
*
*
* -
*
* Cannot be specified if the UseLatestRestorableTime parameter is true.
*
*
* -
*
* Cannot be specified if the RestoreType parameter is copy-on-write.
*
*
*
*
* Example: 2015-03-07T23:45:00Z
*
*
* @param restoreToTime
* The date and time to restore the cluster to.
*
* Valid values: A time in Universal Coordinated Time (UTC) format.
*
*
* Constraints:
*
*
* -
*
* Must be before the latest restorable time for the instance.
*
*
* -
*
* Must be specified if the UseLatestRestorableTime parameter is not provided.
*
*
* -
*
* Cannot be specified if the UseLatestRestorableTime parameter is true.
*
*
* -
*
* Cannot be specified if the RestoreType parameter is copy-on-write.
*
*
*
*
* 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 cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*
*
* @param useLatestRestorableTime
* A value that is set to true to restore the cluster to the latest restorable backup time, and
* false otherwise.
*
* Default: false
*
*
* Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*/
public void setUseLatestRestorableTime(Boolean useLatestRestorableTime) {
this.useLatestRestorableTime = useLatestRestorableTime;
}
/**
*
* A value that is set to true to restore the cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*
*
* @return A value that is set to true to restore the cluster to the latest restorable backup time, and
* false otherwise.
*
* Default: false
*
*
* Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*/
public Boolean getUseLatestRestorableTime() {
return this.useLatestRestorableTime;
}
/**
*
* A value that is set to true to restore the cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*
*
* @param useLatestRestorableTime
* A value that is set to true to restore the cluster to the latest restorable backup time, and
* false otherwise.
*
* Default: false
*
*
* Constraints: Cannot be specified if the 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 cluster to the latest restorable backup time, and
* false otherwise.
*
*
* Default: false
*
*
* Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*
*
* @return A value that is set to true to restore the cluster to the latest restorable backup time, and
* false otherwise.
*
* Default: false
*
*
* Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*/
public Boolean isUseLatestRestorableTime() {
return this.useLatestRestorableTime;
}
/**
*
* The port number on which the new cluster accepts connections.
*
*
* Constraints: Must be a value from 1150 to 65535.
*
*
* Default: The default port for the engine.
*
*
* @param port
* The port number on which the new cluster accepts connections.
*
* Constraints: Must be a value from 1150 to 65535.
*
*
* Default: The default port for the engine.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port number on which the new cluster accepts connections.
*
*
* Constraints: Must be a value from 1150 to 65535.
*
*
* Default: The default port for the engine.
*
*
* @return The port number on which the new cluster accepts connections.
*
* Constraints: Must be a value from 1150 to 65535.
*
*
* Default: The default port for the engine.
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port number on which the new cluster accepts connections.
*
*
* Constraints: Must be a value from 1150 to 65535.
*
*
* Default: The default port for the engine.
*
*
* @param port
* The port number on which the new cluster accepts connections.
*
* Constraints: Must be a value from 1150 to 65535.
*
*
* Default: The default port for the engine.
* @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 subnet group name to use for the new cluster.
*
*
* Constraints: If provided, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*
*
* @param dBSubnetGroupName
* The subnet group name to use for the new cluster.
*
* Constraints: If provided, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*/
public void setDBSubnetGroupName(String dBSubnetGroupName) {
this.dBSubnetGroupName = dBSubnetGroupName;
}
/**
*
* The subnet group name to use for the new cluster.
*
*
* Constraints: If provided, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*
*
* @return The subnet group name to use for the new cluster.
*
* Constraints: If provided, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*/
public String getDBSubnetGroupName() {
return this.dBSubnetGroupName;
}
/**
*
* The subnet group name to use for the new cluster.
*
*
* Constraints: If provided, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*
*
* @param dBSubnetGroupName
* The subnet group name to use for the new cluster.
*
* Constraints: If provided, must match the name of an existing DBSubnetGroup.
*
*
* 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;
}
/**
*
* A list of VPC security groups that the new cluster belongs to.
*
*
* @return A list of VPC security groups that the new cluster belongs to.
*/
public java.util.List getVpcSecurityGroupIds() {
return vpcSecurityGroupIds;
}
/**
*
* A list of VPC security groups that the new cluster belongs to.
*
*
* @param vpcSecurityGroupIds
* A list of VPC security groups that the new cluster belongs to.
*/
public void setVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
if (vpcSecurityGroupIds == null) {
this.vpcSecurityGroupIds = null;
return;
}
this.vpcSecurityGroupIds = new java.util.ArrayList(vpcSecurityGroupIds);
}
/**
*
* A list of VPC security groups that the new 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 list of VPC security groups that the new 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 java.util.ArrayList(vpcSecurityGroupIds.length));
}
for (String ele : vpcSecurityGroupIds) {
this.vpcSecurityGroupIds.add(ele);
}
return this;
}
/**
*
* A list of VPC security groups that the new cluster belongs to.
*
*
* @param vpcSecurityGroupIds
* A list of VPC security groups that the new 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;
}
/**
*
* The tags to be assigned to the restored cluster.
*
*
* @return The tags to be assigned to the restored cluster.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The tags to be assigned to the restored cluster.
*
*
* @param tags
* The tags to be assigned to the restored cluster.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The tags to be assigned to the restored cluster.
*
*
* 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
* The tags to be assigned to the restored cluster.
* @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 java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The tags to be assigned to the restored cluster.
*
*
* @param tags
* The tags to be assigned to the restored cluster.
* @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 cluster from an encrypted cluster.
*
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a
* cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new
* cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key
* used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the
* KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following occurs:
*
*
* -
*
* If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt
* the source cluster.
*
*
* -
*
* If the cluster is not encrypted, then the restored cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is
* rejected.
*
*
* @param kmsKeyId
* The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring
* a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the
* new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the
* KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by
* the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following occurs:
*
*
* -
*
* If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to
* encrypt the source cluster.
*
*
* -
*
* If the cluster is not encrypted, then the restored cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a cluster that is not 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 cluster from an encrypted cluster.
*
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a
* cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new
* cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key
* used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the
* KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following occurs:
*
*
* -
*
* If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt
* the source cluster.
*
*
* -
*
* If the cluster is not encrypted, then the restored cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is
* rejected.
*
*
* @return The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring
* a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the
* new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the
* KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified
* by the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following occurs:
*
*
* -
*
* If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to
* encrypt the source cluster.
*
*
* -
*
* If the cluster is not encrypted, then the restored cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request
* is rejected.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
*
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a
* cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new
* cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key
* used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the
* KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following occurs:
*
*
* -
*
* If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt
* the source cluster.
*
*
* -
*
* If the cluster is not encrypted, then the restored cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is
* rejected.
*
*
* @param kmsKeyId
* The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
*
* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring
* a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the
* new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
*
*
* You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the
* KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by
* the KmsKeyId parameter.
*
*
* If you do not specify a value for the KmsKeyId parameter, then the following occurs:
*
*
* -
*
* If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to
* encrypt the source cluster.
*
*
* -
*
* If the cluster is not encrypted, then the restored cluster is not encrypted.
*
*
*
*
* If DBClusterIdentifier refers to a cluster that is not 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;
}
/**
*
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*
*
* @return A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*/
public java.util.List getEnableCloudwatchLogsExports() {
return enableCloudwatchLogsExports;
}
/**
*
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*
*
* @param enableCloudwatchLogsExports
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*/
public void setEnableCloudwatchLogsExports(java.util.Collection enableCloudwatchLogsExports) {
if (enableCloudwatchLogsExports == null) {
this.enableCloudwatchLogsExports = null;
return;
}
this.enableCloudwatchLogsExports = new java.util.ArrayList(enableCloudwatchLogsExports);
}
/**
*
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setEnableCloudwatchLogsExports(java.util.Collection)} or
* {@link #withEnableCloudwatchLogsExports(java.util.Collection)} if you want to override the existing values.
*
*
* @param enableCloudwatchLogsExports
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports) {
if (this.enableCloudwatchLogsExports == null) {
setEnableCloudwatchLogsExports(new java.util.ArrayList(enableCloudwatchLogsExports.length));
}
for (String ele : enableCloudwatchLogsExports) {
this.enableCloudwatchLogsExports.add(ele);
}
return this;
}
/**
*
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*
*
* @param enableCloudwatchLogsExports
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withEnableCloudwatchLogsExports(java.util.Collection enableCloudwatchLogsExports) {
setEnableCloudwatchLogsExports(enableCloudwatchLogsExports);
return this;
}
/**
*
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
* be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
* protects clusters from being accidentally deleted.
*
*
* @param deletionProtection
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster
* cannot be deleted unless it is modified and DeletionProtection is disabled.
* DeletionProtection protects clusters from being accidentally deleted.
*/
public void setDeletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
}
/**
*
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
* be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
* protects clusters from being accidentally deleted.
*
*
* @return Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster
* cannot be deleted unless it is modified and DeletionProtection is disabled.
* DeletionProtection protects clusters from being accidentally deleted.
*/
public Boolean getDeletionProtection() {
return this.deletionProtection;
}
/**
*
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
* be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
* protects clusters from being accidentally deleted.
*
*
* @param deletionProtection
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster
* cannot be deleted unless it is modified and DeletionProtection is disabled.
* DeletionProtection protects clusters from being accidentally deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withDeletionProtection(Boolean deletionProtection) {
setDeletionProtection(deletionProtection);
return this;
}
/**
*
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
* be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
* protects clusters from being accidentally deleted.
*
*
* @return Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster
* cannot be deleted unless it is modified and DeletionProtection is disabled.
* DeletionProtection protects clusters from being accidentally deleted.
*/
public Boolean isDeletionProtection() {
return this.deletionProtection;
}
/**
*
* The storage type to associate with the DB cluster.
*
*
* For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
* Amazon DocumentDB Developer Guide.
*
*
* Valid values for storage type - standard | iopt1
*
*
* Default value is standard
*
*
* @param storageType
* The storage type to associate with the DB cluster.
*
* For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
* Amazon DocumentDB Developer Guide.
*
*
* Valid values for storage type - standard | iopt1
*
*
* Default value is standard
*/
public void setStorageType(String storageType) {
this.storageType = storageType;
}
/**
*
* The storage type to associate with the DB cluster.
*
*
* For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
* Amazon DocumentDB Developer Guide.
*
*
* Valid values for storage type - standard | iopt1
*
*
* Default value is standard
*
*
* @return The storage type to associate with the DB cluster.
*
* For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in
* the Amazon DocumentDB Developer Guide.
*
*
* Valid values for storage type - standard | iopt1
*
*
* Default value is standard
*/
public String getStorageType() {
return this.storageType;
}
/**
*
* The storage type to associate with the DB cluster.
*
*
* For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
* Amazon DocumentDB Developer Guide.
*
*
* Valid values for storage type - standard | iopt1
*
*
* Default value is standard
*
*
* @param storageType
* The storage type to associate with the DB cluster.
*
* For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
* Amazon DocumentDB Developer Guide.
*
*
* Valid values for storage type - standard | iopt1
*
*
* Default value is standard
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterToPointInTimeRequest withStorageType(String storageType) {
setStorageType(storageType);
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 (getDBClusterIdentifier() != null)
sb.append("DBClusterIdentifier: ").append(getDBClusterIdentifier()).append(",");
if (getRestoreType() != null)
sb.append("RestoreType: ").append(getRestoreType()).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 (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()).append(",");
if (getEnableCloudwatchLogsExports() != null)
sb.append("EnableCloudwatchLogsExports: ").append(getEnableCloudwatchLogsExports()).append(",");
if (getDeletionProtection() != null)
sb.append("DeletionProtection: ").append(getDeletionProtection()).append(",");
if (getStorageType() != null)
sb.append("StorageType: ").append(getStorageType());
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.getRestoreType() == null ^ this.getRestoreType() == null)
return false;
if (other.getRestoreType() != null && other.getRestoreType().equals(this.getRestoreType()) == 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.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;
if (other.getEnableCloudwatchLogsExports() == null ^ this.getEnableCloudwatchLogsExports() == null)
return false;
if (other.getEnableCloudwatchLogsExports() != null && other.getEnableCloudwatchLogsExports().equals(this.getEnableCloudwatchLogsExports()) == false)
return false;
if (other.getDeletionProtection() == null ^ this.getDeletionProtection() == null)
return false;
if (other.getDeletionProtection() != null && other.getDeletionProtection().equals(this.getDeletionProtection()) == false)
return false;
if (other.getStorageType() == null ^ this.getStorageType() == null)
return false;
if (other.getStorageType() != null && other.getStorageType().equals(this.getStorageType()) == 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 + ((getRestoreType() == null) ? 0 : getRestoreType().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 + ((getVpcSecurityGroupIds() == null) ? 0 : getVpcSecurityGroupIds().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getEnableCloudwatchLogsExports() == null) ? 0 : getEnableCloudwatchLogsExports().hashCode());
hashCode = prime * hashCode + ((getDeletionProtection() == null) ? 0 : getDeletionProtection().hashCode());
hashCode = prime * hashCode + ((getStorageType() == null) ? 0 : getStorageType().hashCode());
return hashCode;
}
@Override
public RestoreDBClusterToPointInTimeRequest clone() {
return (RestoreDBClusterToPointInTimeRequest) super.clone();
}
}