AWS SDK Version 3 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.

Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance operation.

All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.

Your source DB instance or cluster must have backup retention enabled.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateDBInstanceReadReplica and EndCreateDBInstanceReadReplica.

Namespace: Amazon.RDS
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateDBInstanceReadReplicaResponse> CreateDBInstanceReadReplicaAsync(
         CreateDBInstanceReadReplicaRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.CreateDBInstanceReadReplicaRequest

Container for the necessary parameters to execute the CreateDBInstanceReadReplica service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateDBInstanceReadReplica service method, as returned by RDS.

Exceptions

ExceptionCondition
CertificateNotFoundException CertificateIdentifier doesn't refer to an existing certificate.
DBClusterNotFoundException DBClusterIdentifier doesn't refer to an existing DB cluster.
DBInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
DBInstanceNotFoundException DBInstanceIdentifier doesn't refer to an existing DB instance.
DBParameterGroupNotFoundException DBParameterGroupName doesn't refer to an existing DB parameter group.
DBSecurityGroupNotFoundException DBSecurityGroupName doesn't refer to an existing DB security group.
DBSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
DBSubnetGroupNotAllowedException The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.
DBSubnetGroupNotFoundException DBSubnetGroupName doesn't refer to an existing DB subnet group.
DomainNotFoundException Domain doesn't refer to an existing Active Directory domain.
InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
InsufficientDBInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
InvalidDBClusterStateException The requested operation can't be performed while the cluster is in this state.
InvalidDBInstanceStateException The DB instance isn't in a valid state.
InvalidDBSubnetGroupException The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
InvalidVPCNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
KMSKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.
OptionGroupNotFoundException The specified option group could not be found.
ProvisionedIopsNotAvailableInAZException Provisioned IOPS not available in the specified Availability Zone.
StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
StorageTypeNotSupportedException The specified StorageType can't be associated with the DB instance.
TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also