public static interface CreateDBInstanceReadReplicaRequest.Builder extends RDSRequest.Builder, CopyableBuilder<CreateDBInstanceReadReplicaRequest.Builder,CreateDBInstanceReadReplicaRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateDBInstanceReadReplicaRequest.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance
window.
|
CreateDBInstanceReadReplicaRequest.Builder |
availabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone that the Read Replica is created in.
|
CreateDBInstanceReadReplicaRequest.Builder |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false.
|
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 |
dbSubnetGroupName(String dbSubnetGroupName)
Specifies a DB subnet group for the DB instance.
|
CreateDBInstanceReadReplicaRequest.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
CreateDBInstanceReadReplicaRequest.Builder |
enablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the read replica, and otherwise false.
|
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 |
optionGroupName(String optionGroupName)
The option group the DB instance is associated with.
|
CreateDBInstanceReadReplicaRequest.Builder |
performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of 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 |
publiclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
CreateDBInstanceReadReplicaRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
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)
The region where the source instance 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(Tag... tags)
Sets the value of the Tags property for this object.
|
buildrequestOverrideConfig, requestOverrideConfigcopyapply, 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, 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).
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 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
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 autoMinorVersionUpgrade(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
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 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.CreateDBInstanceReadReplicaRequest.Builder publiclyAccessible(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.
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 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 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
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 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
CreateDBInstanceReadReplicaRequest.Builder copyTagsToSnapshot(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.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.
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.
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 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.
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. 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.
CreateDBInstanceReadReplicaRequest.Builder enableIAMDatabaseAuthentication(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
CreateDBInstanceReadReplicaRequest.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the read replica, and otherwise false.
enablePerformanceInsights - True to enable Performance Insights for the read replica, and otherwise false.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.
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.CreateDBInstanceReadReplicaRequest.Builder sourceRegion(String sourceRegion)
sourceRegion - The region where the source instance is located.CreateDBInstanceReadReplicaRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.BuilderrequestOverrideConfig in interface AwsRequest.BuilderawsRequestOverrideConfig - The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.