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

Class RestoreDBInstanceFromDBSnapshotRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.RestoreDBInstanceFromDBSnapshotRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<RestoreDBInstanceFromDBSnapshotRequest.Builder,RestoreDBInstanceFromDBSnapshotRequest>

@Generated("software.amazon.awssdk:codegen")
public class RestoreDBInstanceFromDBSnapshotRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<RestoreDBInstanceFromDBSnapshotRequest.Builder,RestoreDBInstanceFromDBSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RestoreDBInstanceFromDBSnapshotRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
Boolean	autoMinorVersionUpgrade()	Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
String	availabilityZone()	The EC2 Availability Zone that the database instance will be created in.
static RestoreDBInstanceFromDBSnapshotRequest.Builder	builder()
Boolean	copyTagsToSnapshot()	True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false.
String	dbInstanceClass()	The compute and memory capacity of the Amazon RDS DB instance.
String	dbInstanceIdentifier()	Name of the DB instance to create from the DB snapshot.
String	dbName()	The database name for the restored DB instance.
String	dbSnapshotIdentifier()	The identifier for the DB snapshot to restore from.
String	dbSubnetGroupName()	The DB subnet group name to use for the new instance.
String	domain()	Specify the Active Directory Domain to restore the instance in.
String	domainIAMRoleName()	Specify the name of the IAM role to be used when making API calls to the Directory Service.
Boolean	enableIAMDatabaseAuthentication()	True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
String	engine()	The database engine to use for the new instance.
boolean	equals(Object obj)
int	hashCode()
Integer	iops()	Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.
String	licenseModel()	License model information for the restored DB instance.
Boolean	multiAZ()	Specifies if the DB instance is a Multi-AZ deployment.
String	optionGroupName()	The name of the option group to be used for the restored DB instance.
Integer	port()	The port number on which the database accepts connections.
Boolean	publiclyAccessible()	Specifies the accessibility options for the DB instance.
static Class<? extends RestoreDBInstanceFromDBSnapshotRequest.Builder>	serializableBuilderClass()
String	storageType()	Specifies the storage type to be associated with the DB instance.
List<Tag>	tags()
String	tdeCredentialArn()	The ARN from the Key Store with which to associate the instance for TDE encryption.
String	tdeCredentialPassword()	The password for the given ARN from the Key Store in order to access the device.
RestoreDBInstanceFromDBSnapshotRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dbInstanceIdentifier

public 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 alphanumeric characters or hyphens (1 to 15 for SQL Server)

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Returns:

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

dbSnapshotIdentifier

public String dbSnapshotIdentifier()

The identifier for the DB snapshot to restore from.

Constraints:

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

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

Returns:

The identifier for the DB snapshot to restore from.

Constraints:

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

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

dbInstanceClass

public 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

Returns:

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

port

public 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

Returns:

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

availabilityZone

public 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

Returns:

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

dbSubnetGroupName

public 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

Returns:

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

multiAZ

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

Returns:

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.

publiclyAccessible

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

Returns:

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.

autoMinorVersionUpgrade

public Boolean autoMinorVersionUpgrade()

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

Returns:

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

licenseModel

public 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

Returns:

License model information for the restored DB instance.

Default: Same as source.

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

dbName

public String dbName()

The database name for the restored DB instance.

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

Returns:

The database name for the restored DB instance.

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

engine

public 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: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

Returns:

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: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

iops

public 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 will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

SQL Server

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

Returns:

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 will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

SQL Server

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

optionGroupName

public 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

Returns:

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

tags

public List<Tag> tags()

Returns:

storageType

public 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

Returns:

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

tdeCredentialArn

public String tdeCredentialArn()

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

Returns:

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

tdeCredentialPassword

public String tdeCredentialPassword()

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

Returns:

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

domain

public String domain()

Specify the Active Directory Domain to restore the instance in.

Returns:

Specify the Active Directory Domain to restore the instance in.

copyTagsToSnapshot

public Boolean copyTagsToSnapshot()

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

Returns:

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

domainIAMRoleName

public String domainIAMRoleName()

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

Returns:

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

enableIAMDatabaseAuthentication

public 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

Returns:

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

toBuilder

public RestoreDBInstanceFromDBSnapshotRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RestoreDBInstanceFromDBSnapshotRequest.Builder,RestoreDBInstanceFromDBSnapshotRequest>

Returns:

a builder for type T

builder

public static RestoreDBInstanceFromDBSnapshotRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RestoreDBInstanceFromDBSnapshotRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object