Class CreateDBInstanceReadReplicaRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.CreateDBInstanceReadReplicaRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class CreateDBInstanceReadReplicaRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreateDBInstanceReadReplicaRequest()
Default constructor for CreateDBInstanceReadReplicaRequest object.CreateDBInstanceReadReplicaRequest(String dBInstanceIdentifier, String sourceDBInstanceIdentifier)
Constructs a new CreateDBInstanceReadReplicaRequest object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateDBInstanceReadReplicaRequest
clone()
Creates a shallow clone of this request.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.Boolean
getCopyTagsToSnapshot()
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.String
getDBInstanceClass()
The compute and memory capacity of the Read Replica.String
getDBInstanceIdentifier()
The DB instance identifier of the Read Replica.String
getDBSubnetGroupName()
Specifies a DB subnet group for the DB instance.Integer
getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.Integer
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica.String
getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs.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.String
getStorageType()
Specifies the storage type to be associated with the Read Replica.List<Tag>
getTags()
int
hashCode()
Boolean
isAutoMinorVersionUpgrade()
Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.Boolean
isCopyTagsToSnapshot()
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.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
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.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)
Specifies a DB subnet group for the DB instance.void
setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.void
setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica.void
setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs.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
setStorageType(String storageType)
Specifies the storage type to be associated with the Read Replica.void
setTags(Collection<Tag> 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
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.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)
Specifies a DB subnet group for the DB instance.CreateDBInstanceReadReplicaRequest
withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.CreateDBInstanceReadReplicaRequest
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica.CreateDBInstanceReadReplicaRequest
withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs.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
withStorageType(String storageType)
Specifies the storage type to be associated with the Read Replica.CreateDBInstanceReadReplicaRequest
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).CreateDBInstanceReadReplicaRequest
withTags(Collection<Tag> tags)
-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
CreateDBInstanceReadReplicaRequest
public CreateDBInstanceReadReplicaRequest()
Default constructor for CreateDBInstanceReadReplicaRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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 identifier 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 MySQL, MariaDB, or PostgreSQL DB instance.
- Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
- Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
- The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
- If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
- If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
-
-
Method Detail
-
setDBInstanceIdentifier
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier of the Read Replica. This identifier 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 identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
-
getDBInstanceIdentifier
public String getDBInstanceIdentifier()
The DB instance identifier of the Read Replica. This identifier 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 identifier 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 identifier 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 identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 MySQL, MariaDB, or PostgreSQL DB instance.
- Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
- Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
- The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
- If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
- If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
- 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 MySQL, MariaDB, or PostgreSQL DB instance.
- Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
- Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
- The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
- If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
- If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
-
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 MySQL, MariaDB, or PostgreSQL DB instance.
- Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
- Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
- The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
- If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
- If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
- 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 MySQL, MariaDB, or PostgreSQL DB instance.
- Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
- Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
- The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
- If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
- If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
-
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 MySQL, MariaDB, or PostgreSQL DB instance.
- Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
- Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
- The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
- If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
- If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
- 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 MySQL, MariaDB, or PostgreSQL DB instance.
- Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
- Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
- The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
- If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
- If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
Default: Inherits from the source DB instance.
-
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
Default: Inherits from the source DB instance.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
-
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
-
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
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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
-
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
-
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
- Parameters:
port
- The port number that the DB instance uses for connections.Default: Inherits from the source DB instance
Valid Values:
1150-65535
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
-
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
-
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
- 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:
- Returns a reference to this 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
-
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.
-
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.
-
withIops
public CreateDBInstanceReadReplicaRequest withIops(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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.
- 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.
-
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.
- 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:
- 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.
- 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.
- 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:
- Returns a reference to this 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.
- 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:
- 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.
-
setTags
public void setTags(Collection<Tag> tags)
- Parameters:
tags
-
-
withTags
public CreateDBInstanceReadReplicaRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public CreateDBInstanceReadReplicaRequest withTags(Collection<Tag> tags)
- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBSubnetGroupName
public void setDBSubnetGroupName(String dBSubnetGroupName)
Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
- Can only be specified if the source DB instance identifier specifies a DB instance in another region.
- The specified DB subnet group must be in the same region in which the operation is running.
- All Read Replicas in one region that are created from the same source
DB instance must either:
- Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
- Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Parameters:
dBSubnetGroupName
- Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.Constraints:
- Can only be specified if the source DB instance identifier specifies a DB instance in another region.
- The specified DB subnet group must be in the same region in which the operation is running.
- All Read Replicas in one region that are created from the same
source DB instance must either:
- Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
- Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
-
getDBSubnetGroupName
public String getDBSubnetGroupName()
Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
- Can only be specified if the source DB instance identifier specifies a DB instance in another region.
- The specified DB subnet group must be in the same region in which the operation is running.
- All Read Replicas in one region that are created from the same source
DB instance must either:
- Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
- Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Returns:
- Specifies a DB subnet group for the DB instance. The new DB
instance will be created in the VPC associated with the DB subnet
group. If no DB subnet group is specified, then the new DB
instance is not created in a VPC.
Constraints:
- Can only be specified if the source DB instance identifier specifies a DB instance in another region.
- The specified DB subnet group must be in the same region in which the operation is running.
- All Read Replicas in one region that are created from the
same source DB instance must either:
- Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
- Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
-
withDBSubnetGroupName
public CreateDBInstanceReadReplicaRequest withDBSubnetGroupName(String dBSubnetGroupName)
Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
- Can only be specified if the source DB instance identifier specifies a DB instance in another region.
- The specified DB subnet group must be in the same region in which the operation is running.
- All Read Replicas in one region that are created from the same source
DB instance must either:
- Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
- Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Parameters:
dBSubnetGroupName
- Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.Constraints:
- Can only be specified if the source DB instance identifier specifies a DB instance in another region.
- The specified DB subnet group must be in the same region in which the operation is running.
- All Read Replicas in one region that are created from the same
source DB instance must either:
- Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
- Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStorageType
public void setStorageType(String storageType)
Specifies the storage type to be associated with the Read Replica.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Parameters:
storageType
- Specifies the storage type to be associated with the Read Replica.Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
-
getStorageType
public String getStorageType()
Specifies the storage type to be associated with the Read Replica.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Returns:
- Specifies the storage type to be associated with the Read
Replica.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
-
withStorageType
public CreateDBInstanceReadReplicaRequest withStorageType(String storageType)
Specifies the storage type to be associated with the Read Replica.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Parameters:
storageType
- Specifies the storage type to be associated with the Read Replica.Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCopyTagsToSnapshot
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
- Parameters:
copyTagsToSnapshot
- True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
-
getCopyTagsToSnapshot
public Boolean getCopyTagsToSnapshot()
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
- Returns:
- True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
-
withCopyTagsToSnapshot
public CreateDBInstanceReadReplicaRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
- Parameters:
copyTagsToSnapshot
- True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isCopyTagsToSnapshot
public Boolean isCopyTagsToSnapshot()
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
- Returns:
- True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
-
setMonitoringInterval
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
- Parameters:
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
-
getMonitoringInterval
public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
- Returns:
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the Read Replica. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 60.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
-
withMonitoringInterval
public CreateDBInstanceReadReplicaRequest withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
- Parameters:
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMonitoringRoleArn
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.- Parameters:
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example,arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.
-
getMonitoringRoleArn
public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.- Returns:
- The ARN for the IAM role that permits RDS to send enhanced
monitoring metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.
-
withMonitoringRoleArn
public CreateDBInstanceReadReplicaRequest withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.- Parameters:
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example,arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreateDBInstanceReadReplicaRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-