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

Interface RestoreDBInstanceToPointInTimeRequest.Builder

All Superinterfaces:

CopyableBuilder<RestoreDBInstanceToPointInTimeRequest.Builder,RestoreDBInstanceToPointInTimeRequest>, SdkBuilder<RestoreDBInstanceToPointInTimeRequest.Builder,RestoreDBInstanceToPointInTimeRequest>

Enclosing class:

RestoreDBInstanceToPointInTimeRequest

public static interface RestoreDBInstanceToPointInTimeRequest.Builder
extends CopyableBuilder<RestoreDBInstanceToPointInTimeRequest.Builder,RestoreDBInstanceToPointInTimeRequest>

Method Summary

Modifier and Type	Method	Description
RestoreDBInstanceToPointInTimeRequest.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
RestoreDBInstanceToPointInTimeRequest.Builder	availabilityZone(String availabilityZone)	The EC2 Availability Zone that the database instance will be created in.
RestoreDBInstanceToPointInTimeRequest.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot)	True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false.
RestoreDBInstanceToPointInTimeRequest.Builder	dbInstanceClass(String dbInstanceClass)	The compute and memory capacity of the Amazon RDS DB instance.
RestoreDBInstanceToPointInTimeRequest.Builder	dbName(String dbName)	The database name for the restored DB instance.
RestoreDBInstanceToPointInTimeRequest.Builder	dbSubnetGroupName(String dbSubnetGroupName)	The DB subnet group name to use for the new instance.
RestoreDBInstanceToPointInTimeRequest.Builder	domain(String domain)	Specify the Active Directory Domain to restore the instance in.
RestoreDBInstanceToPointInTimeRequest.Builder	domainIAMRoleName(String domainIAMRoleName)	Specify the name of the IAM role to be used when making API calls to the Directory Service.
RestoreDBInstanceToPointInTimeRequest.Builder	enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)	True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
RestoreDBInstanceToPointInTimeRequest.Builder	engine(String engine)	The database engine to use for the new instance.
RestoreDBInstanceToPointInTimeRequest.Builder	iops(Integer iops)	The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
RestoreDBInstanceToPointInTimeRequest.Builder	licenseModel(String licenseModel)	License model information for the restored DB instance.
RestoreDBInstanceToPointInTimeRequest.Builder	multiAZ(Boolean multiAZ)	Specifies if the DB instance is a Multi-AZ deployment.
RestoreDBInstanceToPointInTimeRequest.Builder	optionGroupName(String optionGroupName)	The name of the option group to be used for the restored DB instance.
RestoreDBInstanceToPointInTimeRequest.Builder	port(Integer port)	The port number on which the database accepts connections.
RestoreDBInstanceToPointInTimeRequest.Builder	publiclyAccessible(Boolean publiclyAccessible)	Specifies the accessibility options for the DB instance.
RestoreDBInstanceToPointInTimeRequest.Builder	restoreTime(Date restoreTime)	The date and time to restore from.
RestoreDBInstanceToPointInTimeRequest.Builder	sourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)	The identifier of the source DB instance from which to restore.
RestoreDBInstanceToPointInTimeRequest.Builder	storageType(String storageType)	Specifies the storage type to be associated with the DB instance.
RestoreDBInstanceToPointInTimeRequest.Builder	tags(Collection<Tag> tags)
RestoreDBInstanceToPointInTimeRequest.Builder	tags(Tag... tags)	NOTE: This method appends the values to the existing list (if any).
RestoreDBInstanceToPointInTimeRequest.Builder	targetDBInstanceIdentifier(String targetDBInstanceIdentifier)	The name of the new database instance to be created.
RestoreDBInstanceToPointInTimeRequest.Builder	tdeCredentialArn(String tdeCredentialArn)	The ARN from the Key Store with which to associate the instance for TDE encryption.
RestoreDBInstanceToPointInTimeRequest.Builder	tdeCredentialPassword(String tdeCredentialPassword)	The password for the given ARN from the Key Store in order to access the device.
RestoreDBInstanceToPointInTimeRequest.Builder	useLatestRestorableTime(Boolean useLatestRestorableTime)	Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

sourceDBInstanceIdentifier

RestoreDBInstanceToPointInTimeRequest.Builder sourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)

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

Constraints:

• Must be the identifier of an existing database instance

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

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

Constraints:

• Must be the identifier of an existing database instance

• Must contain from 1 to 63 alphanumeric characters 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.

targetDBInstanceIdentifier

RestoreDBInstanceToPointInTimeRequest.Builder targetDBInstanceIdentifier(String targetDBInstanceIdentifier)

The name of the new database instance to be created.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

targetDBInstanceIdentifier - The name of the new database instance to be created.

Constraints:

• Must contain from 1 to 63 alphanumeric characters 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.

restoreTime

RestoreDBInstanceToPointInTimeRequest.Builder restoreTime(Date restoreTime)

The date and time to restore from.

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

• Cannot be specified if UseLatestRestorableTime parameter is true

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

Parameters:

restoreTime - The date and time to restore from.

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

• Cannot be specified if UseLatestRestorableTime parameter is true

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 (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

Parameters:

useLatestRestorableTime - Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

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

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

Default: The same DBInstanceClass as the original DB instance.

Parameters:

dbInstanceClass - The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

Default: The same DBInstanceClass 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.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

Parameters:

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

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

Returns:

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

availabilityZone

RestoreDBInstanceToPointInTimeRequest.Builder availabilityZone(String availabilityZone)

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

Parameters:

availabilityZone - The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Parameters:

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

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Returns:

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

multiAZ

RestoreDBInstanceToPointInTimeRequest.Builder multiAZ(Boolean multiAZ)

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Parameters:

multiAZ - Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Returns:

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

publiclyAccessible

RestoreDBInstanceToPointInTimeRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Parameters:

publiclyAccessible - Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Returns:

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

autoMinorVersionUpgrade

RestoreDBInstanceToPointInTimeRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

Parameters:

autoMinorVersionUpgrade - Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

Returns:

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

licenseModel

RestoreDBInstanceToPointInTimeRequest.Builder licenseModel(String licenseModel)

License model information for the restored DB instance.

Default: Same as source.

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

Parameters:

licenseModel - License model information for the restored DB instance.

Default: Same as source.

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

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 is not used for the MySQL or MariaDB engines.

Parameters:

dbName - The database name for the restored DB instance.

This parameter is not used for the MySQL or MariaDB engines.

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.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

Parameters:

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

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

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 be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

Parameters:

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

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

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 be used for the restored DB instance.

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

Parameters:

optionGroupName - The name of the option group to be used for the restored DB instance.

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

Returns:

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

copyTagsToSnapshot

RestoreDBInstanceToPointInTimeRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

Parameters:

copyTagsToSnapshot - True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

Returns:

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

tags

RestoreDBInstanceToPointInTimeRequest.Builder tags(Collection<Tag> tags)

Parameters:

tags -

Returns:

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

tags

RestoreDBInstanceToPointInTimeRequest.Builder tags(Tag... tags)

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags -

Returns:

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

storageType

RestoreDBInstanceToPointInTimeRequest.Builder storageType(String storageType)

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

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

Parameters:

storageType - Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

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.

Parameters:

tdeCredentialArn - The ARN from the Key Store with which to associate the instance for TDE encryption.

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.

Parameters:

tdeCredentialPassword - The password for the given ARN from the Key Store in order to access the device.

Returns:

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

domain

RestoreDBInstanceToPointInTimeRequest.Builder domain(String domain)

Specify the Active Directory Domain to restore the instance in.

Parameters:

domain - Specify the Active Directory Domain to restore the instance in.

Returns:

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

domainIAMRoleName

RestoreDBInstanceToPointInTimeRequest.Builder domainIAMRoleName(String domainIAMRoleName)

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

Parameters:

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

Returns:

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

enableIAMDatabaseAuthentication

RestoreDBInstanceToPointInTimeRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

Parameters:

enableIAMDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

Returns:

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