Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 CreateDBInstance
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.
Important: Your source DB instance must have backup retention enabled.
- createDBInstanceReadReplica :: Text -> Text -> CreateDBInstanceReadReplica
- data CreateDBInstanceReadReplica
- cdirrPubliclyAccessible :: Lens' CreateDBInstanceReadReplica (Maybe Bool)
- cdirrAutoMinorVersionUpgrade :: Lens' CreateDBInstanceReadReplica (Maybe Bool)
- cdirrDBSubnetGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrMonitoringRoleARN :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrIOPS :: Lens' CreateDBInstanceReadReplica (Maybe Int)
- cdirrMonitoringInterval :: Lens' CreateDBInstanceReadReplica (Maybe Int)
- cdirrPreSignedURL :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrDBInstanceClass :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrEnablePerformanceInsights :: Lens' CreateDBInstanceReadReplica (Maybe Bool)
- cdirrKMSKeyId :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrAvailabilityZone :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrPerformanceInsightsKMSKeyId :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrMultiAZ :: Lens' CreateDBInstanceReadReplica (Maybe Bool)
- cdirrOptionGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrCopyTagsToSnapshot :: Lens' CreateDBInstanceReadReplica (Maybe Bool)
- cdirrTags :: Lens' CreateDBInstanceReadReplica [Tag]
- cdirrPort :: Lens' CreateDBInstanceReadReplica (Maybe Int)
- cdirrEnableIAMDatabaseAuthentication :: Lens' CreateDBInstanceReadReplica (Maybe Bool)
- cdirrStorageType :: Lens' CreateDBInstanceReadReplica (Maybe Text)
- cdirrEnableCloudwatchLogsExports :: Lens' CreateDBInstanceReadReplica [Text]
- cdirrDBInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text
- cdirrSourceDBInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text
- createDBInstanceReadReplicaResponse :: Int -> CreateDBInstanceReadReplicaResponse
- data CreateDBInstanceReadReplicaResponse
- cdirrrsDBInstance :: Lens' CreateDBInstanceReadReplicaResponse (Maybe DBInstance)
- cdirrrsResponseStatus :: Lens' CreateDBInstanceReadReplicaResponse Int
Creating a Request
createDBInstanceReadReplica Source #
:: Text | |
-> Text | |
-> CreateDBInstanceReadReplica |
Creates a value of CreateDBInstanceReadReplica
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdirrPubliclyAccessible
- Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. * Default VPC: true * VPC: false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.cdirrAutoMinorVersionUpgrade
- Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instancecdirrDBSubnetGroupName
- Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC. Constraints: * Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region. * If supplied, must match the name of an existing DBSubnetGroup. * The specified DB subnet group must be in the same AWS Region in which the operation is running. * All Read Replicas in one AWS Region that are created from the same source DB instance must either:> * Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC. * Not specify a DB subnet group. All these Read Replicas are created outside of any VPC. Example:mySubnetgroup
cdirrMonitoringRoleARN
- 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 . IfMonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.cdirrIOPS
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.cdirrMonitoringInterval
- 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. IfMonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0. Valid Values:0, 1, 5, 10, 15, 30, 60
cdirrPreSignedURL
- The URL that contains a Signature Version 4 signed request for theCreateDBInstanceReadReplica
API action in the source AWS Region that contains the source DB instance. You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the--source-region
option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for theCreateDBInstanceReadReplica
API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: *DestinationRegion
- The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where theCreateDBInstanceReadReplica
action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call theCreateDBInstanceReadReplica
action in the us-east-1 AWS Region and provide a presigned URL that contains a call to theCreateDBInstanceReadReplica
action in the us-west-2 AWS Region. For this example, theDestinationRegion
in the presigned URL must be set to the us-east-1 AWS Region. *KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both theCreateDBInstanceReadReplica
action that is called in the destination AWS Region, and the action contained in the presigned URL. *SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then yourSourceDBInstanceIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .cdirrDBInstanceClass
- The compute and memory capacity of the Read Replica, for example,db.m4.large
. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: Inherits from the source DB instance.cdirrEnablePerformanceInsights
- True to enable Performance Insights for the read replica, and otherwise false.cdirrKMSKeyId
- 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.cdirrAvailabilityZone
- The Amazon EC2 Availability Zone that the Read Replica is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example:us-east-1d
cdirrPerformanceInsightsKMSKeyId
- 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.cdirrMultiAZ
- 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.cdirrOptionGroupName
- The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.cdirrCopyTagsToSnapshot
- True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.cdirrTags
- Undocumented member.cdirrPort
- The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values:1150-65535
cdirrEnableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines * For MySQL 5.6, minor version 5.6.34 or higher * For MySQL 5.7, minor version 5.7.16 or higher * Aurora 5.6 or higher. Default:false
cdirrStorageType
- Specifies the storage type to be associated with the Read Replica. Valid values:standard | gp2 | io1
If you specifyio1
, you must also include a value for theIops
parameter. Default:io1
if theIops
parameter is specified, otherwisestandard
cdirrEnableCloudwatchLogsExports
- The list of logs that the new DB instance is to export to CloudWatch Logs.cdirrDBInstanceIdentifier
- 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.cdirrSourceDBInstanceIdentifier
- The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas. Constraints: * Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance. * Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6. * Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication). * The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0. * If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier. * If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN) .
data CreateDBInstanceReadReplica Source #
See: createDBInstanceReadReplica
smart constructor.
Request Lenses
cdirrPubliclyAccessible :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. * Default VPC: true * VPC: false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
cdirrAutoMinorVersionUpgrade :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #
Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance
cdirrDBSubnetGroupName :: 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 is not created in a VPC. Constraints: * Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region. * If supplied, must match the name of an existing DBSubnetGroup. * The specified DB subnet group must be in the same AWS Region in which the operation is running. * All Read Replicas in one AWS Region that are created from the same source DB instance must either:> * Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC. * Not specify a DB subnet group. All these Read Replicas are created outside of any VPC. Example: mySubnetgroup
cdirrMonitoringRoleARN :: 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 . If MonitoringInterval
is set to a value other than 0, then you must supply a MonitoringRoleArn
value.
cdirrIOPS :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
cdirrMonitoringInterval :: 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. Valid Values: 0, 1, 5, 10, 15, 30, 60
cdirrPreSignedURL :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica
API action in the source AWS Region that contains the source DB instance. You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region
option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: * DestinationRegion
- The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica
action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica
action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica
action in the us-west-2 AWS Region. For this example, the DestinationRegion
in the presigned URL must be set to the us-east-1 AWS Region. * KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica
action that is called in the destination AWS Region, and the action contained in the presigned URL. * SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier
looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .
cdirrDBInstanceClass :: 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 AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: Inherits from the source DB instance.
cdirrEnablePerformanceInsights :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #
True to enable Performance Insights for the read replica, and otherwise false.
cdirrKMSKeyId :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #
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.
cdirrAvailabilityZone :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #
The Amazon EC2 Availability Zone that the Read Replica is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d
cdirrPerformanceInsightsKMSKeyId :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #
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.
cdirrMultiAZ :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #
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.
cdirrOptionGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #
The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.
cdirrCopyTagsToSnapshot :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #
True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.
cdirrPort :: 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
cdirrEnableIAMDatabaseAuthentication :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines * For MySQL 5.6, minor version 5.6.34 or higher * For MySQL 5.7, minor version 5.7.16 or higher * Aurora 5.6 or higher. Default: false
cdirrStorageType :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #
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
cdirrEnableCloudwatchLogsExports :: Lens' CreateDBInstanceReadReplica [Text] Source #
The list of logs that the new DB instance is to export to CloudWatch Logs.
cdirrDBInstanceIdentifier :: 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.
cdirrSourceDBInstanceIdentifier :: 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, or PostgreSQL DB instance. * Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6. * Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication). * The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0. * If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier. * If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN) .
Destructuring the Response
createDBInstanceReadReplicaResponse Source #
Creates a value of CreateDBInstanceReadReplicaResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdirrrsDBInstance
- Undocumented member.cdirrrsResponseStatus
- -- | The response status code.
data CreateDBInstanceReadReplicaResponse Source #
See: createDBInstanceReadReplicaResponse
smart constructor.
Response Lenses
cdirrrsDBInstance :: Lens' CreateDBInstanceReadReplicaResponse (Maybe DBInstance) Source #
Undocumented member.
cdirrrsResponseStatus :: Lens' CreateDBInstanceReadReplicaResponse Int Source #
- - | The response status code.