public class RestoreDBInstanceFromDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable
RestoreDBInstanceFromDBSnapshot operation
.
Creates a new DB Instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
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 |
---|---|
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.
|
String |
getDBInstanceClass()
The compute and memory capacity of the Amazon RDS DB instance.
|
String |
getDBInstanceIdentifier()
The identifier for the DB Snapshot to restore from.
|
String |
getDBName()
The database name for the restored DB Instance.
|
String |
getDBSnapshotIdentifier()
Name of the DB Instance to create from the DB Snapshot.
|
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.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to
the DB Instance during the maintenance window.
|
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 |
setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance.
|
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
The identifier for the DB Snapshot to restore from.
|
void |
setDBName(String dBName)
The database name for the restored DB Instance.
|
void |
setDBSnapshotIdentifier(String dBSnapshotIdentifier)
Name of the DB Instance to create from the DB Snapshot.
|
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.
|
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 |
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withDBInstanceIdentifier(String dBInstanceIdentifier)
The identifier for the DB Snapshot to restore from.
|
RestoreDBInstanceFromDBSnapshotRequest |
withDBName(String dBName)
The database name for the restored DB Instance.
|
RestoreDBInstanceFromDBSnapshotRequest |
withDBSnapshotIdentifier(String dBSnapshotIdentifier)
Name of the DB Instance to create from the DB Snapshot.
|
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.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
public RestoreDBInstanceFromDBSnapshotRequest()
public RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier, String dBSnapshotIdentifier)
dBInstanceIdentifier
- The identifier for the DB Snapshot to
restore from. Constraints:
dBSnapshotIdentifier
- Name of the DB Instance to create from the
DB Snapshot. This parameter isn't case sensitive. Constraints:
Example:
my-snapshot-id
public String getDBInstanceIdentifier()
Constraints:
Constraints:
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Constraints:
dBInstanceIdentifier
- The identifier for the DB Snapshot to restore from. Constraints:
public RestoreDBInstanceFromDBSnapshotRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
Constraints:
Returns a reference to this object so that method calls can be chained together.
dBInstanceIdentifier
- The identifier for the DB Snapshot to restore from. Constraints:
public String getDBSnapshotIdentifier()
Constraints:
Example: my-snapshot-id
Constraints:
Example: my-snapshot-id
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
Constraints:
Example: my-snapshot-id
dBSnapshotIdentifier
- Name of the DB Instance to create from the DB Snapshot. This parameter
isn't case sensitive. Constraints:
Example: my-snapshot-id
public RestoreDBInstanceFromDBSnapshotRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)
Constraints:
Example: my-snapshot-id
Returns a reference to this object so that method calls can be chained together.
dBSnapshotIdentifier
- Name of the DB Instance to create from the DB Snapshot. This parameter
isn't case sensitive. Constraints:
Example: my-snapshot-id
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
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
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
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
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
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
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 engine.
This parameter doesn't apply to the MySQL engine.
public void setDBName(String dBName)
This parameter doesn't apply to the MySQL engine.
dBName
- The database name for the restored DB Instance. This parameter doesn't apply to the MySQL engine.
public RestoreDBInstanceFromDBSnapshotRequest withDBName(String dBName)
This parameter doesn't apply to the MySQL engine.
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 engine.
public String getEngine()
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
public void setEngine(String engine)
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
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
Example: oracle-ee
public RestoreDBInstanceFromDBSnapshotRequest withEngine(String engine)
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
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
Example: oracle-ee
public Integer getIops()
Constraints: Must be an integer greater than 1000.
Constraints: Must be an integer greater than 1000.
public void setIops(Integer iops)
Constraints: Must be an integer greater than 1000.
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.
public RestoreDBInstanceFromDBSnapshotRequest withIops(Integer iops)
Constraints: Must be an integer greater than 1000.
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.
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 String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.