Class RestoreDBClusterToPointInTimeRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.rds.model.RestoreDBClusterToPointInTimeRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable
public class RestoreDBClusterToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See Also:

  • Constructor Details

    • RestoreDBClusterToPointInTimeRequest

      public RestoreDBClusterToPointInTimeRequest()

  • Method Details

    • setDBClusterIdentifier

      public void setDBClusterIdentifier(String 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
      Parameters:
      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

    • getDBClusterIdentifier

      public String getDBClusterIdentifier()

      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
      Returns:
      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

    • withDBClusterIdentifier

      public RestoreDBClusterToPointInTimeRequest withDBClusterIdentifier(String 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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setSourceDBClusterIdentifier

      public void setSourceDBClusterIdentifier(String 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
      Parameters:
      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

    • getSourceDBClusterIdentifier

      public String getSourceDBClusterIdentifier()

      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
      Returns:
      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

    • withSourceDBClusterIdentifier

      public RestoreDBClusterToPointInTimeRequest withSourceDBClusterIdentifier(String 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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setRestoreToTime

      public void setRestoreToTime(Date 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

      Parameters:
      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

    • getRestoreToTime

      public Date getRestoreToTime()

      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

      Returns:
      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

    • withRestoreToTime

      public RestoreDBClusterToPointInTimeRequest withRestoreToTime(Date 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setUseLatestRestorableTime

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

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

    • getUseLatestRestorableTime

      public Boolean getUseLatestRestorableTime()

      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.

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

    • withUseLatestRestorableTime

      public RestoreDBClusterToPointInTimeRequest withUseLatestRestorableTime(Boolean 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isUseLatestRestorableTime

      public Boolean isUseLatestRestorableTime()

      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.

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

    • setPort

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

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

    • getPort

      public Integer getPort()

      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.

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

    • withPort

      public RestoreDBClusterToPointInTimeRequest withPort(Integer 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setDBSubnetGroupName

      public void setDBSubnetGroupName(String 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

      Parameters:
      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

    • getDBSubnetGroupName

      public String getDBSubnetGroupName()

      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

      Returns:
      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

    • withDBSubnetGroupName

      public RestoreDBClusterToPointInTimeRequest withDBSubnetGroupName(String 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setOptionGroupName

      public void setOptionGroupName(String optionGroupName)

      The name of the option group for the new DB cluster.

      Parameters:
      optionGroupName - The name of the option group for the new DB cluster.

    • getOptionGroupName

      public String getOptionGroupName()

      The name of the option group for the new DB cluster.

      Returns:
      The name of the option group for the new DB cluster.

    • withOptionGroupName

      public RestoreDBClusterToPointInTimeRequest withOptionGroupName(String optionGroupName)

      The name of the option group for the new DB cluster.

      Parameters:
      optionGroupName - The name of the option group for the new DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getVpcSecurityGroupIds

      public List<String> getVpcSecurityGroupIds()

      A lst of VPC security groups that the new DB cluster belongs to.

      Returns:
      A lst of VPC security groups that the new DB cluster belongs to.

    • setVpcSecurityGroupIds

      public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A lst of VPC security groups that the new DB cluster belongs to.

      Parameters:
      vpcSecurityGroupIds - A lst of VPC security groups that the new DB cluster belongs to.

    • withVpcSecurityGroupIds

      public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(String... 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 setVpcSecurityGroupIds(java.util.Collection) or withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.

      Parameters:
      vpcSecurityGroupIds - A lst of VPC security groups that the new DB cluster belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withVpcSecurityGroupIds

      public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A lst of VPC security groups that the new DB cluster belongs to.

      Parameters:
      vpcSecurityGroupIds - A lst of VPC security groups that the new DB cluster belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getTags

      public List<Tag> getTags()
      Returns:

    • setTags

      public void setTags(Collection<Tag> tags)
      Parameters:
      tags -

    • withTags

      public RestoreDBClusterToPointInTimeRequest withTags(Tag... tags)

      NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

      Parameters:
      tags -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withTags

      public RestoreDBClusterToPointInTimeRequest withTags(Collection<Tag> tags)
      Parameters:
      tags -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setKmsKeyId

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

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

    • getKmsKeyId

      public String getKmsKeyId()

      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.

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

    • withKmsKeyId

      public RestoreDBClusterToPointInTimeRequest withKmsKeyId(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public RestoreDBClusterToPointInTimeRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: