Class RestoreDbClusterToPointInTimeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.docdb.model.DocDbRequest
software.amazon.awssdk.services.docdb.model.RestoreDbClusterToPointInTimeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
@Generated("software.amazon.awssdk:codegen") public final class RestoreDbClusterToPointInTimeRequest extends DocDbRequest implements ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>

Represents the input to RestoreDBClusterToPointInTime.

  • Method Details

    • dbClusterIdentifier

      public final String 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.

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

    • restoreType

      public final String 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.

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

    • sourceDBClusterIdentifier

      public final String sourceDBClusterIdentifier()

      The identifier of the source cluster from which to restore.

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Returns:
      The identifier of the source cluster from which to restore.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • restoreToTime

      public final Instant 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

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

    • useLatestRestorableTime

      public final Boolean 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.

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

    • port

      public final Integer 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.

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

    • dbSubnetGroupName

      public final String dbSubnetGroupName()

      The subnet group name to use for the new cluster.

      Constraints: If provided, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

      Returns:
      The subnet group name to use for the new cluster.

      Constraints: If provided, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • hasVpcSecurityGroupIds

      public final boolean hasVpcSecurityGroupIds()
      For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • vpcSecurityGroupIds

      public final List<String> vpcSecurityGroupIds()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The tags to be assigned to the restored cluster.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags to be assigned to the restored cluster.

    • kmsKeyId

      public final String 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.

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

    • hasEnableCloudwatchLogsExports

      public final boolean hasEnableCloudwatchLogsExports()
      For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • enableCloudwatchLogsExports

      public final List<String> enableCloudwatchLogsExports()

      A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnableCloudwatchLogsExports() method.

      Returns:
      A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

    • deletionProtection

      public final Boolean 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.

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

    • storageType

      public final String 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

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

    • toBuilder

      public RestoreDbClusterToPointInTimeRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
      Specified by:
      toBuilder in class DocDbRequest
      Returns:
      a builder for type T

    • builder

      public static RestoreDbClusterToPointInTimeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.