Package software.amazon.awssdk.services.rds.model

Interface RestoreDbClusterToPointInTimeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>, RdsRequest.Builder, SdkBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RestoreDbClusterToPointInTimeRequest
public static interface RestoreDbClusterToPointInTimeRequest.Builder extends RdsRequest.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

      • Can't end with a hyphen or contain two consecutive hyphens

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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

      • Can't end with a hyphen or contain two consecutive hyphens

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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 isn't provided

      • Can't be specified if the UseLatestRestorableTime parameter is enabled

      • Can't be specified if the RestoreType parameter is copy-on-write

      Example: 2015-03-07T23:45:00Z

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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 isn't provided

      • Can't be specified if the UseLatestRestorableTime parameter is enabled

      • Can't be specified if the RestoreType parameter is copy-on-write

      Example: 2015-03-07T23:45:00Z

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • useLatestRestorableTime

      RestoreDbClusterToPointInTimeRequest.Builder useLatestRestorableTime(Boolean useLatestRestorableTime)

      Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

      Constraints: Can't be specified if RestoreToTime parameter is provided.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      useLatestRestorableTime - Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

      Constraints: Can't be specified if RestoreToTime parameter is provided.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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: A value from 1150-65535.

      Default: The default port for the engine.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      port - The port number on which the new DB cluster accepts connections.

      Constraints: A value from 1150-65535.

      Default: The default port for the engine.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • optionGroupName

      RestoreDbClusterToPointInTimeRequest.Builder optionGroupName(String optionGroupName)

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

      DB clusters are associated with a default option group that can't be modified.

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

      DB clusters are associated with a default option group that can't be modified.

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • tags

      RestoreDbClusterToPointInTimeRequest.Builder tags(Collection<Tag> tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RestoreDbClusterToPointInTimeRequest.Builder tags(Tag... tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RestoreDbClusterToPointInTimeRequest.Builder tags(Consumer<Tag.Builder>... tags)
      Sets the value of the Tags property for this object. 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 Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from 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 don't specify a value for the KmsKeyId parameter, then the following occurs:

      • 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 isn't encrypted, then the restored DB cluster isn't encrypted.

      If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      kmsKeyId - The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from 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 don't specify a value for the KmsKeyId parameter, then the following occurs:

      • 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 isn't encrypted, then the restored DB cluster isn't encrypted.

      If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • enableIAMDatabaseAuthentication

      RestoreDbClusterToPointInTimeRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

      Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

      Parameters:
      enableIAMDatabaseAuthentication - Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

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

    • backtrackWindow

      RestoreDbClusterToPointInTimeRequest.Builder backtrackWindow(Long backtrackWindow)

      The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Default: 0

      Constraints:

      • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      Valid for: Aurora MySQL DB clusters only

      Parameters:
      backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Default: 0

      Constraints:

      • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      Valid for: Aurora MySQL DB clusters only

      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. The values in the list depend on the DB engine being used.

      RDS for MySQL

      Possible values are error, general, and slowquery.

      RDS for PostgreSQL

      Possible values are postgresql and upgrade.

      Aurora MySQL

      Possible values are audit, error, general, and slowquery.

      Aurora PostgreSQL

      Possible value is postgresql.

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

      RDS for MySQL

      Possible values are error, general, and slowquery.

      RDS for PostgreSQL

      Possible values are postgresql and upgrade.

      Aurora MySQL

      Possible values are audit, error, general, and slowquery.

      Aurora PostgreSQL

      Possible value is postgresql.

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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. The values in the list depend on the DB engine being used.

      RDS for MySQL

      Possible values are error, general, and slowquery.

      RDS for PostgreSQL

      Possible values are postgresql and upgrade.

      Aurora MySQL

      Possible values are audit, error, general, and slowquery.

      Aurora PostgreSQL

      Possible value is postgresql.

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

      RDS for MySQL

      Possible values are error, general, and slowquery.

      RDS for PostgreSQL

      Possible values are postgresql and upgrade.

      Aurora MySQL

      Possible values are audit, error, general, and slowquery.

      Aurora PostgreSQL

      Possible value is postgresql.

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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 custom DB cluster parameter group to associate with this DB cluster.

      If the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified engine is used.

      Constraints:

      • If supplied, must match the name of an existing DB cluster parameter group.

      • Must be 1 to 255 letters, numbers, or hyphens.

      • First character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      dbClusterParameterGroupName - The name of the custom DB cluster parameter group to associate with this DB cluster.

      If the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified engine is used.

      Constraints:

      • If supplied, must match the name of an existing DB cluster parameter group.

      • Must be 1 to 255 letters, numbers, or hyphens.

      • First character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • deletionProtection

      RestoreDbClusterToPointInTimeRequest.Builder deletionProtection(Boolean deletionProtection)

      Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      deletionProtection - Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • copyTagsToSnapshot

      RestoreDbClusterToPointInTimeRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

      Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      copyTagsToSnapshot - Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • domain

      RestoreDbClusterToPointInTimeRequest.Builder domain(String domain)

      The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

      For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

      Parameters:
      domain - The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

      For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

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

    • domainIAMRoleName

      RestoreDbClusterToPointInTimeRequest.Builder domainIAMRoleName(String domainIAMRoleName)

      The name of the IAM role to be used when making API calls to the Directory Service.

      Valid for: Aurora DB clusters only

      Parameters:
      domainIAMRoleName - The name of the IAM role to be used when making API calls to the Directory Service.

      Valid for: Aurora DB clusters only

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

    • scalingConfiguration

      RestoreDbClusterToPointInTimeRequest.Builder scalingConfiguration(ScalingConfiguration scalingConfiguration)

      For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      Valid for: Aurora DB clusters only

      Parameters:
      scalingConfiguration - For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      Valid for: Aurora DB clusters only

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

    • scalingConfiguration

      default RestoreDbClusterToPointInTimeRequest.Builder scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)

      For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      Valid for: Aurora DB clusters only

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

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

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

    • engineMode

      RestoreDbClusterToPointInTimeRequest.Builder engineMode(String engineMode)

      The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.

      Valid for: Aurora DB clusters only

      Parameters:
      engineMode - The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.

      Valid for: Aurora DB clusters only

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

    • dbClusterInstanceClass

      RestoreDbClusterToPointInTimeRequest.Builder dbClusterInstanceClass(String dbClusterInstanceClass)

      The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

      For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.

      Valid for: Multi-AZ DB clusters only

      Parameters:
      dbClusterInstanceClass - The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

      For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.

      Valid for: Multi-AZ DB clusters only

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

    • storageType

      RestoreDbClusterToPointInTimeRequest.Builder storageType(String storageType)

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

      When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

      Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

      Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • publiclyAccessible

      RestoreDbClusterToPointInTimeRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

      Specifies whether the DB cluster is publicly accessible.

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

      When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      Valid for: Multi-AZ DB clusters only

      Parameters:
      publiclyAccessible - Specifies whether the DB cluster is publicly accessible.

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

      When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      Valid for: Multi-AZ DB clusters only

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

    • iops

      RestoreDbClusterToPointInTimeRequest.Builder iops(Integer iops)

      The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

      For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

      Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

      Valid for: Multi-AZ DB clusters only

      Parameters:
      iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

      For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

      Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

      Valid for: Multi-AZ DB clusters only

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

    • serverlessV2ScalingConfiguration

      RestoreDbClusterToPointInTimeRequest.Builder serverlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
      Sets the value of the ServerlessV2ScalingConfiguration property for this object.
      Parameters:
      serverlessV2ScalingConfiguration - The new value for the ServerlessV2ScalingConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverlessV2ScalingConfiguration

      default RestoreDbClusterToPointInTimeRequest.Builder serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfiguration.Builder> serverlessV2ScalingConfiguration)
      Sets the value of the ServerlessV2ScalingConfiguration property for this object. 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:

    • networkType

      RestoreDbClusterToPointInTimeRequest.Builder networkType(String networkType)

      The network type of the DB cluster.

      Valid Values:

      • IPV4

      • DUAL

      The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

      Parameters:
      networkType - The network type of the DB cluster.

      Valid Values:

      • IPV4

      • DUAL

      The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

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

    • sourceDbClusterResourceId

      RestoreDbClusterToPointInTimeRequest.Builder sourceDbClusterResourceId(String sourceDbClusterResourceId)

      The resource ID of the source DB cluster from which to restore.

      Parameters:
      sourceDbClusterResourceId - The resource ID of the source DB cluster from which to restore.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rdsCustomClusterConfiguration

      RestoreDbClusterToPointInTimeRequest.Builder rdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)

      Reserved for future use.

      Parameters:
      rdsCustomClusterConfiguration - Reserved for future use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rdsCustomClusterConfiguration

      default RestoreDbClusterToPointInTimeRequest.Builder rdsCustomClusterConfiguration(Consumer<RdsCustomClusterConfiguration.Builder> rdsCustomClusterConfiguration)

      Reserved for future use.

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

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

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

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