AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 4.5
 
Container for the parameters to the CreateDBInstanceReadReplica operation. Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.

All Read Replica DB instances are created as Single-AZ deployments 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 below.

The source DB instance must have backup retention enabled.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RDS.AmazonRDSRequest
      Amazon.RDS.Model.CreateDBInstanceReadReplicaRequest

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class CreateDBInstanceReadReplicaRequest : AmazonRDSRequest
         IRequestEvents

The CreateDBInstanceReadReplicaRequest type exposes the following members

Constructors

NameDescription
Public Method CreateDBInstanceReadReplicaRequest() Empty constructor used to set properties independently even when a simple constructor is available
Public Method CreateDBInstanceReadReplicaRequest(string, string) Instantiates CreateDBInstanceReadReplicaRequest with the parameterized properties

Properties

NameTypeDescription
Public Property AutoMinorVersionUpgrade System.Boolean Gets and sets the property AutoMinorVersionUpgrade.

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

Public Property AvailabilityZone System.String Gets and sets the property AvailabilityZone.

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Public Property CopyTagsToSnapshot System.Boolean Gets and sets the property CopyTagsToSnapshot.

True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.

Public Property DBInstanceClass System.String Gets and sets the property DBInstanceClass.

The compute and memory capacity of the Read Replica.

Valid Values:

db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge
            |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge
            | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large
            | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small
            | db.t2.medium | db.t2.large

Default: Inherits from the source DB instance.

Public Property DBInstanceIdentifier System.String 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.

Public Property DBSubnetGroupName System.String Gets and sets the property DBSubnetGroupName.

Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another region.
  • The specified DB subnet group must be in the same region in which the operation is running.
  • All Read Replicas in one region that are created from the same source DB instance must either:
    • Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
    • Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Public Property Iops System.Int32 Gets and sets the property Iops.

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Public Property MonitoringInterval System.Int32 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 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 Property MonitoringRoleArn System.String Gets and sets the property MonitoringRoleArn.

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Public Property OptionGroupName System.String Gets and sets the property OptionGroupName.

The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.

Public Property Port System.Int32 Gets and sets the property Port.

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Public Property PubliclyAccessible System.Boolean 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.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true
  • VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Public Property SourceDBInstanceIdentifier System.String 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.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.
  • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
  • Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
  • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
  • If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
  • If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
Public Property StorageType System.String Gets and sets the property 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 Property Tags System.Collections.Generic.List<Amazon.RDS.Model.Tag> Gets and sets the property Tags.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1