Package software.amazon.awssdk.services.neptune.model

Class RestoreDbClusterToPointInTimeRequest

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

  • Method Details

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The name of the new DB cluster to be created.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, 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 letters, numbers, or hyphens

      • 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.

      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.

      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 DB cluster from which to restore.

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Returns:
      The identifier of the source DB 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 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

      • Must be specified if UseLatestRestorableTime parameter is not provided

      • Cannot be specified if UseLatestRestorableTime parameter is true

      • Cannot be specified if RestoreType parameter is copy-on-write

      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

      • Must be specified if UseLatestRestorableTime parameter is not provided

      • Cannot be specified if UseLatestRestorableTime parameter is true

      • Cannot be specified if 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 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.

    • port

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

      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.

    • dbSubnetGroupName

      public final String dbSubnetGroupName()

      The DB subnet group name to use for the new DB cluster.

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

      Example: mySubnetgroup

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

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

      Example: mySubnetgroup

    • optionGroupName

      public final String optionGroupName()

      (Not supported by Neptune)

      Returns:
      (Not supported by Neptune)

    • 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 DB 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 DB 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 applied to the restored DB 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 applied to the restored DB cluster.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon 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 Amazon 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 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 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 not encrypted, then the restore request is rejected.

      Returns:
      The Amazon 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 Amazon 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 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 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 not encrypted, then the restore request is rejected.

    • enableIAMDatabaseAuthentication

      public final Boolean enableIAMDatabaseAuthentication()

      True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

      Returns:
      True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

    • 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()

      The list of logs that the restored DB cluster is to export to 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:
      The list of logs that the restored DB cluster is to export to CloudWatch Logs.

    • dbClusterParameterGroupName

      public final String dbClusterParameterGroupName()

      The name of the DB cluster parameter group to associate with the new DB cluster.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

      Returns:
      The name of the DB cluster parameter group to associate with the new DB cluster.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

    • deletionProtection

      public final Boolean deletionProtection()

      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

      Returns:
      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    • serverlessV2ScalingConfiguration

      public final ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration()

      Contains the scaling configuration of a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      Returns:
      Contains the scaling configuration of a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    • 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 NeptuneRequest
      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.