@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDBInstanceReadReplicaRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateDBInstanceReadReplicaRequest()
Default constructor for CreateDBInstanceReadReplicaRequest object.
|
CreateDBInstanceReadReplicaRequest(String dBInstanceIdentifier,
String sourceDBInstanceIdentifier)
Constructs a new CreateDBInstanceReadReplicaRequest object.
|
Modifier and Type | Method and Description |
---|---|
CreateDBInstanceReadReplicaRequest |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAutoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
|
String |
getAvailabilityZone()
The Amazon EC2 Availability Zone that the Read Replica is created in.
|
Boolean |
getCopyTagsToSnapshot()
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false.
|
String |
getDBInstanceClass()
The compute and memory capacity of the Read Replica, for example,
db.m4.large . |
String |
getDBInstanceIdentifier()
The DB instance identifier of the Read Replica.
|
String |
getDBSubnetGroupName()
Specifies a DB subnet group for the DB instance.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of logs that the new DB instance is to export to CloudWatch Logs.
|
Boolean |
getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
Boolean |
getEnablePerformanceInsights()
True to enable Performance Insights for the read replica, and otherwise false.
|
Integer |
getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
String |
getKmsKeyId()
The AWS KMS key ID for an encrypted Read Replica.
|
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 Amazon CloudWatch Logs.
|
Boolean |
getMultiAZ()
Specifies whether the Read Replica is in a Multi-AZ deployment.
|
String |
getOptionGroupName()
The option group the DB instance is associated with.
|
String |
getPerformanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data.
|
Integer |
getPort()
The port number that the DB instance uses for connections.
|
String |
getPreSignedUrl()
The URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica API
action in the source AWS Region that contains the source DB instance. |
List<ProcessorFeature> |
getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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 |
getSourceRegion()
The region where the source instance is located.
|
String |
getStorageType()
Specifies the storage type to be associated with the Read Replica.
|
List<Tag> |
getTags() |
Boolean |
getUseDefaultProcessorFeatures()
A value that specifies that the DB instance class of the DB instance uses its default processor features.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor engine upgrades are 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, and otherwise false.
|
Boolean |
isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
Boolean |
isEnablePerformanceInsights()
True to enable Performance Insights for the read replica, and otherwise false.
|
Boolean |
isMultiAZ()
Specifies whether the Read Replica is in a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
Boolean |
isUseDefaultProcessorFeatures()
A value that specifies that the DB instance class of the DB instance uses its default processor features.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
|
void |
setAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone that the Read Replica is created in.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false.
|
void |
setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Read Replica, for example,
db.m4.large . |
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 |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the read replica, and otherwise false.
|
void |
setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
void |
setKmsKeyId(String kmsKeyId)
The AWS KMS key ID for an encrypted Read Replica.
|
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 Amazon CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies whether the Read Replica is in a Multi-AZ deployment.
|
void |
setOptionGroupName(String optionGroupName)
The option group the DB instance is associated with.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data.
|
void |
setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
void |
setPort(Integer port)
The port number that the DB instance uses for connections.
|
void |
setPreSignedUrl(String preSignedUrl)
The URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica API
action in the source AWS Region that contains the source DB instance. |
void |
setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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 |
setSourceRegion(String sourceRegion)
The region where the source instance is located.
|
void |
setStorageType(String storageType)
Specifies the storage type to be associated with the Read Replica.
|
void |
setTags(Collection<Tag> tags) |
void |
setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that specifies that the DB instance class of the DB instance uses its default processor features.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
CreateDBInstanceReadReplicaRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
|
CreateDBInstanceReadReplicaRequest |
withAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone that the Read Replica is created in.
|
CreateDBInstanceReadReplicaRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false.
|
CreateDBInstanceReadReplicaRequest |
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Read Replica, for example,
db.m4.large . |
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 |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs.
|
CreateDBInstanceReadReplicaRequest |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs.
|
CreateDBInstanceReadReplicaRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
CreateDBInstanceReadReplicaRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the read replica, and otherwise false.
|
CreateDBInstanceReadReplicaRequest |
withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
CreateDBInstanceReadReplicaRequest |
withKmsKeyId(String kmsKeyId)
The AWS KMS key ID for an encrypted Read Replica.
|
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 Amazon CloudWatch Logs.
|
CreateDBInstanceReadReplicaRequest |
withMultiAZ(Boolean multiAZ)
Specifies whether the Read Replica is in a Multi-AZ deployment.
|
CreateDBInstanceReadReplicaRequest |
withOptionGroupName(String optionGroupName)
The option group the DB instance is associated with.
|
CreateDBInstanceReadReplicaRequest |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data.
|
CreateDBInstanceReadReplicaRequest |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
CreateDBInstanceReadReplicaRequest |
withPort(Integer port)
The port number that the DB instance uses for connections.
|
CreateDBInstanceReadReplicaRequest |
withPreSignedUrl(String preSignedUrl)
The URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica API
action in the source AWS Region that contains the source DB instance. |
CreateDBInstanceReadReplicaRequest |
withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
CreateDBInstanceReadReplicaRequest |
withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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 |
withSourceRegion(String sourceRegion)
The region where the source instance is located.
|
CreateDBInstanceReadReplicaRequest |
withStorageType(String storageType)
Specifies the storage type to be associated with the Read Replica.
|
CreateDBInstanceReadReplicaRequest |
withTags(Collection<Tag> tags) |
CreateDBInstanceReadReplicaRequest |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).
|
CreateDBInstanceReadReplicaRequest |
withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that specifies that the DB instance class of the DB instance uses its default processor features.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CreateDBInstanceReadReplicaRequest()
public CreateDBInstanceReadReplicaRequest(String dBInstanceIdentifier, String sourceDBInstanceIdentifier)
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 DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
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 AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
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.
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.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.
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.
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.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 DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
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 AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
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 DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
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 AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
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 DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
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 AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
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 DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
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 AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
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 DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
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 AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
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 DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
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 AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
public void setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Read Replica, for example, db.m4.large
. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
dBInstanceClass
- The compute and memory capacity of the Read Replica, for example, db.m4.large
. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
public String getDBInstanceClass()
The compute and memory capacity of the Read Replica, for example, db.m4.large
. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
db.m4.large
. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
public CreateDBInstanceReadReplicaRequest withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Read Replica, for example, db.m4.large
. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
dBInstanceClass
- The compute and memory capacity of the Read Replica, for example, db.m4.large
. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
public void setAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone that the Read Replica is created in.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
availabilityZone
- The Amazon EC2 Availability Zone that the Read Replica is created in.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
public String getAvailabilityZone()
The Amazon EC2 Availability Zone that the Read Replica is created in.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
public CreateDBInstanceReadReplicaRequest withAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone that the Read Replica is created in.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
availabilityZone
- The Amazon EC2 Availability Zone that the Read Replica is created in.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
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
port
- The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
public Integer getPort()
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
Default: Inherits from the source DB instance
Valid Values: 1150-65535
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
port
- The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
public void setMultiAZ(Boolean multiAZ)
Specifies whether the Read Replica is in a Multi-AZ deployment.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
multiAZ
- Specifies whether the Read Replica is in a Multi-AZ deployment.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
public Boolean getMultiAZ()
Specifies whether the Read Replica is in a Multi-AZ deployment.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
public CreateDBInstanceReadReplicaRequest withMultiAZ(Boolean multiAZ)
Specifies whether the Read Replica is in a Multi-AZ deployment.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
multiAZ
- Specifies whether the Read Replica is in a Multi-AZ deployment.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
public Boolean isMultiAZ()
Specifies whether the Read Replica is in a Multi-AZ deployment.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
autoMinorVersionUpgrade
- Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance
window.
Default: Inherits from the source DB instance
public Boolean getAutoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
Default: Inherits from the source DB instance
public CreateDBInstanceReadReplicaRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
autoMinorVersionUpgrade
- Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance
window.
Default: Inherits from the source DB instance
public Boolean isAutoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
Default: Inherits from the source DB instance
public void setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.public Integer getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
public CreateDBInstanceReadReplicaRequest withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.public void setOptionGroupName(String optionGroupName)
The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.
optionGroupName
- The option group the DB instance is associated with. If omitted, the default option group for the engine
specified is used.public String getOptionGroupName()
The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.
public CreateDBInstanceReadReplicaRequest withOptionGroupName(String optionGroupName)
The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.
optionGroupName
- The option group the DB instance is associated with. If omitted, the default option group for the engine
specified is used.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 is 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 is 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.
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 is 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 is private.
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 is 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 is 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.
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 is 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 is private.
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 is 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 is 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.
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 is 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 is private.
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 is 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 is 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.
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 is 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 is private.
public void setTags(Collection<Tag> tags)
tags
- public CreateDBInstanceReadReplicaRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- public CreateDBInstanceReadReplicaRequest withTags(Collection<Tag> tags)
tags
- public void setDBSubnetGroupName(String dBSubnetGroupName)
Specifies a DB subnet group for the DB instance. The new DB instance is 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 AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
dBSubnetGroupName
- Specifies a DB subnet group for the DB instance. The new DB instance is 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 AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
public String getDBSubnetGroupName()
Specifies a DB subnet group for the DB instance. The new DB instance is 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 AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
Constraints:
Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
public CreateDBInstanceReadReplicaRequest withDBSubnetGroupName(String dBSubnetGroupName)
Specifies a DB subnet group for the DB instance. The new DB instance is 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 AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
dBSubnetGroupName
- Specifies a DB subnet group for the DB instance. The new DB instance is 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 AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise standard
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise standard
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise standard
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise
standard
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise standard
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise standard
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The
default is false.public Boolean getCopyTagsToSnapshot()
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.
public CreateDBInstanceReadReplicaRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The
default is false.public Boolean isCopyTagsToSnapshot()
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.
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 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
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 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
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 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
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 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
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 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon 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 a
MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon 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 a
MonitoringRoleArn
value.
public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon 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 a
MonitoringRoleArn
value.
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 a
MonitoringRoleArn
value.
public CreateDBInstanceReadReplicaRequest withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon 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 a
MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon 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 a
MonitoringRoleArn
value.
public void setKmsKeyId(String kmsKeyId)
The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.
If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
kmsKeyId
- The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS
key identifier, or the KMS key alias for the KMS encryption key.
If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.
If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
public String getKmsKeyId()
The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.
If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.
If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
public CreateDBInstanceReadReplicaRequest withKmsKeyId(String kmsKeyId)
The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.
If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
kmsKeyId
- The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS
key identifier, or the KMS key alias for the KMS encryption key.
If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.
If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
public void setPreSignedUrl(String preSignedUrl)
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica
API
action in the source AWS Region that contains the source DB instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the
Amazon RDS API. You can specify the --source-region
option instead of this parameter when you create
an encrypted Read Replica from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API action that can be
executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must
contain the following parameter values:
DestinationRegion
- The AWS Region that the encrypted Read Replica is created in. This AWS Region is
the same one where the CreateDBInstanceReadReplica
action is called that contains this presigned
URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the
us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica
action in the us-east-1 AWS
Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica
action in
the us-west-2 AWS Region. For this example, the DestinationRegion
in the presigned URL must be set
to the us-east-1 AWS Region.
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the Read Replica in the
destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica
action
that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your
SourceDBInstanceIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
preSignedUrl
- The URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica
API action in the source AWS Region that contains the source DB
instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using
the Amazon RDS API. You can specify the --source-region
option instead of this parameter when
you create an encrypted Read Replica from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API action that
can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL
request must contain the following parameter values:
DestinationRegion
- The AWS Region that the encrypted Read Replica is created in. This AWS
Region is the same one where the CreateDBInstanceReadReplica
action is called that contains
this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance
in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica
action in the
us-east-1 AWS Region and provide a presigned URL that contains a call to the
CreateDBInstanceReadReplica
action in the us-west-2 AWS Region. For this example, the
DestinationRegion
in the presigned URL must be set to the us-east-1 AWS Region.
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the Read Replica in the
destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica
action that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region.
For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region,
then your SourceDBInstanceIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
public String getPreSignedUrl()
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica
API
action in the source AWS Region that contains the source DB instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the
Amazon RDS API. You can specify the --source-region
option instead of this parameter when you create
an encrypted Read Replica from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API action that can be
executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must
contain the following parameter values:
DestinationRegion
- The AWS Region that the encrypted Read Replica is created in. This AWS Region is
the same one where the CreateDBInstanceReadReplica
action is called that contains this presigned
URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the
us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica
action in the us-east-1 AWS
Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica
action in
the us-west-2 AWS Region. For this example, the DestinationRegion
in the presigned URL must be set
to the us-east-1 AWS Region.
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the Read Replica in the
destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica
action
that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your
SourceDBInstanceIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
CreateDBInstanceReadReplica
API action in the source AWS Region that contains the source DB
instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by
using the Amazon RDS API. You can specify the --source-region
option instead of this
parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API action
that can be executed in the source AWS Region that contains the encrypted source DB instance. The
presigned URL request must contain the following parameter values:
DestinationRegion
- The AWS Region that the encrypted Read Replica is created in. This AWS
Region is the same one where the CreateDBInstanceReadReplica
action is called that contains
this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB
instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica
action
in the us-east-1 AWS Region and provide a presigned URL that contains a call to the
CreateDBInstanceReadReplica
action in the us-west-2 AWS Region. For this example, the
DestinationRegion
in the presigned URL must be set to the us-east-1 AWS Region.
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the Read Replica in the
destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica
action that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region.
For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS
Region, then your SourceDBInstanceIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
public CreateDBInstanceReadReplicaRequest withPreSignedUrl(String preSignedUrl)
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica
API
action in the source AWS Region that contains the source DB instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the
Amazon RDS API. You can specify the --source-region
option instead of this parameter when you create
an encrypted Read Replica from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API action that can be
executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must
contain the following parameter values:
DestinationRegion
- The AWS Region that the encrypted Read Replica is created in. This AWS Region is
the same one where the CreateDBInstanceReadReplica
action is called that contains this presigned
URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the
us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica
action in the us-east-1 AWS
Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica
action in
the us-west-2 AWS Region. For this example, the DestinationRegion
in the presigned URL must be set
to the us-east-1 AWS Region.
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the Read Replica in the
destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica
action
that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your
SourceDBInstanceIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
preSignedUrl
- The URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica
API action in the source AWS Region that contains the source DB
instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using
the Amazon RDS API. You can specify the --source-region
option instead of this parameter when
you create an encrypted Read Replica from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API action that
can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL
request must contain the following parameter values:
DestinationRegion
- The AWS Region that the encrypted Read Replica is created in. This AWS
Region is the same one where the CreateDBInstanceReadReplica
action is called that contains
this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance
in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica
action in the
us-east-1 AWS Region and provide a presigned URL that contains a call to the
CreateDBInstanceReadReplica
action in the us-west-2 AWS Region. For this example, the
DestinationRegion
in the presigned URL must be set to the us-east-1 AWS Region.
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the Read Replica in the
destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica
action that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region.
For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region,
then your SourceDBInstanceIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
public CreateDBInstanceReadReplicaRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the read replica, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
enablePerformanceInsights
- True to enable Performance Insights for the read replica, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public Boolean getEnablePerformanceInsights()
True to enable Performance Insights for the read replica, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public CreateDBInstanceReadReplicaRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the read replica, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
enablePerformanceInsights
- True to enable Performance Insights for the read replica, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public Boolean isEnablePerformanceInsights()
True to enable Performance Insights for the read replica, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon
Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.public String getPerformanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
public CreateDBInstanceReadReplicaRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon
Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).public Integer getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
public CreateDBInstanceReadReplicaRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).public List<String> getEnableCloudwatchLogsExports()
The list of logs that the new DB instance is to export to CloudWatch Logs.
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs.
enableCloudwatchLogsExports
- The list of logs that the new DB instance is to export to CloudWatch Logs.public CreateDBInstanceReadReplicaRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs.
NOTE: This method appends the values to the existing list (if any). Use
setEnableCloudwatchLogsExports(java.util.Collection)
or
withEnableCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enableCloudwatchLogsExports
- The list of logs that the new DB instance is to export to CloudWatch Logs.public CreateDBInstanceReadReplicaRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs.
enableCloudwatchLogsExports
- The list of logs that the new DB instance is to export to CloudWatch Logs.public List<ProcessorFeature> getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
public void setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public CreateDBInstanceReadReplicaRequest withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setProcessorFeatures(java.util.Collection)
or withProcessorFeatures(java.util.Collection)
if
you want to override the existing values.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public CreateDBInstanceReadReplicaRequest withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that specifies that the DB instance class of the DB instance uses its default processor features.
useDefaultProcessorFeatures
- A value that specifies that the DB instance class of the DB instance uses its default processor features.public Boolean getUseDefaultProcessorFeatures()
A value that specifies that the DB instance class of the DB instance uses its default processor features.
public CreateDBInstanceReadReplicaRequest withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that specifies that the DB instance class of the DB instance uses its default processor features.
useDefaultProcessorFeatures
- A value that specifies that the DB instance class of the DB instance uses its default processor features.public Boolean isUseDefaultProcessorFeatures()
A value that specifies that the DB instance class of the DB instance uses its default processor features.
public void setSourceRegion(String sourceRegion)
sourceRegion
- The region where the source instance is located.public String getSourceRegion()
public CreateDBInstanceReadReplicaRequest withSourceRegion(String sourceRegion)
sourceRegion
- The region where the source instance is located.public String toString()
toString
in class Object
Object.toString()
public CreateDBInstanceReadReplicaRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2018. All rights reserved.