public class CreateDBInstanceReadReplicaRequest extends AmazonWebServiceRequest implements Serializable
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.
NOOP
Constructor and Description |
---|
CreateDBInstanceReadReplicaRequest()
Default constructor for a new CreateDBInstanceReadReplicaRequest object.
|
CreateDBInstanceReadReplicaRequest(String dBInstanceIdentifier,
String sourceDBInstanceIdentifier)
Constructs a new CreateDBInstanceReadReplicaRequest object.
|
Modifier and Type | Method and Description |
---|---|
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.
|
String |
getDBSubnetGroupName()
A DB Subnet Group to associate with this DB Instance in case of a
cross region 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.
|
List<Tag> |
getTags()
A list of tags.
|
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 |
setDBSubnetGroupName(String dBSubnetGroupName)
A DB Subnet Group to associate with this DB Instance in case of a
cross region 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.
|
void |
setTags(Collection<Tag> tags)
A list of tags.
|
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 |
withDBSubnetGroupName(String dBSubnetGroupName)
A DB Subnet Group to associate with this DB Instance in case of a
cross region 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.
|
CreateDBInstanceReadReplicaRequest |
withTags(Collection<Tag> tags)
A list of tags.
|
CreateDBInstanceReadReplicaRequest |
withTags(Tag... tags)
A list of tags.
|
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public CreateDBInstanceReadReplicaRequest()
public CreateDBInstanceReadReplicaRequest(String dBInstanceIdentifier, String sourceDBInstanceIdentifier)
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:
public String getDBInstanceIdentifier()
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
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.public CreateDBInstanceReadReplicaRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
Returns a reference to this object so that method calls can be chained together.
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.public String getSourceDBInstanceIdentifier()
Constraints:
Constraints:
public void setSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
Constraints:
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:
public CreateDBInstanceReadReplicaRequest withSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
Constraints:
Returns a reference to this object so that method calls can be chained together.
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:
public String getDBInstanceClass()
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.
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.
public void setDBInstanceClass(String dBInstanceClass)
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.
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.
public CreateDBInstanceReadReplicaRequest withDBInstanceClass(String dBInstanceClass)
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.
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.
public String getAvailabilityZone()
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
public void setAvailabilityZone(String availabilityZone)
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
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
public CreateDBInstanceReadReplicaRequest withAvailabilityZone(String availabilityZone)
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.
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
public Integer getPort()
Default: Inherits from the source DB instance
Valid Values:
1150-65535
Default: Inherits from the source DB instance
Valid Values:
1150-65535
public void setPort(Integer port)
Default: Inherits from the source DB instance
Valid Values:
1150-65535
port
- The port number that the DB instance uses for connections. Default: Inherits from the source DB instance
Valid Values:
1150-65535
public CreateDBInstanceReadReplicaRequest withPort(Integer port)
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.
port
- The port number that the DB instance uses for connections. Default: Inherits from the source DB instance
Valid Values:
1150-65535
public Boolean isAutoMinorVersionUpgrade()
Default: Inherits from the source DB instance
Default: Inherits from the source DB instance
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Default: Inherits from the source DB instance
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
public CreateDBInstanceReadReplicaRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Default: Inherits from the source DB instance
Returns a reference to this object so that method calls can be chained together.
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
public Boolean getAutoMinorVersionUpgrade()
Default: Inherits from the source DB instance
Default: Inherits from the source DB instance
public Integer getIops()
public void setIops(Integer iops)
iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance.public CreateDBInstanceReadReplicaRequest withIops(Integer iops)
Returns a reference to this object so that method calls can be chained together.
iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance.public String getOptionGroupName()
public void setOptionGroupName(String optionGroupName)
optionGroupName
- The option group the DB instance will be associated with. If omitted,
the default option group for the engine specified will be used.public CreateDBInstanceReadReplicaRequest withOptionGroupName(String optionGroupName)
Returns a reference to this object so that method calls can be chained together.
optionGroupName
- The option group the DB instance will be associated with. If omitted,
the default option group for the engine specified will be used.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 CreateDBInstanceReadReplicaRequest 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 void setTags(Collection<Tag> tags)
tags
- A list of tags.public CreateDBInstanceReadReplicaRequest withTags(Tag... tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags.public CreateDBInstanceReadReplicaRequest withTags(Collection<Tag> tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags.public String getDBSubnetGroupName()
If there is no DB Subnet Group, then it is a non-VPC DB instance.
Constraints: All the cross region read replicas that share the source instance should lie within the same VPC.
If there is no DB Subnet Group, then it is a non-VPC DB instance.
Constraints: All the cross region read replicas that share the source instance should lie within the same VPC.
public void setDBSubnetGroupName(String dBSubnetGroupName)
If there is no DB Subnet Group, then it is a non-VPC DB instance.
Constraints: All the cross region read replicas that share the source instance should lie within the same VPC.
dBSubnetGroupName
- A DB Subnet Group to associate with this DB Instance in case of a
cross region read replica. If there is no DB Subnet Group, then it is a non-VPC DB instance.
Constraints: All the cross region read replicas that share the source instance should lie within the same VPC.
public CreateDBInstanceReadReplicaRequest withDBSubnetGroupName(String dBSubnetGroupName)
If there is no DB Subnet Group, then it is a non-VPC DB instance.
Constraints: All the cross region read replicas that share the source instance should lie within the same VPC.
Returns a reference to this object so that method calls can be chained together.
dBSubnetGroupName
- A DB Subnet Group to associate with this DB Instance in case of a
cross region read replica. If there is no DB Subnet Group, then it is a non-VPC DB instance.
Constraints: All the cross region read replicas that share the source instance should lie within the same VPC.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.