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

Interface RestoreDbInstanceToPointInTimeRequest.Builder

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

  • Method Details

    • sourceDBInstanceIdentifier

      RestoreDbInstanceToPointInTimeRequest.Builder sourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)

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

      Constraints:

      • Must match the identifier of an existing DB instance.

      Parameters:
      sourceDBInstanceIdentifier - The identifier of the source DB instance from which to restore.

      Constraints:

      • Must match the identifier of an existing DB instance.

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

    • targetDBInstanceIdentifier

      RestoreDbInstanceToPointInTimeRequest.Builder targetDBInstanceIdentifier(String targetDBInstanceIdentifier)

      The name of the new DB instance to create.

      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.

      Parameters:
      targetDBInstanceIdentifier - The name of the new DB instance to create.

      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.

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

    • restoreTime

      RestoreDbInstanceToPointInTimeRequest.Builder restoreTime(Instant restoreTime)

      The date and time to restore from.

      Constraints:

      • Must be a time in Universal Coordinated Time (UTC) format.

      • Must be before the latest restorable time for the DB instance.

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

      Example: 2009-09-07T23:45:00Z

      Parameters:
      restoreTime - The date and time to restore from.

      Constraints:

      • Must be a time in Universal Coordinated Time (UTC) format.

      • Must be before the latest restorable time for the DB instance.

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

      Example: 2009-09-07T23:45:00Z

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

    • useLatestRestorableTime

      RestoreDbInstanceToPointInTimeRequest.Builder useLatestRestorableTime(Boolean useLatestRestorableTime)

      Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

      Constraints:

      • Can't be specified if the RestoreTime parameter is provided.

      Parameters:
      useLatestRestorableTime - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

      Constraints:

      • Can't be specified if the RestoreTime parameter is provided.

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

    • dbInstanceClass

      RestoreDbInstanceToPointInTimeRequest.Builder dbInstanceClass(String dbInstanceClass)

      The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. 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.

      Default: The same DB instance class as the original DB instance.

      Parameters:
      dbInstanceClass - The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. 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.

      Default: The same DB instance class as the original DB instance.

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

    • port

      RestoreDbInstanceToPointInTimeRequest.Builder port(Integer port)

      The port number on which the database accepts connections.

      Default: The same port as the original DB instance.

      Constraints:

      • The value must be 1150-65535.

      Parameters:
      port - The port number on which the database accepts connections.

      Default: The same port as the original DB instance.

      Constraints:

      • The value must be 1150-65535.

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

    • availabilityZone

      RestoreDbInstanceToPointInTimeRequest.Builder availabilityZone(String availabilityZone)

      The Availability Zone (AZ) where the DB instance will be created.

      Default: A random, system-chosen Availability Zone.

      Constraints:

      • You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

      Example: us-east-1a

      Parameters:
      availabilityZone - The Availability Zone (AZ) where the DB instance will be created.

      Default: A random, system-chosen Availability Zone.

      Constraints:

      • You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

      Example: us-east-1a

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

    • dbSubnetGroupName

      RestoreDbInstanceToPointInTimeRequest.Builder dbSubnetGroupName(String dbSubnetGroupName)

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

      Constraints:

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

      Example: mydbsubnetgroup

      Parameters:
      dbSubnetGroupName - The DB subnet group name to use for the new instance.

      Constraints:

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

      Example: mydbsubnetgroup

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

    • multiAZ

      RestoreDbInstanceToPointInTimeRequest.Builder multiAZ(Boolean multiAZ)

      Secifies whether the DB instance is a Multi-AZ deployment.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

      Parameters:
      multiAZ - Secifies whether the DB instance is a Multi-AZ deployment.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

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

    • publiclyAccessible

      RestoreDbInstanceToPointInTimeRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

      Specifies whether the DB instance 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 isn't permitted if the security group assigned to the DB cluster doesn't permit it.

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

      For more information, see CreateDBInstance.

      Parameters:
      publiclyAccessible - Specifies whether the DB instance 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 isn't permitted if the security group assigned to the DB cluster doesn't permit it.

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

      For more information, see CreateDBInstance.

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

    • autoMinorVersionUpgrade

      RestoreDbInstanceToPointInTimeRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

      Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

      This setting doesn't apply to RDS Custom.

      Parameters:
      autoMinorVersionUpgrade - Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

      This setting doesn't apply to RDS Custom.

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

    • licenseModel

      RestoreDbInstanceToPointInTimeRequest.Builder licenseModel(String licenseModel)

      The license model information for the restored DB instance.

      This setting doesn't apply to RDS Custom.

      Valid Values: license-included | bring-your-own-license | general-public-license

      Default: Same as the source.

      Parameters:
      licenseModel - The license model information for the restored DB instance.

      This setting doesn't apply to RDS Custom.

      Valid Values: license-included | bring-your-own-license | general-public-license

      Default: Same as the source.

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

    • dbName

      RestoreDbInstanceToPointInTimeRequest.Builder dbName(String dbName)

      The database name for the restored DB instance.

      This parameter doesn't apply to the following DB instances:

      • RDS Custom

      • RDS for Db2

      • RDS for MariaDB

      • RDS for MySQL

      Parameters:
      dbName - The database name for the restored DB instance.

      This parameter doesn't apply to the following DB instances:

      • RDS Custom

      • RDS for Db2

      • RDS for MariaDB

      • RDS for MySQL

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

    • engine

      RestoreDbInstanceToPointInTimeRequest.Builder engine(String engine)

      The database engine to use for the new instance.

      This setting doesn't apply to RDS Custom.

      Valid Values:

      • db2-ae

      • db2-se

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

      Default: The same as source

      Constraints:

      • Must be compatible with the engine of the source.

      Parameters:
      engine - The database engine to use for the new instance.

      This setting doesn't apply to RDS Custom.

      Valid Values:

      • db2-ae

      • db2-se

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

      Default: The same as source

      Constraints:

      • Must be compatible with the engine of the source.

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

    • iops

      RestoreDbInstanceToPointInTimeRequest.Builder iops(Integer iops)

      The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

      This setting doesn't apply to SQL Server.

      Constraints:

      • Must be an integer greater than 1000.

      Parameters:
      iops - The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

      This setting doesn't apply to SQL Server.

      Constraints:

      • Must be an integer greater than 1000.

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

    • optionGroupName

      RestoreDbInstanceToPointInTimeRequest.Builder optionGroupName(String optionGroupName)

      The name of the option group to use for the restored DB instance.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

      This setting doesn't apply to RDS Custom.

      Parameters:
      optionGroupName - The name of the option group to use for the restored DB instance.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

      This setting doesn't apply to RDS Custom.

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

    • copyTagsToSnapshot

      RestoreDbInstanceToPointInTimeRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

      Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

      Parameters:
      copyTagsToSnapshot - Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

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

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

    • storageType

      RestoreDbInstanceToPointInTimeRequest.Builder storageType(String storageType)

      The storage type to associate with the DB instance.

      Valid Values: gp2 | gp3 | io1 | io2 | standard

      Default: io1, if the Iops parameter is specified. Otherwise, gp2.

      Constraints:

      • If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

      Parameters:
      storageType - The storage type to associate with the DB instance.

      Valid Values: gp2 | gp3 | io1 | io2 | standard

      Default: io1, if the Iops parameter is specified. Otherwise, gp2.

      Constraints:

      • If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

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

    • tdeCredentialArn

      RestoreDbInstanceToPointInTimeRequest.Builder tdeCredentialArn(String tdeCredentialArn)

      The ARN from the key store with which to associate the instance for TDE encryption.

      This setting doesn't apply to RDS Custom.

      Parameters:
      tdeCredentialArn - The ARN from the key store with which to associate the instance for TDE encryption.

      This setting doesn't apply to RDS Custom.

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

    • tdeCredentialPassword

      RestoreDbInstanceToPointInTimeRequest.Builder tdeCredentialPassword(String tdeCredentialPassword)

      The password for the given ARN from the key store in order to access the device.

      This setting doesn't apply to RDS Custom.

      Parameters:
      tdeCredentialPassword - The password for the given ARN from the key store in order to access the device.

      This setting doesn't apply to RDS Custom.

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

    • vpcSecurityGroupIds

      RestoreDbInstanceToPointInTimeRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A list of EC2 VPC security groups to associate with this DB instance.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB instance.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

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

    • vpcSecurityGroupIds

      RestoreDbInstanceToPointInTimeRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

      A list of EC2 VPC security groups to associate with this DB instance.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB instance.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

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

    • domain

      RestoreDbInstanceToPointInTimeRequest.Builder domain(String domain)

      The Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

      This setting doesn't apply to RDS Custom.

      For more information, see Kerberos Authentication in the Amazon RDS User Guide.

      Parameters:
      domain - The Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

      This setting doesn't apply to RDS Custom.

      For more information, see Kerberos Authentication in the Amazon RDS User Guide.

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

    • domainIAMRoleName

      RestoreDbInstanceToPointInTimeRequest.Builder domainIAMRoleName(String domainIAMRoleName)

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

      This setting doesn't apply to RDS Custom DB instances.

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

      This setting doesn't apply to RDS Custom DB instances.

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

    • domainFqdn

      RestoreDbInstanceToPointInTimeRequest.Builder domainFqdn(String domainFqdn)

      The fully qualified domain name (FQDN) of an Active Directory domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: mymanagedADtest.mymanagedAD.mydomain

      Parameters:
      domainFqdn - The fully qualified domain name (FQDN) of an Active Directory domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: mymanagedADtest.mymanagedAD.mydomain

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

    • domainOu

      RestoreDbInstanceToPointInTimeRequest.Builder domainOu(String domainOu)

      The Active Directory organizational unit for your DB instance to join.

      Constraints:

      • Must be in the distinguished name format.

      • Can't be longer than 64 characters.

      Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

      Parameters:
      domainOu - The Active Directory organizational unit for your DB instance to join.

      Constraints:

      • Must be in the distinguished name format.

      • Can't be longer than 64 characters.

      Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

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

    • domainAuthSecretArn

      RestoreDbInstanceToPointInTimeRequest.Builder domainAuthSecretArn(String domainAuthSecretArn)

      The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

      Parameters:
      domainAuthSecretArn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

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

    • domainDnsIps

      RestoreDbInstanceToPointInTimeRequest.Builder domainDnsIps(Collection<String> domainDnsIps)

      The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

      Constraints:

      • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

      Example: 123.124.125.126,234.235.236.237

      Parameters:
      domainDnsIps - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

      Constraints:

      • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

      Example: 123.124.125.126,234.235.236.237

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

    • domainDnsIps

      RestoreDbInstanceToPointInTimeRequest.Builder domainDnsIps(String... domainDnsIps)

      The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

      Constraints:

      • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

      Example: 123.124.125.126,234.235.236.237

      Parameters:
      domainDnsIps - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

      Constraints:

      • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

      Example: 123.124.125.126,234.235.236.237

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

    • enableIAMDatabaseAuthentication

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

      This setting doesn't apply to RDS Custom.

      For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

      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.

      This setting doesn't apply to RDS Custom.

      For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

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

    • enableCloudwatchLogsExports

      RestoreDbInstanceToPointInTimeRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)

      The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom.

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom.

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

    • enableCloudwatchLogsExports

      RestoreDbInstanceToPointInTimeRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)

      The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom.

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom.

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

    • processorFeatures

      RestoreDbInstanceToPointInTimeRequest.Builder processorFeatures(Collection<ProcessorFeature> processorFeatures)

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      This setting doesn't apply to RDS Custom.

      Parameters:
      processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      This setting doesn't apply to RDS Custom.

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

    • processorFeatures

      RestoreDbInstanceToPointInTimeRequest.Builder processorFeatures(ProcessorFeature... processorFeatures)

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      This setting doesn't apply to RDS Custom.

      Parameters:
      processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      This setting doesn't apply to RDS Custom.

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

    • processorFeatures

      RestoreDbInstanceToPointInTimeRequest.Builder processorFeatures(Consumer<ProcessorFeature.Builder>... processorFeatures)

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      This setting doesn't apply to RDS Custom.

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

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

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

    • useDefaultProcessorFeatures

      RestoreDbInstanceToPointInTimeRequest.Builder useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)

      Specifies whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom.

      Parameters:
      useDefaultProcessorFeatures - Specifies whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom.

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

    • dbParameterGroupName

      RestoreDbInstanceToPointInTimeRequest.Builder dbParameterGroupName(String dbParameterGroupName)

      The name of the DB parameter group to associate with this DB instance.

      If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • If supplied, must match the name of an existing DB 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.

      Parameters:
      dbParameterGroupName - The name of the DB parameter group to associate with this DB instance.

      If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • If supplied, must match the name of an existing DB 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.

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

    • deletionProtection

      RestoreDbInstanceToPointInTimeRequest.Builder deletionProtection(Boolean deletionProtection)

      Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

      Parameters:
      deletionProtection - Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceDbiResourceId

      RestoreDbInstanceToPointInTimeRequest.Builder sourceDbiResourceId(String sourceDbiResourceId)

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

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

    • maxAllocatedStorage

      RestoreDbInstanceToPointInTimeRequest.Builder maxAllocatedStorage(Integer maxAllocatedStorage)

      The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

      For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom.

      Parameters:
      maxAllocatedStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

      For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom.

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

    • sourceDBInstanceAutomatedBackupsArn

      RestoreDbInstanceToPointInTimeRequest.Builder sourceDBInstanceAutomatedBackupsArn(String sourceDBInstanceAutomatedBackupsArn)

      The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

      This setting doesn't apply to RDS Custom.

      Parameters:
      sourceDBInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

      This setting doesn't apply to RDS Custom.

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

    • enableCustomerOwnedIp

      RestoreDbInstanceToPointInTimeRequest.Builder enableCustomerOwnedIp(Boolean enableCustomerOwnedIp)

      Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

      A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

      This setting doesn't apply to RDS Custom.

      For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

      For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

      Parameters:
      enableCustomerOwnedIp - Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

      A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

      This setting doesn't apply to RDS Custom.

      For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

      For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

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

    • customIamInstanceProfile

      RestoreDbInstanceToPointInTimeRequest.Builder customIamInstanceProfile(String customIamInstanceProfile)

      The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

      • The profile must exist in your account.

      • The profile must have an IAM role that Amazon EC2 has permissions to assume.

      • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

      For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

      This setting is required for RDS Custom.

      Parameters:
      customIamInstanceProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

      • The profile must exist in your account.

      • The profile must have an IAM role that Amazon EC2 has permissions to assume.

      • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

      For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

      This setting is required for RDS Custom.

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

    • backupTarget

      RestoreDbInstanceToPointInTimeRequest.Builder backupTarget(String backupTarget)

      The location for storing automated backups and manual snapshots for the restored DB instance.

      Valid Values:

      • outposts (Amazon Web Services Outposts)

      • region (Amazon Web Services Region)

      Default: region

      For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

      Parameters:
      backupTarget - The location for storing automated backups and manual snapshots for the restored DB instance.

      Valid Values:

      • outposts (Amazon Web Services Outposts)

      • region (Amazon Web Services Region)

      Default: region

      For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

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

    • networkType

      RestoreDbInstanceToPointInTimeRequest.Builder networkType(String networkType)

      The network type of the DB instance.

      The network type is determined by the DBSubnetGroup specified for the DB instance. 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 RDS User Guide.

      Valid Values:

      • IPV4

      • DUAL

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

      The network type is determined by the DBSubnetGroup specified for the DB instance. 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 RDS User Guide.

      Valid Values:

      • IPV4

      • DUAL

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

    • storageThroughput

      RestoreDbInstanceToPointInTimeRequest.Builder storageThroughput(Integer storageThroughput)

      The storage throughput value for the DB instance.

      This setting doesn't apply to RDS Custom or Amazon Aurora.

      Parameters:
      storageThroughput - The storage throughput value for the DB instance.

      This setting doesn't apply to RDS Custom or Amazon Aurora.

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

    • allocatedStorage

      RestoreDbInstanceToPointInTimeRequest.Builder allocatedStorage(Integer allocatedStorage)

      The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

      Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

      Parameters:
      allocatedStorage - The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

      Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

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

    • dedicatedLogVolume

      RestoreDbInstanceToPointInTimeRequest.Builder dedicatedLogVolume(Boolean dedicatedLogVolume)

      Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

      Parameters:
      dedicatedLogVolume - Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • caCertificateIdentifier

      RestoreDbInstanceToPointInTimeRequest.Builder caCertificateIdentifier(String caCertificateIdentifier)

      The CA certificate identifier to use for the DB instance's server certificate.

      This setting doesn't apply to RDS Custom DB instances.

      For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

      Parameters:
      caCertificateIdentifier - The CA certificate identifier to use for the DB instance's server certificate.

      This setting doesn't apply to RDS Custom DB instances.

      For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

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

    • overrideConfiguration

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

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