public class RestoreDBInstanceFromDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
RestoreDBInstanceFromDBSnapshot operation
.
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
NOOP
Constructor and Description |
---|
RestoreDBInstanceFromDBSnapshotRequest()
Default constructor for a new RestoreDBInstanceFromDBSnapshotRequest object.
|
RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier,
String dBSnapshotIdentifier)
Constructs a new RestoreDBInstanceFromDBSnapshotRequest object.
|
Modifier and Type | Method and Description |
---|---|
RestoreDBInstanceFromDBSnapshotRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
Boolean |
getAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.
|
String |
getAvailabilityZone()
The EC2 Availability Zone that the database instance will be created
in.
|
Boolean |
getCopyTagsToSnapshot()
True to copy all tags from the restored DB instance to snapshots of
the DB instance; otherwise false.
|
String |
getDBInstanceClass()
The compute and memory capacity of the Amazon RDS DB instance.
|
String |
getDBInstanceIdentifier()
Name of the DB instance to create from the DB snapshot.
|
String |
getDBName()
The database name for the restored DB instance.
|
String |
getDBSnapshotIdentifier()
The identifier for the DB snapshot to restore from.
|
String |
getDBSubnetGroupName()
The DB subnet group name to use for the new instance.
|
String |
getEngine()
The database engine to use for the new instance.
|
Integer |
getIops()
Specifies the amount of provisioned IOPS for the DB instance,
expressed in I/O operations per second.
|
String |
getLicenseModel()
License model information for the restored DB instance.
|
Boolean |
getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
String |
getOptionGroupName()
The name of the option group to be used for the restored DB instance.
|
Integer |
getPort()
The port number on which the database accepts connections.
|
Boolean |
getPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
String |
getStorageType()
Specifies the storage type to be associated with the DB instance.
|
List<Tag> |
getTags()
A list of tags.
|
String |
getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for
TDE encryption.
|
String |
getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access
the device.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.
|
Boolean |
isCopyTagsToSnapshot()
True to copy all tags from the restored DB instance to snapshots of
the DB instance; otherwise false.
|
Boolean |
isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.
|
void |
setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be created
in.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the restored DB instance to snapshots of
the DB instance; otherwise false.
|
void |
setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance.
|
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
Name of the DB instance to create from the DB snapshot.
|
void |
setDBName(String dBName)
The database name for the restored DB instance.
|
void |
setDBSnapshotIdentifier(String dBSnapshotIdentifier)
The identifier for the DB snapshot to restore from.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
|
void |
setEngine(String engine)
The database engine to use for the new instance.
|
void |
setIops(Integer iops)
Specifies the amount of provisioned IOPS for the DB instance,
expressed in I/O operations per second.
|
void |
setLicenseModel(String licenseModel)
License model information for the restored DB instance.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
void |
setOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
|
void |
setPort(Integer port)
The port number on which the database accepts connections.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
void |
setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
void |
setTags(Collection<Tag> tags)
A list of tags.
|
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for
TDE encryption.
|
void |
setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access
the device.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RestoreDBInstanceFromDBSnapshotRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.
|
RestoreDBInstanceFromDBSnapshotRequest |
withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be created
in.
|
RestoreDBInstanceFromDBSnapshotRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the restored DB instance to snapshots of
the DB instance; otherwise false.
|
RestoreDBInstanceFromDBSnapshotRequest |
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withDBInstanceIdentifier(String dBInstanceIdentifier)
Name of the DB instance to create from the DB snapshot.
|
RestoreDBInstanceFromDBSnapshotRequest |
withDBName(String dBName)
The database name for the restored DB instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withDBSnapshotIdentifier(String dBSnapshotIdentifier)
The identifier for the DB snapshot to restore from.
|
RestoreDBInstanceFromDBSnapshotRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withEngine(String engine)
The database engine to use for the new instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withIops(Integer iops)
Specifies the amount of provisioned IOPS for the DB instance,
expressed in I/O operations per second.
|
RestoreDBInstanceFromDBSnapshotRequest |
withLicenseModel(String licenseModel)
License model information for the restored DB instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
RestoreDBInstanceFromDBSnapshotRequest |
withOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withPort(Integer port)
The port number on which the database accepts connections.
|
RestoreDBInstanceFromDBSnapshotRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withTags(Collection<Tag> tags)
A list of tags.
|
RestoreDBInstanceFromDBSnapshotRequest |
withTags(Tag... tags)
A list of tags.
|
RestoreDBInstanceFromDBSnapshotRequest |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for
TDE encryption.
|
RestoreDBInstanceFromDBSnapshotRequest |
withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access
the device.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public RestoreDBInstanceFromDBSnapshotRequest()
public RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier, String dBSnapshotIdentifier)
dBInstanceIdentifier
- Name of the DB instance to create from the
DB snapshot. This parameter isn't case-sensitive. Constraints:
Example: my-snapshot-id
dBSnapshotIdentifier
- The identifier for the DB snapshot to
restore from. Constraints:
If you are restoring from a shared manual DB
snapshot, the DBSnapshotIdentifier
must be the ARN of the
shared DB snapshot.
public String getDBInstanceIdentifier()
Constraints:
Example:
my-snapshot-id
Constraints:
Example:
my-snapshot-id
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Constraints:
Example:
my-snapshot-id
dBInstanceIdentifier
- Name of the DB instance to create from the DB snapshot. This parameter
isn't case-sensitive. Constraints:
Example:
my-snapshot-id
public RestoreDBInstanceFromDBSnapshotRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
Constraints:
Example:
my-snapshot-id
Returns a reference to this object so that method calls can be chained together.
dBInstanceIdentifier
- Name of the DB instance to create from the DB snapshot. This parameter
isn't case-sensitive. Constraints:
Example:
my-snapshot-id
public String getDBSnapshotIdentifier()
Constraints:
If you
are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
Constraints:
If you
are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
Constraints:
If you
are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
dBSnapshotIdentifier
- The identifier for the DB snapshot to restore from. Constraints:
If you
are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
public RestoreDBInstanceFromDBSnapshotRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)
Constraints:
If you
are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
Returns a reference to this object so that method calls can be chained together.
dBSnapshotIdentifier
- The identifier for the DB snapshot to restore from. Constraints:
If you
are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
public String getDBInstanceClass()
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
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
public void setDBInstanceClass(String dBInstanceClass)
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
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
public RestoreDBInstanceFromDBSnapshotRequest withDBInstanceClass(String dBInstanceClass)
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 a reference to this object so that method calls can be chained together.
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
public Integer getPort()
Default: The same port as the original DB instance
Constraints: Value must
be 1150-65535
Default: The same port as the original DB instance
Constraints: Value must
be 1150-65535
public void setPort(Integer port)
Default: The same port as the original DB instance
Constraints: Value must
be 1150-65535
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
public RestoreDBInstanceFromDBSnapshotRequest withPort(Integer port)
Default: The same port as the original DB instance
Constraints: Value must
be 1150-65535
Returns a reference to this object so that method calls can be chained together.
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
public String getAvailabilityZone()
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
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
public void setAvailabilityZone(String availabilityZone)
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
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
public RestoreDBInstanceFromDBSnapshotRequest withAvailabilityZone(String availabilityZone)
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 a reference to this object so that method calls can be chained together.
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
public String getDBSubnetGroupName()
public void setDBSubnetGroupName(String dBSubnetGroupName)
dBSubnetGroupName
- The DB subnet group name to use for the new instance.public RestoreDBInstanceFromDBSnapshotRequest withDBSubnetGroupName(String dBSubnetGroupName)
Returns a reference to this object so that method calls can be chained together.
dBSubnetGroupName
- The DB subnet group name to use for the new instance.public Boolean isMultiAZ()
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
public void setMultiAZ(Boolean multiAZ)
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
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
.
public RestoreDBInstanceFromDBSnapshotRequest withMultiAZ(Boolean multiAZ)
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
Returns a reference to this object so that method calls can be chained together.
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
.
public Boolean getMultiAZ()
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
public Boolean isPubliclyAccessible()
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.
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.
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.
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.
public void setPubliclyAccessible(Boolean publiclyAccessible)
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.
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.
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.
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.
public RestoreDBInstanceFromDBSnapshotRequest withPubliclyAccessible(Boolean publiclyAccessible)
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.
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 a reference to this object so that method calls can be chained together.
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.
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.
public Boolean getPubliclyAccessible()
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.
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.
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.
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.
public Boolean isAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
autoMinorVersionUpgrade
- Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.public RestoreDBInstanceFromDBSnapshotRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.public Boolean getAutoMinorVersionUpgrade()
public String getLicenseModel()
Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
public void setLicenseModel(String licenseModel)
Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
licenseModel
- License model information for the restored DB instance. Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
public RestoreDBInstanceFromDBSnapshotRequest withLicenseModel(String licenseModel)
Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
Returns a reference to this object so that method calls can be chained together.
licenseModel
- License model information for the restored DB instance. Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
public String getDBName()
This parameter doesn't apply to the MySQL or MariaDB engines.
This parameter doesn't apply to the MySQL or MariaDB engines.
public void setDBName(String dBName)
This parameter doesn't apply to the MySQL or MariaDB engines.
dBName
- The database name for the restored DB instance. This parameter doesn't apply to the MySQL or MariaDB engines.
public RestoreDBInstanceFromDBSnapshotRequest withDBName(String dBName)
This parameter doesn't apply to the MySQL or MariaDB engines.
Returns a reference to this object so that method calls can be chained together.
dBName
- The database name for the restored DB instance. This parameter doesn't apply to the MySQL or MariaDB engines.
public String getEngine()
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
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
public void setEngine(String engine)
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
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
public RestoreDBInstanceFromDBSnapshotRequest withEngine(String engine)
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 a reference to this object so that method calls can be chained together.
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
public Integer getIops()
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
public void setIops(Integer iops)
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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.
public RestoreDBInstanceFromDBSnapshotRequest withIops(Integer iops)
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Returns a reference to this object so that method calls can be chained together.
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.
public String getOptionGroupName()
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
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
public void setOptionGroupName(String optionGroupName)
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
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
public RestoreDBInstanceFromDBSnapshotRequest withOptionGroupName(String optionGroupName)
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 a reference to this object so that method calls can be chained together.
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
public void setTags(Collection<Tag> tags)
tags
- A list of tags.public RestoreDBInstanceFromDBSnapshotRequest withTags(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.
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags.public RestoreDBInstanceFromDBSnapshotRequest withTags(Collection<Tag> tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags.public String getStorageType()
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
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
public void setStorageType(String storageType)
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
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
public RestoreDBInstanceFromDBSnapshotRequest withStorageType(String storageType)
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 a reference to this object so that method calls can be chained together.
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
public String getTdeCredentialArn()
public void setTdeCredentialArn(String tdeCredentialArn)
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for
TDE encryption.public RestoreDBInstanceFromDBSnapshotRequest withTdeCredentialArn(String tdeCredentialArn)
Returns a reference to this object so that method calls can be chained together.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for
TDE encryption.public String getTdeCredentialPassword()
public void setTdeCredentialPassword(String tdeCredentialPassword)
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access
the device.public RestoreDBInstanceFromDBSnapshotRequest withTdeCredentialPassword(String tdeCredentialPassword)
Returns a reference to this object so that method calls can be chained together.
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access
the device.public Boolean isCopyTagsToSnapshot()
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
copyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of
the DB instance; otherwise false. The default is false.public RestoreDBInstanceFromDBSnapshotRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Returns a reference to this object so that method calls can be chained together.
copyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of
the DB instance; otherwise false. The default is false.public Boolean getCopyTagsToSnapshot()
public String toString()
toString
in class Object
Object.toString()
public RestoreDBInstanceFromDBSnapshotRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2015. All rights reserved.