Overview  Package   Class  Index  Help 

Did this page help you?

   Yes   No   Tell us about it...
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.rds.model
Class CreateDBInstanceReadReplicaRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.rds.model.CreateDBInstanceReadReplicaRequest
All Implemented Interfaces:
Serializable
public class CreateDBInstanceReadReplicaRequest
extends AmazonWebServiceRequest
implements Serializable

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), Serialized Form

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

Returns:
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.

  • Default VPC:true
  • VPC:false

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.

setPubliclyAccessible

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

Parameters:
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.

  • Default VPC:true
  • VPC:false

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.

withPubliclyAccessible

public CreateDBInstanceReadReplicaRequest withPubliclyAccessible(Boolean 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.

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

Parameters:
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.

  • Default VPC:true
  • VPC:false

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 updated object so that method calls can be chained together.

getPubliclyAccessible

public Boolean getPubliclyAccessible()
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.

Returns:
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.

  • Default VPC:true
  • VPC:false

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.

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()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.