software.amazon.awssdk.services.rds.model

Interface RestoreDbInstanceFromDbSnapshotRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>, RdsRequest.Builder, SdkBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>, SdkRequest.Builder

Enclosing class:

RestoreDbInstanceFromDbSnapshotRequest

public static interface RestoreDbInstanceFromDbSnapshotRequest.Builder
extends RdsRequest.Builder, CopyableBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>

Method Summary

Modifier and Type	Method and Description
RestoreDbInstanceFromDbSnapshotRequest.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
RestoreDbInstanceFromDbSnapshotRequest.Builder	availabilityZone(String availabilityZone) The EC2 Availability Zone that the DB instance is created in.
RestoreDbInstanceFromDbSnapshotRequest.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot) True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false.
RestoreDbInstanceFromDbSnapshotRequest.Builder	dbInstanceClass(String dbInstanceClass) The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.
RestoreDbInstanceFromDbSnapshotRequest.Builder	dbInstanceIdentifier(String dbInstanceIdentifier) Name of the DB instance to create from the DB snapshot.
RestoreDbInstanceFromDbSnapshotRequest.Builder	dbName(String dbName) The database name for the restored DB instance.
RestoreDbInstanceFromDbSnapshotRequest.Builder	dbSnapshotIdentifier(String dbSnapshotIdentifier) The identifier for the DB snapshot to restore from.
RestoreDbInstanceFromDbSnapshotRequest.Builder	dbSubnetGroupName(String dbSubnetGroupName) The DB subnet group name to use for the new instance.
RestoreDbInstanceFromDbSnapshotRequest.Builder	domain(String domain) Specify the Active Directory Domain to restore the instance in.
RestoreDbInstanceFromDbSnapshotRequest.Builder	domainIAMRoleName(String domainIAMRoleName) Specify the name of the IAM role to be used when making API calls to the Directory Service.
RestoreDbInstanceFromDbSnapshotRequest.Builder	enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
RestoreDbInstanceFromDbSnapshotRequest.Builder	engine(String engine) The database engine to use for the new instance.
RestoreDbInstanceFromDbSnapshotRequest.Builder	iops(Integer iops) Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.
RestoreDbInstanceFromDbSnapshotRequest.Builder	licenseModel(String licenseModel) License model information for the restored DB instance.
RestoreDbInstanceFromDbSnapshotRequest.Builder	multiAZ(Boolean multiAZ) Specifies if the DB instance is a Multi-AZ deployment.
RestoreDbInstanceFromDbSnapshotRequest.Builder	optionGroupName(String optionGroupName) The name of the option group to be used for the restored DB instance.
RestoreDbInstanceFromDbSnapshotRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
RestoreDbInstanceFromDbSnapshotRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
RestoreDbInstanceFromDbSnapshotRequest.Builder	port(Integer port) The port number on which the database accepts connections.
RestoreDbInstanceFromDbSnapshotRequest.Builder	publiclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for the DB instance.
RestoreDbInstanceFromDbSnapshotRequest.Builder	storageType(String storageType) Specifies the storage type to be associated with the DB instance.
RestoreDbInstanceFromDbSnapshotRequest.Builder	tags(Collection<Tag> tags) Sets the value of the Tags property for this object.
RestoreDbInstanceFromDbSnapshotRequest.Builder	tags(Consumer<Tag.Builder>... tags) Sets the value of the Tags property for this object.
RestoreDbInstanceFromDbSnapshotRequest.Builder	tags(Tag... tags) Sets the value of the Tags property for this object.
RestoreDbInstanceFromDbSnapshotRequest.Builder	tdeCredentialArn(String tdeCredentialArn) The ARN from the key store with which to associate the instance for TDE encryption.
RestoreDbInstanceFromDbSnapshotRequest.Builder	tdeCredentialPassword(String tdeCredentialPassword) The password for the given ARN from the key store in order to access the device.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

Method Detail

dbInstanceIdentifier

RestoreDbInstanceFromDbSnapshotRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

• Must contain from 1 to 63 numbers, letters, or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Parameters:

dbInstanceIdentifier - Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

• Must contain from 1 to 63 numbers, letters, or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Returns:

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

dbSnapshotIdentifier

RestoreDbInstanceFromDbSnapshotRequest.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier)

The identifier for the DB snapshot to restore from.

Constraints:

• Must match the identifier of an existing DBSnapshot.

• If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Parameters:

dbSnapshotIdentifier - The identifier for the DB snapshot to restore from.

Constraints:

• Must match the identifier of an existing DBSnapshot.

• If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Returns:

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

dbInstanceClass

RestoreDbInstanceFromDbSnapshotRequest.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 AWS 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 DBInstanceClass 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 AWS 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 DBInstanceClass as the original DB instance.

Returns:

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

port

RestoreDbInstanceFromDbSnapshotRequest.Builder port(Integer port)

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: 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: Value must be 1150-65535

Returns:

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

availabilityZone

RestoreDbInstanceFromDbSnapshotRequest.Builder availabilityZone(String availabilityZone)

The EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

Parameters:

availabilityZone - The EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone.

Constraint: You can't 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

RestoreDbInstanceFromDbSnapshotRequest.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 DBSubnetGroup.

Example: mySubnetgroup

Parameters:

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

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

Example: mySubnetgroup

Returns:

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

multiAZ

RestoreDbInstanceFromDbSnapshotRequest.Builder multiAZ(Boolean multiAZ)

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

Constraint: You can't 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 can't 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

RestoreDbInstanceFromDbSnapshotRequest.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 is 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 is 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 is 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 is private.

Returns:

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

autoMinorVersionUpgrade

RestoreDbInstanceFromDbSnapshotRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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

Parameters:

autoMinorVersionUpgrade - Indicates that minor version upgrades are 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

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

RestoreDbInstanceFromDbSnapshotRequest.Builder dbName(String dbName)

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Parameters:

dbName - The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Returns:

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

engine

RestoreDbInstanceFromDbSnapshotRequest.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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

• aurora

• aurora-postgresql

• mariadb

• mysql

• oracle-ee

• oracle-se2

• oracle-se1

• oracle-se

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

• aurora

• aurora-postgresql

• mariadb

• mysql

• oracle-ee

• oracle-se2

• oracle-se1

• oracle-se

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Returns:

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

iops

RestoreDbInstanceFromDbSnapshotRequest.Builder iops(Integer iops)

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.

Constraints: Must be an integer greater than 1000.

Parameters:

iops - Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.

Constraints: Must be an integer greater than 1000.

Returns:

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

optionGroupName

RestoreDbInstanceFromDbSnapshotRequest.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, can't be removed from an option group, and that option group can't 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, can't be removed from an option group, and that option group can't 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.

tags

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

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

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

Sets the value of the Tags property for this object. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

storageType

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

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

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

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

copyTagsToSnapshot

RestoreDbInstanceFromDbSnapshotRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

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

Parameters:

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

Returns:

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

domainIAMRoleName

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

RestoreDbInstanceFromDbSnapshotRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and 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, and 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.

overrideConfiguration

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

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