AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateDBInstanceReadReplica operation. Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas.
Amazon Aurora doesn't support this action. You must call the
action to create a DB instance for an Aurora DB cluster.
All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.
Your source DB instance must have backup retention enabled.
public class CreateDBInstanceReadReplicaRequest : AmazonRDSRequest IAmazonWebServiceRequest, IPreSignedUrlRequest
The CreateDBInstanceReadReplicaRequest type exposes the following members
Empty constructor used to set properties independently even when a simple constructor is available
Instantiates CreateDBInstanceReadReplicaRequest with the parameterized properties
Gets and sets the property AutoMinorVersionUpgrade.
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
Gets and sets the property 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.
Gets and sets the property CopyTagsToSnapshot.
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.
Gets and sets the property DBInstanceClass.
The compute and memory capacity of the Read Replica, for example,
Default: Inherits from the source DB instance.
Gets and sets the property 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.
Gets and sets the property 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.
Gets and sets the property 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 Relational Database Service User Guide.
Gets and sets the property 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
Gets and sets the property 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.
Gets and sets the property Iops.
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Gets and sets the property 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.
Gets and sets the property 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.
Gets and sets the property MonitoringRoleArn.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon
CloudWatch Logs. For example,
Gets and sets the property 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.
Gets and sets the property OptionGroupName.
The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.
Gets and sets the property 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.
Gets and sets the property PerformanceInsightsRetentionPeriod.
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
Gets and sets the property Port.
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Gets and sets the property PreSignedUrl.
The URL that contains a Signature Version 4 signed request for the
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
The presigned URL must be a valid request for the
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.
Gets and sets the property ProcessorFeatures.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Gets and sets the property 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. For more information, see CreateDBInstance.
Gets and sets the property 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.
The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client.
Gets and sets the property StorageType.
Specifies the storage type to be associated with the Read Replica.
If you specify
Gets and sets the property Tags.
Gets and sets the property UseDefaultProcessorFeatures.
A value that specifies that the DB instance class of the DB instance uses its default processor features.
Supported in: 1.3
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms