com.amazonaws.services.rds.model
Class RestoreDBInstanceFromDBSnapshotRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.rds.model.RestoreDBInstanceFromDBSnapshotRequest

public class RestoreDBInstanceFromDBSnapshotRequest
extends AmazonWebServiceRequest

Container for the parameters to the RestoreDBInstanceFromDBSnapshot operation.

This API creates a new 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.

See Also:

AmazonRDS.restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest)

Constructor Summary

RestoreDBInstanceFromDBSnapshotRequest()
Default constructor for a new RestoreDBInstanceFromDBSnapshotRequest object.

RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier, String dBSnapshotIdentifier)
Constructs a new RestoreDBInstanceFromDBSnapshotRequest object.

Method Summary

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	getDBSnapshotIdentifier() Name of the DB Instance to create from the DB Snapshot.
Boolean	getMultiAZ() Specifies if the DB Instance is a Multi-AZ deployment.
Integer	getPort() The port number on which the database accepts connections.
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.
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	setDBSnapshotIdentifier(String dBSnapshotIdentifier) Name of the DB Instance to create from the DB Snapshot.
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.
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	withDBSnapshotIdentifier(String dBSnapshotIdentifier) Name of the DB Instance to create from the DB Snapshot.
RestoreDBInstanceFromDBSnapshotRequest	withMultiAZ(Boolean multiAZ) Specifies if the DB Instance is a Multi-AZ deployment.
RestoreDBInstanceFromDBSnapshotRequest	withPort(Integer port) The port number on which the database accepts connections.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreDBInstanceFromDBSnapshotRequest

public RestoreDBInstanceFromDBSnapshotRequest()

Default constructor for a new RestoreDBInstanceFromDBSnapshotRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

RestoreDBInstanceFromDBSnapshotRequest

public RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier,
                                              String dBSnapshotIdentifier)

Constructs a new RestoreDBInstanceFromDBSnapshotRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

dBInstanceIdentifier - The identifier for the DB Snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

dBSnapshotIdentifier - Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

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

Example: my-snapshot-id

Method Detail

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

The identifier for the DB Snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

The identifier for the DB Snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

setDBInstanceIdentifier

public void setDBInstanceIdentifier(String dBInstanceIdentifier)

The identifier for the DB Snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

dBInstanceIdentifier - The identifier for the DB Snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

withDBInstanceIdentifier

public RestoreDBInstanceFromDBSnapshotRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

The identifier for the DB Snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

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

Parameters:

dBInstanceIdentifier - The identifier for the DB Snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

A reference to this updated object so that method calls can be chained together.

getDBSnapshotIdentifier

public String getDBSnapshotIdentifier()

Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

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

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 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

setDBSnapshotIdentifier

public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)

Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

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

Example: my-snapshot-id

Parameters:

dBSnapshotIdentifier - Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

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

Example: my-snapshot-id

withDBSnapshotIdentifier

public RestoreDBInstanceFromDBSnapshotRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)

Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

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

Example: my-snapshot-id

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

Parameters:

dBSnapshotIdentifier - Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

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

Example: my-snapshot-id

Returns:

A reference to this updated object so that method calls can be chained together.

getDBInstanceClass

public String getDBInstanceClass()

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

Returns:

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

setDBInstanceClass

public void setDBInstanceClass(String 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

Parameters:

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

withDBInstanceClass

public RestoreDBInstanceFromDBSnapshotRequest withDBInstanceClass(String 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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getPort

public Integer getPort()

The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1115-65535

Returns:

The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1115-65535

setPort

public void setPort(Integer port)

The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1115-65535

Parameters:

port - The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1115-65535

withPort

public RestoreDBInstanceFromDBSnapshotRequest withPort(Integer port)

The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1115-65535

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

Parameters:

port - The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1115-65535

Returns:

A reference to this updated object so that method calls can be chained together.

getAvailabilityZone

public String getAvailabilityZone()

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

setAvailabilityZone

public void setAvailabilityZone(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

Parameters:

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

withAvailabilityZone

public RestoreDBInstanceFromDBSnapshotRequest withAvailabilityZone(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

isMultiAZ

public Boolean isMultiAZ()

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.

setMultiAZ

public void setMultiAZ(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.

Parameters:

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.

withMultiAZ

public RestoreDBInstanceFromDBSnapshotRequest withMultiAZ(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getMultiAZ

public Boolean getMultiAZ()

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.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

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.

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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

Parameters:

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

withAutoMinorVersionUpgrade

public RestoreDBInstanceFromDBSnapshotRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()