amazonka-rds-0.0.3: Amazon Relational Database Service SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.RDS.CreateDBInstanceReadReplica

Contents

Description

Creates a DB instance that acts as a read replica of a source DB instance.

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

The source DB instance must have backup retention enabled.

http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html

Synopsis

Request

data CreateDBInstanceReadReplica Source

Instances

Request constructor

createDBInstanceReadReplica Source

Arguments

:: Text

cdbirrDBInstanceIdentifier

-> Text

cdbirrSourceDBInstanceIdentifier

-> CreateDBInstanceReadReplica 

CreateDBInstanceReadReplica constructor.

The fields accessible through corresponding lenses are:

Request lenses

cdbirrAutoMinorVersionUpgrade :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source

Indicates that minor engine upgrades will be applied automatically to the read replica during the maintenance window.

Default: Inherits from the source DB instance

cdbirrAvailabilityZone :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source

The Amazon EC2 Availability Zone that the read replica will be created in.

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

Example: 'us-east-1d'

cdbirrDBInstanceClass :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source

The compute and memory capacity of the read replica.

Valid Values: 'db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge |db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large |db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium'

Default: Inherits from the source DB instance.

cdbirrDBInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text Source

The DB instance identifier of the read replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

cdbirrDBSubnetGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source

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

Constraints:

Can only be specified if the source DB instance identifier specifies a DB instance in another region. The specified DB subnet group must be in the same region in which the operation is running. All read replicas in one region that are created from the same source DB instance must either: Specify DB subnet groups from the same VPC. All these read replicas will be created in the same VPC. Not specify a DB subnet group. All these read replicas will be created outside of any VPC.

cdbirrIops :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source

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

cdbirrOptionGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source

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

cdbirrPort :: 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'

cdbirrPubliclyAccessible :: 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 will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

cdbirrSourceDBInstanceIdentifier :: 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 DB instance. Can specify a DB instance that is a read replica only if the source is running MySQL 5.6. The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0. If the source DB instance is in the same region as the read replica, specify a valid DB instance identifier. If the source DB instance is in a different region than the read replica, specify a valid DB instance ARN. For more information, go to Constructing aAmazon RDS Amazon Resource Name (ARN).

cdbirrStorageType :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source

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

Valid values: 'standard | gp2 | io1'

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

cdbirrTags :: Lens' CreateDBInstanceReadReplica [Tag] Source

Response

data CreateDBInstanceReadReplicaResponse Source

Instances

Response constructor

createDBInstanceReadReplicaResponse :: CreateDBInstanceReadReplicaResponse Source

CreateDBInstanceReadReplicaResponse constructor.

The fields accessible through corresponding lenses are:

Response lenses

cdbirrrDBInstance :: Lens' CreateDBInstanceReadReplicaResponse (Maybe DBInstance) Source