|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.rds.model.RestoreDBInstanceToPointInTimeRequest
public class RestoreDBInstanceToPointInTimeRequest
Container for the parameters to the RestoreDBInstanceToPointInTime operation
.
Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.
AmazonRDS.restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest)
Constructor Summary | |
---|---|
RestoreDBInstanceToPointInTimeRequest()
Default constructor for a new RestoreDBInstanceToPointInTimeRequest object. |
|
RestoreDBInstanceToPointInTimeRequest(String sourceDBInstanceIdentifier,
String targetDBInstanceIdentifier)
Constructs a new RestoreDBInstanceToPointInTimeRequest object. |
Method Summary | |
---|---|
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 |
getDBName()
The database name for the restored DB Instance. |
String |
getDBSubnetGroupName()
The DB subnet group name to use for the new instance. |
String |
getEngine()
The database engine to use for the new instance. |
String |
getLicenseModel()
License model information for the restored DB Instance. |
Boolean |
getMultiAZ()
Specifies if the DB Instance is a Multi-AZ deployment. |
Integer |
getPort()
The port number on which the database accepts connections. |
Date |
getRestoreTime()
The date and time to restore from. |
String |
getSourceDBInstanceIdentifier()
The identifier of the source DB Instance from which to restore. |
String |
getTargetDBInstanceIdentifier()
The name of the new database instance to be created. |
Boolean |
getUseLatestRestorableTime()
Specifies whether ( true ) or not (false ) the
DB Instance is restored from the latest backup time. |
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 |
isUseLatestRestorableTime()
Specifies whether ( true ) or not (false ) the
DB Instance is restored from the latest backup time. |
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 |
setDBName(String dBName)
The database name for the restored DB Instance. |
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 |
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 |
setPort(Integer port)
The port number on which the database accepts connections. |
void |
setRestoreTime(Date restoreTime)
The date and time to restore from. |
void |
setSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the source DB Instance from which to restore. |
void |
setTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)
The name of the new database instance to be created. |
void |
setUseLatestRestorableTime(Boolean useLatestRestorableTime)
Specifies whether ( true ) or not (false ) the
DB Instance is restored from the latest backup time. |
String |
toString()
Returns a string representation of this object; useful for testing and debugging. |
RestoreDBInstanceToPointInTimeRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. |
RestoreDBInstanceToPointInTimeRequest |
withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be created in. |
RestoreDBInstanceToPointInTimeRequest |
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance. |
RestoreDBInstanceToPointInTimeRequest |
withDBName(String dBName)
The database name for the restored DB Instance. |
RestoreDBInstanceToPointInTimeRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance. |
RestoreDBInstanceToPointInTimeRequest |
withEngine(String engine)
The database engine to use for the new instance. |
RestoreDBInstanceToPointInTimeRequest |
withLicenseModel(String licenseModel)
License model information for the restored DB Instance. |
RestoreDBInstanceToPointInTimeRequest |
withMultiAZ(Boolean multiAZ)
Specifies if the DB Instance is a Multi-AZ deployment. |
RestoreDBInstanceToPointInTimeRequest |
withPort(Integer port)
The port number on which the database accepts connections. |
RestoreDBInstanceToPointInTimeRequest |
withRestoreTime(Date restoreTime)
The date and time to restore from. |
RestoreDBInstanceToPointInTimeRequest |
withSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the source DB Instance from which to restore. |
RestoreDBInstanceToPointInTimeRequest |
withTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)
The name of the new database instance to be created. |
RestoreDBInstanceToPointInTimeRequest |
withUseLatestRestorableTime(Boolean useLatestRestorableTime)
Specifies whether ( true ) or not (false ) the
DB Instance is restored from the latest backup time. |
Methods inherited from class com.amazonaws.AmazonWebServiceRequest |
---|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RestoreDBInstanceToPointInTimeRequest()
public RestoreDBInstanceToPointInTimeRequest(String sourceDBInstanceIdentifier, String targetDBInstanceIdentifier)
sourceDBInstanceIdentifier
- The identifier of the source DB
Instance from which to restore. Constraints:
targetDBInstanceIdentifier
- The name of the new database
instance to be created. Constraints:
Method Detail |
---|
public String getSourceDBInstanceIdentifier()
Constraints:
Constraints:
public void setSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
Constraints:
sourceDBInstanceIdentifier
- The identifier of the source DB Instance from which to restore.
Constraints:
public RestoreDBInstanceToPointInTimeRequest withSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
Constraints:
Returns a reference to this object so that method calls can be chained together.
sourceDBInstanceIdentifier
- The identifier of the source DB Instance from which to restore.
Constraints:
public String getTargetDBInstanceIdentifier()
Constraints:
Constraints:
public void setTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)
Constraints:
targetDBInstanceIdentifier
- The name of the new database instance to be created. Constraints:
public RestoreDBInstanceToPointInTimeRequest withTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)
Constraints:
Returns a reference to this object so that method calls can be chained together.
targetDBInstanceIdentifier
- The name of the new database instance to be created. Constraints:
public Date getRestoreTime()
Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
public void setRestoreTime(Date restoreTime)
Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
restoreTime
- The date and time to restore from. Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
public RestoreDBInstanceToPointInTimeRequest withRestoreTime(Date restoreTime)
Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
Returns a reference to this object so that method calls can be chained together.
restoreTime
- The date and time to restore from. Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
public Boolean isUseLatestRestorableTime()
true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
public void setUseLatestRestorableTime(Boolean useLatestRestorableTime)
true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
useLatestRestorableTime
- Specifies whether (true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
public RestoreDBInstanceToPointInTimeRequest withUseLatestRestorableTime(Boolean useLatestRestorableTime)
true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
Returns a reference to this object so that method calls can be chained together.
useLatestRestorableTime
- Specifies whether (true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
public Boolean getUseLatestRestorableTime()
true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
public String getDBInstanceClass()
Valid Values: db.m1.small | db.m1.large | db.m1.xlarge |
db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
Valid Values: db.m1.small | db.m1.large | db.m1.xlarge |
db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
public void setDBInstanceClass(String dBInstanceClass)
Valid Values: db.m1.small | db.m1.large | db.m1.xlarge |
db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
dBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.m1.small | db.m1.large | db.m1.xlarge |
db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
public RestoreDBInstanceToPointInTimeRequest withDBInstanceClass(String dBInstanceClass)
Valid Values: db.m1.small | db.m1.large | db.m1.xlarge |
db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
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.m1.small | db.m1.large | db.m1.xlarge |
db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
public Integer getPort()
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
public void setPort(Integer port)
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
port
- The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
public RestoreDBInstanceToPointInTimeRequest withPort(Integer port)
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
Returns a reference to this object so that method calls can be chained together.
port
- The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
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 RestoreDBInstanceToPointInTimeRequest 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 RestoreDBInstanceToPointInTimeRequest 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 RestoreDBInstanceToPointInTimeRequest 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 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 RestoreDBInstanceToPointInTimeRequest 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 RestoreDBInstanceToPointInTimeRequest 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 is not used for the MySQL engine.
This parameter is not used for the MySQL engine.
public void setDBName(String dBName)
This parameter is not used for the MySQL engine.
dBName
- The database name for the restored DB Instance. This parameter is not used for the MySQL engine.
public RestoreDBInstanceToPointInTimeRequest withDBName(String dBName)
This parameter is not used for 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 is not used for 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 RestoreDBInstanceToPointInTimeRequest 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 String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |