public static interface CreateDbInstanceReadReplicaRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<CreateDbInstanceReadReplicaRequest.Builder,CreateDbInstanceReadReplicaRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateDbInstanceReadReplicaRequest.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the read replica during the
maintenance window.
|
CreateDbInstanceReadReplicaRequest.Builder |
availabilityZone(String availabilityZone)
The Availability Zone (AZ) where the read replica will be created.
|
CreateDbInstanceReadReplicaRequest.Builder |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the read replica to snapshots of the read replica.
|
CreateDbInstanceReadReplicaRequest.Builder |
dbInstanceClass(String dbInstanceClass)
The compute and memory capacity of the read replica, for example,
db.m4.large. |
CreateDbInstanceReadReplicaRequest.Builder |
dbInstanceIdentifier(String dbInstanceIdentifier)
The DB instance identifier of the read replica.
|
CreateDbInstanceReadReplicaRequest.Builder |
dbParameterGroupName(String dbParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
CreateDbInstanceReadReplicaRequest.Builder |
dbSubnetGroupName(String dbSubnetGroupName)
Specifies a DB subnet group for the DB instance.
|
CreateDbInstanceReadReplicaRequest.Builder |
deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
CreateDbInstanceReadReplicaRequest.Builder |
domain(String domain)
The Active Directory directory ID to create the DB instance in.
|
CreateDbInstanceReadReplicaRequest.Builder |
domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
CreateDbInstanceReadReplicaRequest.Builder |
enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs.
|
CreateDbInstanceReadReplicaRequest.Builder |
enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs.
|
CreateDbInstanceReadReplicaRequest.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts.
|
CreateDbInstanceReadReplicaRequest.Builder |
enablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the read replica.
|
CreateDbInstanceReadReplicaRequest.Builder |
iops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
CreateDbInstanceReadReplicaRequest.Builder |
kmsKeyId(String kmsKeyId)
The AWS KMS key ID for an encrypted read replica.
|
CreateDbInstanceReadReplicaRequest.Builder |
monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica.
|
CreateDbInstanceReadReplicaRequest.Builder |
monitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
CreateDbInstanceReadReplicaRequest.Builder |
multiAZ(Boolean multiAZ)
A value that indicates whether the read replica is in a Multi-AZ deployment.
|
CreateDbInstanceReadReplicaRequest.Builder |
optionGroupName(String optionGroupName)
The option group the DB instance is associated with.
|
CreateDbInstanceReadReplicaRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateDbInstanceReadReplicaRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateDbInstanceReadReplicaRequest.Builder |
performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data.
|
CreateDbInstanceReadReplicaRequest.Builder |
performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
CreateDbInstanceReadReplicaRequest.Builder |
port(Integer port)
The port number that the DB instance uses for connections.
|
CreateDbInstanceReadReplicaRequest.Builder |
preSignedUrl(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.Builder |
processorFeatures(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.Builder |
processorFeatures(Consumer<ProcessorFeature.Builder>... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
CreateDbInstanceReadReplicaRequest.Builder |
processorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
CreateDbInstanceReadReplicaRequest.Builder |
publiclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
|
CreateDbInstanceReadReplicaRequest.Builder |
replicaMode(ReplicaMode replicaMode)
The open mode of the replica database: mounted or read-only.
|
CreateDbInstanceReadReplicaRequest.Builder |
replicaMode(String replicaMode)
The open mode of the replica database: mounted or read-only.
|
CreateDbInstanceReadReplicaRequest.Builder |
sourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the DB instance that will act as the source for the read replica.
|
CreateDbInstanceReadReplicaRequest.Builder |
sourceRegion(String sourceRegion)
If PreSignedUrl is not specified, this is the region where the source snapshot is located.
|
CreateDbInstanceReadReplicaRequest.Builder |
storageType(String storageType)
Specifies the storage type to be associated with the read replica.
|
CreateDbInstanceReadReplicaRequest.Builder |
tags(Collection<Tag> tags)
Sets the value of the Tags property for this object.
|
CreateDbInstanceReadReplicaRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Sets the value of the Tags property for this object.
|
CreateDbInstanceReadReplicaRequest.Builder |
tags(Tag... tags)
Sets the value of the Tags property for this object.
|
CreateDbInstanceReadReplicaRequest.Builder |
useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
CreateDbInstanceReadReplicaRequest.Builder |
vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the read replica.
|
CreateDbInstanceReadReplicaRequest.Builder |
vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the read replica.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateDbInstanceReadReplicaRequest.Builder dbInstanceIdentifier(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.CreateDbInstanceReadReplicaRequest.Builder sourceDBInstanceIdentifier(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, Oracle, PostgreSQL, or SQL Server DB instance.
Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.
For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
Can specify 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, that is, 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 from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.
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, Oracle, PostgreSQL, or SQL Server DB instance.
Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.
For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
Can specify 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, that is, 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 from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.
CreateDbInstanceReadReplicaRequest.Builder dbInstanceClass(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.
CreateDbInstanceReadReplicaRequest.Builder availabilityZone(String availabilityZone)
The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
availabilityZone - The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
CreateDbInstanceReadReplicaRequest.Builder port(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
CreateDbInstanceReadReplicaRequest.Builder multiAZ(Boolean multiAZ)
A value that indicates 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 - A value that indicates 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.
CreateDbInstanceReadReplicaRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
Default: Inherits from the source DB instance
autoMinorVersionUpgrade - A value that indicates whether minor engine upgrades are applied automatically to the read replica
during the maintenance window.
Default: Inherits from the source DB instance
CreateDbInstanceReadReplicaRequest.Builder iops(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.CreateDbInstanceReadReplicaRequest.Builder optionGroupName(String optionGroupName)
The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
For SQL Server, you must use the option group associated with the source instance.
optionGroupName - The option group the DB instance is associated with. If omitted, the option group associated with the
source instance is used. For SQL Server, you must use the option group associated with the source instance.
CreateDbInstanceReadReplicaRequest.Builder dbParameterGroupName(String dbParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the
DBParameterGroup of source DB instance for a same region read replica, or the default
DBParameterGroup for the specified DB engine for a cross region read replica.
Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
dbParameterGroupName - The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the
DBParameterGroup of source DB instance for a same region read replica, or the default
DBParameterGroup for the specified DB engine for a cross region read replica.
Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
CreateDbInstanceReadReplicaRequest.Builder publiclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
publiclyAccessible - A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
CreateDbInstanceReadReplicaRequest.Builder tags(Collection<Tag> tags)
tags - The new value for the Tags property for this object.CreateDbInstanceReadReplicaRequest.Builder tags(Tag... tags)
tags - The new value for the Tags property for this object.CreateDbInstanceReadReplicaRequest.Builder tags(Consumer<Tag.Builder>... tags)
List.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateDbInstanceReadReplicaRequest.Builder dbSubnetGroupName(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 isn't 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 isn't 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
CreateDbInstanceReadReplicaRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the read replica.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the read replica.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
CreateDbInstanceReadReplicaRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the read replica.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the read replica.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
CreateDbInstanceReadReplicaRequest.Builder storageType(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 gp2
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 gp2
CreateDbInstanceReadReplicaRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.
copyTagsToSnapshot - A value that indicates whether to copy all tags from the read replica to snapshots of the read
replica. By default, tags are not copied.CreateDbInstanceReadReplicaRequest.Builder monitoringInterval(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
CreateDbInstanceReadReplicaRequest.Builder monitoringRoleArn(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 in the Amazon RDS User Guide.
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 in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
CreateDbInstanceReadReplicaRequest.Builder kmsKeyId(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 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.
You can't create an encrypted read replica from an unencrypted DB instance.
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 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.
You can't create an encrypted read replica from an unencrypted DB instance.
CreateDbInstanceReadReplicaRequest.Builder preSignedUrl(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. Don't specify PreSignedUrl when you are creating an encrypted read replica
in the same AWS Region.
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.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or
--source-region for the AWS CLI) instead of specifying PreSignedUrl manually.
Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation
that can be executed in the source AWS Region.
SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support
cross-region read replicas.
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. Don't specify PreSignedUrl when you are creating an encrypted
read replica in the same AWS Region.
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.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or
--source-region for the AWS CLI) instead of specifying PreSignedUrl
manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request
for the operation that can be executed in the source AWS Region.
SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't
support cross-region read replicas.
CreateDbInstanceReadReplicaRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts
to database accounts. By default, mapping is disabled. For information about the supported DB engines,
see CreateDBInstance.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
CreateDbInstanceReadReplicaRequest.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
enablePerformanceInsights - A value that indicates whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
CreateDbInstanceReadReplicaRequest.Builder performanceInsightsKMSKeyId(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.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default
encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a
different default encryption key for each AWS Region.
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.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your
default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS
account has a different default encryption key for each AWS Region.
CreateDbInstanceReadReplicaRequest.Builder performanceInsightsRetentionPeriod(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).CreateDbInstanceReadReplicaRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
enableCloudwatchLogsExports - The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.CreateDbInstanceReadReplicaRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
enableCloudwatchLogsExports - The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.CreateDbInstanceReadReplicaRequest.Builder processorFeatures(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.CreateDbInstanceReadReplicaRequest.Builder processorFeatures(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.CreateDbInstanceReadReplicaRequest.Builder processorFeatures(Consumer<ProcessorFeature.Builder>... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This is a convenience that creates an instance of theList.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #processorFeatures(List) .processorFeatures - a consumer that will call methods on List.Builder #processorFeatures(List) CreateDbInstanceReadReplicaRequest.Builder useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
useDefaultProcessorFeatures - A value that indicates whether the DB instance class of the DB instance uses its default processor
features.CreateDbInstanceReadReplicaRequest.Builder deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
deletionProtection - A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled. For more
information, see Deleting a DB
Instance.CreateDbInstanceReadReplicaRequest.Builder domain(String domain)
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
domain - The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL
Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
CreateDbInstanceReadReplicaRequest.Builder domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.CreateDbInstanceReadReplicaRequest.Builder replicaMode(String replicaMode)
The open mode of the replica database: mounted or read-only.
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
replicaMode - The open mode of the replica database: mounted or read-only. This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
ReplicaMode,
ReplicaModeCreateDbInstanceReadReplicaRequest.Builder replicaMode(ReplicaMode replicaMode)
The open mode of the replica database: mounted or read-only.
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
replicaMode - The open mode of the replica database: mounted or read-only. This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
ReplicaMode,
ReplicaModeCreateDbInstanceReadReplicaRequest.Builder sourceRegion(String sourceRegion)
sourceRegion - If PreSignedUrl is not specified, this is the region where the source snapshot is located. A
PreSignedUrl will be generated automatically by the SDK.CreateDbInstanceReadReplicaRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateDbInstanceReadReplicaRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.