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

Interface RestoreDbClusterToPointInTimeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>, NeptuneRequest.Builder, SdkBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RestoreDbClusterToPointInTimeRequest
public static interface RestoreDbClusterToPointInTimeRequest.Builder extends NeptuneRequest.Builder, SdkPojo, CopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>

  • Method Details

    • dbClusterIdentifier

      RestoreDbClusterToPointInTimeRequest.Builder dbClusterIdentifier(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

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

    • restoreType

      RestoreDbClusterToPointInTimeRequest.Builder restoreType(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.

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

    • sourceDBClusterIdentifier

      RestoreDbClusterToPointInTimeRequest.Builder sourceDBClusterIdentifier(String sourceDBClusterIdentifier)

      The identifier of the source DB cluster from which to restore.

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Parameters:
      sourceDBClusterIdentifier - The identifier of the source DB cluster from which to restore.

      Constraints:

      • Must match the identifier of an existing DBCluster.

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

    • restoreToTime

      RestoreDbClusterToPointInTimeRequest.Builder restoreToTime(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

      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

      • 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:
      Returns a reference to this object so that method calls can be chained together.

    • useLatestRestorableTime

      RestoreDbClusterToPointInTimeRequest.Builder useLatestRestorableTime(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.

    • port

      RestoreDbClusterToPointInTimeRequest.Builder port(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.

    • dbSubnetGroupName

      RestoreDbClusterToPointInTimeRequest.Builder dbSubnetGroupName(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

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

    • optionGroupName

      RestoreDbClusterToPointInTimeRequest.Builder optionGroupName(String optionGroupName)

      (Not supported by Neptune)

      Parameters:
      optionGroupName - (Not supported by Neptune)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroupIds

      RestoreDbClusterToPointInTimeRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

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

      Parameters:
      vpcSecurityGroupIds - A list 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.

    • vpcSecurityGroupIds

      RestoreDbClusterToPointInTimeRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

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

      Parameters:
      vpcSecurityGroupIds - A list 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.

    • tags

      RestoreDbClusterToPointInTimeRequest.Builder tags(Collection<Tag> tags)

      The tags to be applied to the restored DB cluster.

      Parameters:
      tags - The tags to be applied to the restored DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RestoreDbClusterToPointInTimeRequest.Builder tags(Tag... tags)

      The tags to be applied to the restored DB cluster.

      Parameters:
      tags - The tags to be applied to the restored DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RestoreDbClusterToPointInTimeRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to be applied to the restored DB cluster.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKeyId

      RestoreDbClusterToPointInTimeRequest.Builder kmsKeyId(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.

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

    • enableIAMDatabaseAuthentication

      RestoreDbClusterToPointInTimeRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

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

      Default: false

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

      Default: false

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

    • enableCloudwatchLogsExports

      RestoreDbClusterToPointInTimeRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)

      The list of logs that the restored DB cluster is to export to CloudWatch Logs.

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableCloudwatchLogsExports

      RestoreDbClusterToPointInTimeRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)

      The list of logs that the restored DB cluster is to export to CloudWatch Logs.

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbClusterParameterGroupName

      RestoreDbClusterToPointInTimeRequest.Builder dbClusterParameterGroupName(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.

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

    • deletionProtection

      RestoreDbClusterToPointInTimeRequest.Builder deletionProtection(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.

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

    • serverlessV2ScalingConfiguration

      RestoreDbClusterToPointInTimeRequest.Builder serverlessV2ScalingConfiguration(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.

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

    • serverlessV2ScalingConfiguration

      default RestoreDbClusterToPointInTimeRequest.Builder serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the ServerlessV2ScalingConfiguration.Builder avoiding the need to create one manually via ServerlessV2ScalingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serverlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration).

      Parameters:
      serverlessV2ScalingConfiguration - a consumer that will call methods on ServerlessV2ScalingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      RestoreDbClusterToPointInTimeRequest.Builder storageType(String storageType)

      Specifies the storage type to be associated with the DB cluster.

      Valid values: standard, iopt1

      Default: standard

      Parameters:
      storageType - Specifies the storage type to be associated with the DB cluster.

      Valid values: standard, iopt1

      Default: standard

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

    • overrideConfiguration

      RestoreDbClusterToPointInTimeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RestoreDbClusterToPointInTimeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.