com.amazonaws.services.rds.model
Class CreateDBInstanceReadReplicaRequest

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

public class CreateDBInstanceReadReplicaRequest
extends AmazonWebServiceRequest

Container for the parameters to the CreateDBInstanceReadReplica operation.

Creates a DB Instance that acts as a Read Replica of a source DB Instance.

All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except as specified below.

IMPORTANT: The source DB Instance must have backup retention enabled.

See Also:

AmazonRDS.createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest)

Constructor Summary

CreateDBInstanceReadReplicaRequest()
Default constructor for a new CreateDBInstanceReadReplicaRequest object.

CreateDBInstanceReadReplicaRequest(java.lang.String dBInstanceIdentifier, java.lang.String sourceDBInstanceIdentifier)
Constructs a new CreateDBInstanceReadReplicaRequest object.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.Boolean	getAutoMinorVersionUpgrade() Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
java.lang.String	getAvailabilityZone() The Amazon EC2 Availability Zone that the Read Replica will be created in.
java.lang.String	getDBInstanceClass() The compute and memory capacity of the Read Replica.
java.lang.String	getDBInstanceIdentifier() The DB Instance identifier of the Read Replica.
java.lang.Integer	getIops() The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
java.lang.String	getOptionGroupName() The option group the DB instance will be associated with.
java.lang.Integer	getPort() The port number that the DB Instance uses for connections.
java.lang.Boolean	getPubliclyAccessible() Returns the value of the PubliclyAccessible property for this object.
java.lang.String	getSourceDBInstanceIdentifier() The identifier of the DB Instance that will act as the source for the Read Replica.
int	hashCode()
java.lang.Boolean	isAutoMinorVersionUpgrade() Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
java.lang.Boolean	isPubliclyAccessible() Returns the value of the PubliclyAccessible property for this object.
void	setAutoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade) Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
void	setAvailabilityZone(java.lang.String availabilityZone) The Amazon EC2 Availability Zone that the Read Replica will be created in.
void	setDBInstanceClass(java.lang.String dBInstanceClass) The compute and memory capacity of the Read Replica.
void	setDBInstanceIdentifier(java.lang.String dBInstanceIdentifier) The DB Instance identifier of the Read Replica.
void	setIops(java.lang.Integer iops) The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
void	setOptionGroupName(java.lang.String optionGroupName) The option group the DB instance will be associated with.
void	setPort(java.lang.Integer port) The port number that the DB Instance uses for connections.
void	setPubliclyAccessible(java.lang.Boolean publiclyAccessible) Sets the value of the PubliclyAccessible property for this object.
void	setSourceDBInstanceIdentifier(java.lang.String sourceDBInstanceIdentifier) The identifier of the DB Instance that will act as the source for the Read Replica.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDBInstanceReadReplicaRequest	withAutoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade) Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
CreateDBInstanceReadReplicaRequest	withAvailabilityZone(java.lang.String availabilityZone) The Amazon EC2 Availability Zone that the Read Replica will be created in.
CreateDBInstanceReadReplicaRequest	withDBInstanceClass(java.lang.String dBInstanceClass) The compute and memory capacity of the Read Replica.
CreateDBInstanceReadReplicaRequest	withDBInstanceIdentifier(java.lang.String dBInstanceIdentifier) The DB Instance identifier of the Read Replica.
CreateDBInstanceReadReplicaRequest	withIops(java.lang.Integer iops) The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
CreateDBInstanceReadReplicaRequest	withOptionGroupName(java.lang.String optionGroupName) The option group the DB instance will be associated with.
CreateDBInstanceReadReplicaRequest	withPort(java.lang.Integer port) The port number that the DB Instance uses for connections.
CreateDBInstanceReadReplicaRequest	withPubliclyAccessible(java.lang.Boolean publiclyAccessible) Sets the value of the PubliclyAccessible property for this object.
CreateDBInstanceReadReplicaRequest	withSourceDBInstanceIdentifier(java.lang.String sourceDBInstanceIdentifier) The identifier of the DB Instance that will act as the source for the Read Replica.

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

CreateDBInstanceReadReplicaRequest

public CreateDBInstanceReadReplicaRequest()

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

CreateDBInstanceReadReplicaRequest

public CreateDBInstanceReadReplicaRequest(java.lang.String dBInstanceIdentifier,
                                          java.lang.String sourceDBInstanceIdentifier)

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

Parameters:

dBInstanceIdentifier - The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

sourceDBInstanceIdentifier - The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

Method Detail

getDBInstanceIdentifier

public java.lang.String getDBInstanceIdentifier()

The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

Returns:

The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

setDBInstanceIdentifier

public void setDBInstanceIdentifier(java.lang.String dBInstanceIdentifier)

The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

Parameters:

dBInstanceIdentifier - The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

withDBInstanceIdentifier

public CreateDBInstanceReadReplicaRequest withDBInstanceIdentifier(java.lang.String dBInstanceIdentifier)

The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

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

Parameters:

dBInstanceIdentifier - The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

Returns:

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

getSourceDBInstanceIdentifier

public java.lang.String getSourceDBInstanceIdentifier()

The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

Returns:

The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

setSourceDBInstanceIdentifier

public void setSourceDBInstanceIdentifier(java.lang.String sourceDBInstanceIdentifier)

The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

Parameters:

sourceDBInstanceIdentifier - The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

withSourceDBInstanceIdentifier

public CreateDBInstanceReadReplicaRequest withSourceDBInstanceIdentifier(java.lang.String sourceDBInstanceIdentifier)

The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

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

Parameters:

sourceDBInstanceIdentifier - The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

Returns:

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

getDBInstanceClass

public java.lang.String getDBInstanceClass()

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

Returns:

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

setDBInstanceClass

public void setDBInstanceClass(java.lang.String dBInstanceClass)

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

Parameters:

dBInstanceClass - The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

withDBInstanceClass

public CreateDBInstanceReadReplicaRequest withDBInstanceClass(java.lang.String dBInstanceClass)

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

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

Parameters:

dBInstanceClass - The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

Returns:

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

getAvailabilityZone

public java.lang.String getAvailabilityZone()

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Returns:

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

setAvailabilityZone

public void setAvailabilityZone(java.lang.String availabilityZone)

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Parameters:

availabilityZone - The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

withAvailabilityZone

public CreateDBInstanceReadReplicaRequest withAvailabilityZone(java.lang.String availabilityZone)

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

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

Parameters:

availabilityZone - The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Returns:

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

getPort

public java.lang.Integer getPort()

The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

Returns:

The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

setPort

public void setPort(java.lang.Integer port)

The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

Parameters:

port - The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

withPort

public CreateDBInstanceReadReplicaRequest withPort(java.lang.Integer port)

The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

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

Parameters:

port - The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

Returns:

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

isAutoMinorVersionUpgrade

public java.lang.Boolean isAutoMinorVersionUpgrade()

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

Returns:

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

Parameters:

autoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

withAutoMinorVersionUpgrade

public CreateDBInstanceReadReplicaRequest withAutoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

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

Parameters:

autoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

Returns:

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

getAutoMinorVersionUpgrade

public java.lang.Boolean getAutoMinorVersionUpgrade()

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

Returns:

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

getIops

public java.lang.Integer getIops()

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Returns:

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

setIops

public void setIops(java.lang.Integer iops)

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Parameters:

iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

withIops

public CreateDBInstanceReadReplicaRequest withIops(java.lang.Integer iops)

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

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

Parameters:

iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Returns:

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

getOptionGroupName

public java.lang.String getOptionGroupName()

The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

Returns:

The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

setOptionGroupName

public void setOptionGroupName(java.lang.String optionGroupName)

The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

Parameters:

optionGroupName - The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

withOptionGroupName

public CreateDBInstanceReadReplicaRequest withOptionGroupName(java.lang.String optionGroupName)

The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

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

Parameters:

optionGroupName - The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

Returns:

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

isPubliclyAccessible

public java.lang.Boolean isPubliclyAccessible()

Returns the value of the PubliclyAccessible property for this object.

Returns:

The value of the PubliclyAccessible property for this object.

setPubliclyAccessible

public void setPubliclyAccessible(java.lang.Boolean publiclyAccessible)

Sets the value of the PubliclyAccessible property for this object.

Parameters:

publiclyAccessible - The new value for the PubliclyAccessible property for this object.

withPubliclyAccessible

public CreateDBInstanceReadReplicaRequest withPubliclyAccessible(java.lang.Boolean publiclyAccessible)

Sets the value of the PubliclyAccessible property for this object.

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

Parameters:

publiclyAccessible - The new value for the PubliclyAccessible property for this object.

Returns:

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

getPubliclyAccessible

public java.lang.Boolean getPubliclyAccessible()

Returns the value of the PubliclyAccessible property for this object.

Returns:

The value of the PubliclyAccessible property for this object.

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object