amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDS.CreateDBInstanceReadReplica

Description

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, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.

Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation 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.

Your source DB instance must have backup retention enabled.

Synopsis

Creating a Request

data CreateDBInstanceReadReplica Source #

See: newCreateDBInstanceReadReplica smart constructor.

Constructors

CreateDBInstanceReadReplica' 

Fields

  • autoMinorVersionUpgrade :: Maybe Bool

    A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

    This setting doesn't apply to RDS Custom.

    Default: Inherits from the source DB instance

  • availabilityZone :: Maybe Text

    The Availability Zone (AZ) where the read replica will be created.

    Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

    Example: us-east-1d

  • copyTagsToSnapshot :: Maybe Bool

    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.

  • customIamInstanceProfile :: Maybe Text

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

    • The profile must exist in your account.
    • The profile must have an IAM role that Amazon EC2 has permissions to assume.
    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    This setting is required for RDS Custom.

  • dbInstanceClass :: Maybe Text

    The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services 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.

  • dbParameterGroupName :: Maybe Text

    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.

    Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported for RDS Custom.

    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
  • dbSubnetGroupName :: Maybe Text

    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 Amazon Web Services Region.
    • If supplied, must match the name of an existing DBSubnetGroup.
    • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

    • All read replicas in one Amazon Web Services 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: mydbsubnetgroup

  • deletionProtection :: Maybe Bool

    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 isn't enabled. For more information, see Deleting a DB Instance.

  • destinationRegion :: Maybe Text

    Pseudo-parameter used when populating the PreSignedUrl of a cross-region CreateDBInstanceReadReplica request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

  • domain :: Maybe Text

    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.

    This setting doesn't apply to RDS Custom.

  • domainIAMRoleName :: Maybe Text

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    This setting doesn't apply to RDS Custom.

  • enableCloudwatchLogsExports :: Maybe [Text]

    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.

    This setting doesn't apply to RDS Custom.

  • enableCustomerOwnedIp :: Maybe Bool

    A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.

    A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.

    For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

    For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

  • enableIAMDatabaseAuthentication :: Maybe Bool

    A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    This setting doesn't apply to RDS Custom.

  • enablePerformanceInsights :: Maybe Bool

    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.

    This setting doesn't apply to RDS Custom.

  • iops :: Maybe Int

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

  • kmsKeyId :: Maybe Text

    The Amazon Web Services KMS key identifier for an encrypted read replica.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance.

    If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

    You can't create an encrypted read replica from an unencrypted DB instance.

    This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.

  • maxAllocatedStorage :: Maybe Int

    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

    For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

  • monitoringInterval :: Maybe Int

    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.

    This setting doesn't apply to RDS Custom.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

  • monitoringRoleArn :: Maybe Text

    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.

    This setting doesn't apply to RDS Custom.

  • multiAZ :: Maybe Bool

    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.

    This setting doesn't apply to RDS Custom.

  • networkType :: Maybe Text

    The network type of the DB instance.

    Valid values:

    • IPV4
    • DUAL

    The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

  • optionGroupName :: Maybe Text

    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.

    This setting doesn't apply to RDS Custom.

  • performanceInsightsKMSKeyId :: Maybe Text

    The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

    This setting doesn't apply to RDS Custom.

  • performanceInsightsRetentionPeriod :: Maybe Int

    The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

    • 7
    • month * 31, where month is a number of months from 1-23
    • 731

    For example, the following values are valid:

    • 93 (3 months * 31)
    • 341 (11 months * 31)
    • 589 (19 months * 31)
    • 731

    If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

    This setting doesn't apply to RDS Custom.

  • port :: Maybe Int

    The port number that the DB instance uses for connections.

    Default: Inherits from the source DB instance

    Valid Values: 1150-65535

  • preSignedUrl :: Maybe Text

    When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.

    This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

    You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

    The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

    • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.

      For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation 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 Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

    If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

    SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.

    This setting doesn't apply to RDS Custom.

  • processorFeatures :: Maybe [ProcessorFeature]

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    This setting doesn't apply to RDS Custom.

  • publiclyAccessible :: Maybe Bool

    A value that indicates whether the DB instance is publicly accessible.

    When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster 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.

  • replicaMode :: Maybe 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 Database 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.

    For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually.

  • storageThroughput :: Maybe Int

    Specifies the storage throughput value for the read replica.

    This setting doesn't apply to RDS Custom or Amazon Aurora.

  • storageType :: Maybe Text

    Specifies the storage type to be associated with the read replica.

    Valid values: gp2 | gp3 | io1 | standard

    If you specify io1 or gp3, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified, otherwise gp2

  • tags :: Maybe [Tag]
     
  • useDefaultProcessorFeatures :: Maybe Bool

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    This setting doesn't apply to RDS Custom.

  • vpcSecurityGroupIds :: Maybe [Text]

    A list of Amazon EC2 VPC security groups to associate with the read replica.

    This setting doesn't apply to RDS Custom.

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

  • dbInstanceIdentifier :: Text

    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.

  • sourceDBInstanceIdentifier :: Text

    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 Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
    • If the source DB instance is in a different Amazon Web Services 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 or RDS Custom, which don't support cross-Region replicas.

Instances

Instances details
ToHeaders CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

toHeaders :: CreateDBInstanceReadReplica -> [Header] #

ToPath CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

toPath :: CreateDBInstanceReadReplica -> ByteString #

ToQuery CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

toQuery :: CreateDBInstanceReadReplica -> QueryString #

AWSRequest CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Associated Types

type AWSResponse CreateDBInstanceReadReplica #

Methods

request :: (Service -> Service) -> CreateDBInstanceReadReplica -> Request CreateDBInstanceReadReplica #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDBInstanceReadReplica -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDBInstanceReadReplica))) #

Generic CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Associated Types

type Rep CreateDBInstanceReadReplica :: Type -> Type #

Methods

from :: CreateDBInstanceReadReplica -> Rep CreateDBInstanceReadReplica x #

to :: Rep CreateDBInstanceReadReplica x -> CreateDBInstanceReadReplica #

Read CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

readsPrec :: Int -> ReadS CreateDBInstanceReadReplica #

readList :: ReadS [CreateDBInstanceReadReplica] #

readPrec :: ReadPrec CreateDBInstanceReadReplica #

readListPrec :: ReadPrec [CreateDBInstanceReadReplica] #

Show CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

showsPrec :: Int -> CreateDBInstanceReadReplica -> ShowS #

show :: CreateDBInstanceReadReplica -> String #

showList :: [CreateDBInstanceReadReplica] -> ShowS #

NFData CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

rnf :: CreateDBInstanceReadReplica -> () #

Eq CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

(==) :: CreateDBInstanceReadReplica -> CreateDBInstanceReadReplica -> Bool #

(/=) :: CreateDBInstanceReadReplica -> CreateDBInstanceReadReplica -> Bool #

Hashable CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

hashWithSalt :: Int -> CreateDBInstanceReadReplica -> Int #

hash :: CreateDBInstanceReadReplica -> Int #

type AWSResponse CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

type AWSResponse CreateDBInstanceReadReplica = CreateDBInstanceReadReplicaResponse
type Rep CreateDBInstanceReadReplica Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

type Rep CreateDBInstanceReadReplica = D1 ('MetaData "CreateDBInstanceReadReplica" "Amazonka.RDS.CreateDBInstanceReadReplica" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CreateDBInstanceReadReplica'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "customIamInstanceProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "destinationRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainIAMRoleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "enableCustomerOwnedIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "enableIAMDatabaseAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "enablePerformanceInsights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxAllocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))) :*: ((((S1 ('MetaSel ('Just "monitoringInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "monitoringRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "performanceInsightsRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "preSignedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "processorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorFeature])) :*: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "replicaMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicaMode)) :*: (S1 ('MetaSel ('Just "storageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "useDefaultProcessorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceDBInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))

newCreateDBInstanceReadReplica Source #

Arguments

:: Text

CreateDBInstanceReadReplica

-> Text

$sel:sourceDBInstanceIdentifier:CreateDBInstanceReadReplica'

-> CreateDBInstanceReadReplica 

Create a value of CreateDBInstanceReadReplica with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDBInstanceReadReplica, createDBInstanceReadReplica_autoMinorVersionUpgrade - A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

This setting doesn't apply to RDS Custom.

Default: Inherits from the source DB instance

CreateDBInstanceReadReplica, createDBInstanceReadReplica_availabilityZone - The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_customIamInstanceProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

This setting is required for RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_dbInstanceClass - The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services 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.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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.

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported for RDS Custom.

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

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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 Amazon Web Services Region.
  • If supplied, must match the name of an existing DBSubnetGroup.
  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services 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: mydbsubnetgroup

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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 isn't enabled. For more information, see Deleting a DB Instance.

$sel:destinationRegion:CreateDBInstanceReadReplica', createDBInstanceReadReplica_destinationRegion - Pseudo-parameter used when populating the PreSignedUrl of a cross-region CreateDBInstanceReadReplica request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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.

This setting doesn't apply to RDS Custom.

$sel:domainIAMRoleName:CreateDBInstanceReadReplica', createDBInstanceReadReplica_domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

$sel:enableCloudwatchLogsExports:CreateDBInstanceReadReplica', createDBInstanceReadReplica_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.

This setting doesn't apply to RDS Custom.

$sel:enableCustomerOwnedIp:CreateDBInstanceReadReplica', createDBInstanceReadReplica_enableCustomerOwnedIp - A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

$sel:enableIAMDatabaseAuthentication:CreateDBInstanceReadReplica', createDBInstanceReadReplica_enableIAMDatabaseAuthentication - A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

$sel:enablePerformanceInsights:CreateDBInstanceReadReplica', createDBInstanceReadReplica_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.

This setting doesn't apply to RDS Custom.

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

CreateDBInstanceReadReplica, createDBInstanceReadReplica_kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_maxAllocatedStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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.

This setting doesn't apply to RDS Custom.

Valid Values: 0, 1, 5, 10, 15, 30, 60

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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.

This setting doesn't apply to RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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.

This setting doesn't apply to RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_networkType - The network type of the DB instance.

Valid values:

  • IPV4
  • DUAL

The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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.

This setting doesn't apply to RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_performanceInsightsKMSKeyId - The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7
  • month * 31, where month is a number of months from 1-23
  • 731

For example, the following values are valid:

  • 93 (3 months * 31)
  • 341 (11 months * 31)
  • 589 (19 months * 31)
  • 731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

This setting doesn't apply to RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_port - The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

$sel:preSignedUrl:CreateDBInstanceReadReplica', createDBInstanceReadReplica_preSignedUrl - When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation 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 Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.

This setting doesn't apply to RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_publiclyAccessible - A value that indicates whether the DB instance is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster 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.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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 Database 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.

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_storageThroughput - Specifies the storage throughput value for the read replica.

This setting doesn't apply to RDS Custom or Amazon Aurora.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_storageType - Specifies the storage type to be associated with the read replica.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

$sel:tags:CreateDBInstanceReadReplica', createDBInstanceReadReplica_tags - Undocumented member.

$sel:useDefaultProcessorFeatures:CreateDBInstanceReadReplica', createDBInstanceReadReplica_useDefaultProcessorFeatures - A value that indicates whether the DB instance class of the DB instance uses its default processor features.

This setting doesn't apply to RDS Custom.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_vpcSecurityGroupIds - A list of Amazon EC2 VPC security groups to associate with the read replica.

This setting doesn't apply to RDS Custom.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

CreateDBInstanceReadReplica, createDBInstanceReadReplica_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.

$sel:sourceDBInstanceIdentifier:CreateDBInstanceReadReplica', createDBInstanceReadReplica_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 Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
  • If the source DB instance is in a different Amazon Web Services 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 or RDS Custom, which don't support cross-Region replicas.

Request Lenses

createDBInstanceReadReplica_autoMinorVersionUpgrade :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

This setting doesn't apply to RDS Custom.

Default: Inherits from the source DB instance

createDBInstanceReadReplica_availabilityZone :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

createDBInstanceReadReplica_copyTagsToSnapshot :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

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.

createDBInstanceReadReplica_customIamInstanceProfile :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

This setting is required for RDS Custom.

createDBInstanceReadReplica_dbInstanceClass :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services 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.

createDBInstanceReadReplica_dbParameterGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

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.

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported for RDS Custom.

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

createDBInstanceReadReplica_dbSubnetGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

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 Amazon Web Services Region.
  • If supplied, must match the name of an existing DBSubnetGroup.
  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services 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: mydbsubnetgroup

createDBInstanceReadReplica_deletionProtection :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

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 isn't enabled. For more information, see Deleting a DB Instance.

createDBInstanceReadReplica_destinationRegion :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

Pseudo-parameter used when populating the PreSignedUrl of a cross-region CreateDBInstanceReadReplica request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

createDBInstanceReadReplica_domain :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

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.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_domainIAMRoleName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_enableCloudwatchLogsExports :: Lens' CreateDBInstanceReadReplica (Maybe [Text]) Source #

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.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_enableCustomerOwnedIp :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

createDBInstanceReadReplica_enableIAMDatabaseAuthentication :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_enablePerformanceInsights :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

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.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_iops :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

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

createDBInstanceReadReplica_kmsKeyId :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.

createDBInstanceReadReplica_maxAllocatedStorage :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

createDBInstanceReadReplica_monitoringInterval :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

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.

This setting doesn't apply to RDS Custom.

Valid Values: 0, 1, 5, 10, 15, 30, 60

createDBInstanceReadReplica_monitoringRoleArn :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

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.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_multiAZ :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

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.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_networkType :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The network type of the DB instance.

Valid values:

  • IPV4
  • DUAL

The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

createDBInstanceReadReplica_optionGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

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.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_performanceInsightsKMSKeyId :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_performanceInsightsRetentionPeriod :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7
  • month * 31, where month is a number of months from 1-23
  • 731

For example, the following values are valid:

  • 93 (3 months * 31)
  • 341 (11 months * 31)
  • 589 (19 months * 31)
  • 731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_port :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

createDBInstanceReadReplica_preSignedUrl :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation 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 Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_processorFeatures :: Lens' CreateDBInstanceReadReplica (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_publiclyAccessible :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether the DB instance is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster 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.

createDBInstanceReadReplica_replicaMode :: Lens' CreateDBInstanceReadReplica (Maybe ReplicaMode) Source #

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 Database 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.

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually.

createDBInstanceReadReplica_storageThroughput :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

Specifies the storage throughput value for the read replica.

This setting doesn't apply to RDS Custom or Amazon Aurora.

createDBInstanceReadReplica_storageType :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

Specifies the storage type to be associated with the read replica.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

createDBInstanceReadReplica_tags :: Lens' CreateDBInstanceReadReplica (Maybe [Tag]) Source #

Undocumented member.

createDBInstanceReadReplica_useDefaultProcessorFeatures :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_vpcSecurityGroupIds :: Lens' CreateDBInstanceReadReplica (Maybe [Text]) Source #

A list of Amazon EC2 VPC security groups to associate with the read replica.

This setting doesn't apply to RDS Custom.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

createDBInstanceReadReplica_dbInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text Source #

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.

createDBInstanceReadReplica_sourceDBInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text Source #

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 Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
  • If the source DB instance is in a different Amazon Web Services 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 or RDS Custom, which don't support cross-Region replicas.

Destructuring the Response

data CreateDBInstanceReadReplicaResponse Source #

See: newCreateDBInstanceReadReplicaResponse smart constructor.

Constructors

CreateDBInstanceReadReplicaResponse' 

Fields

Instances

Instances details
Generic CreateDBInstanceReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Associated Types

type Rep CreateDBInstanceReadReplicaResponse :: Type -> Type #

Methods

from :: CreateDBInstanceReadReplicaResponse -> Rep CreateDBInstanceReadReplicaResponse x #

to :: Rep CreateDBInstanceReadReplicaResponse x -> CreateDBInstanceReadReplicaResponse #

Read CreateDBInstanceReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

readsPrec :: Int -> ReadS CreateDBInstanceReadReplicaResponse #

readList :: ReadS [CreateDBInstanceReadReplicaResponse] #

readPrec :: ReadPrec CreateDBInstanceReadReplicaResponse #

readListPrec :: ReadPrec [CreateDBInstanceReadReplicaResponse] #

Show CreateDBInstanceReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

showsPrec :: Int -> CreateDBInstanceReadReplicaResponse -> ShowS #

show :: CreateDBInstanceReadReplicaResponse -> String #

showList :: [CreateDBInstanceReadReplicaResponse] -> ShowS #

NFData CreateDBInstanceReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

rnf :: CreateDBInstanceReadReplicaResponse -> () #

Eq CreateDBInstanceReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

Methods

(==) :: CreateDBInstanceReadReplicaResponse -> CreateDBInstanceReadReplicaResponse -> Bool #

(/=) :: CreateDBInstanceReadReplicaResponse -> CreateDBInstanceReadReplicaResponse -> Bool #

type Rep CreateDBInstanceReadReplicaResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBInstanceReadReplica

type Rep CreateDBInstanceReadReplicaResponse = D1 ('MetaData "CreateDBInstanceReadReplicaResponse" "Amazonka.RDS.CreateDBInstanceReadReplica" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CreateDBInstanceReadReplicaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBInstanceReadReplicaResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateDBInstanceReadReplicaResponse'

-> CreateDBInstanceReadReplicaResponse 

Create a value of CreateDBInstanceReadReplicaResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbInstance:CreateDBInstanceReadReplicaResponse', createDBInstanceReadReplicaResponse_dbInstance - Undocumented member.

$sel:httpStatus:CreateDBInstanceReadReplicaResponse', createDBInstanceReadReplicaResponse_httpStatus - The response's http status code.

Response Lenses

createDBInstanceReadReplicaResponse_dbInstance :: Lens' CreateDBInstanceReadReplicaResponse (Maybe DBInstance) Source #

Undocumented member.

createDBInstanceReadReplicaResponse_httpStatus :: Lens' CreateDBInstanceReadReplicaResponse Int Source #

The response's http status code.