Network.AWS.RDS.CreateDBInstanceReadReplica

Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.

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

Important: The source DB instance must have backup retention enabled.

Creating a Request

createDBInstanceReadReplica

Arguments

:: Text

cdirrDBInstanceIdentifier

-> Text

cdirrSourceDBInstanceIdentifier

-> 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 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.
• cdirrAutoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance
• cdirrDBSubnetGroupName - 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. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
• cdirrMonitoringRoleARN - The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring . If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
• 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. 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
• cdirrDBInstanceClass - The compute and memory capacity of the Read Replica. Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large Default: Inherits from the source DB instance.
• cdirrAvailabilityZone - 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
• cdirrOptionGroupName - The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
• cdirrCopyTagsToSnapshot - True to copy all tags from the Read Replica to snapshots of the Read Replica; 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
• cdirrStorageType - 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
• 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 Read Replica only if the source is running PostgreSQL 9.3.5. * The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0. * If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier. * If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN) .

data CreateDBInstanceReadReplica

See: createDBInstanceReadReplica smart constructor.

Instances

Eq CreateDBInstanceReadReplica

Methods

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

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

Data CreateDBInstanceReadReplica

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDBInstanceReadReplica -> c CreateDBInstanceReadReplica

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDBInstanceReadReplica

toConstr :: CreateDBInstanceReadReplica -> Constr

dataTypeOf :: CreateDBInstanceReadReplica -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateDBInstanceReadReplica)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDBInstanceReadReplica)

gmapT :: (forall b. Data b => b -> b) -> CreateDBInstanceReadReplica -> CreateDBInstanceReadReplica

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDBInstanceReadReplica -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDBInstanceReadReplica -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDBInstanceReadReplica -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDBInstanceReadReplica -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDBInstanceReadReplica -> m CreateDBInstanceReadReplica

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDBInstanceReadReplica -> m CreateDBInstanceReadReplica

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDBInstanceReadReplica -> m CreateDBInstanceReadReplica

Read CreateDBInstanceReadReplica

Methods

readsPrec :: Int -> ReadS CreateDBInstanceReadReplica

readList :: ReadS [CreateDBInstanceReadReplica]

readPrec :: ReadPrec CreateDBInstanceReadReplica

readListPrec :: ReadPrec [CreateDBInstanceReadReplica]

Show CreateDBInstanceReadReplica

Methods

showsPrec :: Int -> CreateDBInstanceReadReplica -> ShowS

show :: CreateDBInstanceReadReplica -> String

showList :: [CreateDBInstanceReadReplica] -> ShowS

Generic CreateDBInstanceReadReplica

Associated Types

type Rep CreateDBInstanceReadReplica :: * -> *

Methods

from :: CreateDBInstanceReadReplica -> Rep CreateDBInstanceReadReplica x

to :: Rep CreateDBInstanceReadReplica x -> CreateDBInstanceReadReplica

Hashable CreateDBInstanceReadReplica

Methods

hashWithSalt :: Int -> CreateDBInstanceReadReplica -> Int

hash :: CreateDBInstanceReadReplica -> Int

NFData CreateDBInstanceReadReplica

Methods

rnf :: CreateDBInstanceReadReplica -> ()

AWSRequest CreateDBInstanceReadReplica

Associated Types

type Rs CreateDBInstanceReadReplica :: *

Methods

request :: CreateDBInstanceReadReplica -> Request CreateDBInstanceReadReplica

response :: MonadResource m => Logger -> Service -> Proxy * CreateDBInstanceReadReplica -> ClientResponse -> m (Response CreateDBInstanceReadReplica)

ToPath CreateDBInstanceReadReplica

Methods

toPath :: CreateDBInstanceReadReplica -> ByteString

ToHeaders CreateDBInstanceReadReplica

Methods

toHeaders :: CreateDBInstanceReadReplica -> [Header]

ToQuery CreateDBInstanceReadReplica

Methods

toQuery :: CreateDBInstanceReadReplica -> QueryString

type Rep CreateDBInstanceReadReplica

type Rep CreateDBInstanceReadReplica = D1 (MetaData "CreateDBInstanceReadReplica" "Network.AWS.RDS.CreateDBInstanceReadReplica" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "CreateDBInstanceReadReplica'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrPubliclyAccessible") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrAutoMinorVersionUpgrade") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_cdirrDBSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrMonitoringRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdirrIOPS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrMonitoringInterval") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_cdirrDBInstanceClass") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrAvailabilityZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdirrOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrCopyTagsToSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_cdirrTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_cdirrStorageType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cdirrSourceDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateDBInstanceReadReplica

type Rs CreateDBInstanceReadReplica = CreateDBInstanceReadReplicaResponse

Request Lenses

cdirrPubliclyAccessible :: Lens' CreateDBInstanceReadReplica (Maybe Bool)

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.

cdirrAutoMinorVersionUpgrade :: Lens' CreateDBInstanceReadReplica (Maybe Bool)

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance

cdirrDBSubnetGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text)

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. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup

cdirrMonitoringRoleARN :: Lens' CreateDBInstanceReadReplica (Maybe Text)

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring . If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

cdirrIOPS :: Lens' CreateDBInstanceReadReplica (Maybe Int)

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

cdirrMonitoringInterval :: Lens' CreateDBInstanceReadReplica (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. Valid Values: 0, 1, 5, 10, 15, 30, 60

cdirrDBInstanceClass :: Lens' CreateDBInstanceReadReplica (Maybe Text)

The compute and memory capacity of the Read Replica. Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large Default: Inherits from the source DB instance.

cdirrAvailabilityZone :: Lens' CreateDBInstanceReadReplica (Maybe Text)

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

cdirrOptionGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text)

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

cdirrCopyTagsToSnapshot :: Lens' CreateDBInstanceReadReplica (Maybe Bool)

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

cdirrTags :: Lens' CreateDBInstanceReadReplica [Tag]

Undocumented member.

cdirrPort :: Lens' CreateDBInstanceReadReplica (Maybe Int)

The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535

cdirrStorageType :: Lens' CreateDBInstanceReadReplica (Maybe Text)

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

cdirrDBInstanceIdentifier :: Lens' CreateDBInstanceReadReplica 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.

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

Destructuring the Response

createDBInstanceReadReplicaResponse

Arguments

:: Int

cdirrrsResponseStatus

-> CreateDBInstanceReadReplicaResponse

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

See: createDBInstanceReadReplicaResponse smart constructor.

Instances

Eq CreateDBInstanceReadReplicaResponse

Methods

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

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

Data CreateDBInstanceReadReplicaResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDBInstanceReadReplicaResponse -> c CreateDBInstanceReadReplicaResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDBInstanceReadReplicaResponse

toConstr :: CreateDBInstanceReadReplicaResponse -> Constr

dataTypeOf :: CreateDBInstanceReadReplicaResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateDBInstanceReadReplicaResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDBInstanceReadReplicaResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateDBInstanceReadReplicaResponse -> CreateDBInstanceReadReplicaResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDBInstanceReadReplicaResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDBInstanceReadReplicaResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDBInstanceReadReplicaResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDBInstanceReadReplicaResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDBInstanceReadReplicaResponse -> m CreateDBInstanceReadReplicaResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDBInstanceReadReplicaResponse -> m CreateDBInstanceReadReplicaResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDBInstanceReadReplicaResponse -> m CreateDBInstanceReadReplicaResponse

Read CreateDBInstanceReadReplicaResponse

Methods

readsPrec :: Int -> ReadS CreateDBInstanceReadReplicaResponse

readList :: ReadS [CreateDBInstanceReadReplicaResponse]

readPrec :: ReadPrec CreateDBInstanceReadReplicaResponse

readListPrec :: ReadPrec [CreateDBInstanceReadReplicaResponse]

Show CreateDBInstanceReadReplicaResponse

Methods

showsPrec :: Int -> CreateDBInstanceReadReplicaResponse -> ShowS

show :: CreateDBInstanceReadReplicaResponse -> String

showList :: [CreateDBInstanceReadReplicaResponse] -> ShowS

Generic CreateDBInstanceReadReplicaResponse

Associated Types

type Rep CreateDBInstanceReadReplicaResponse :: * -> *

Methods

from :: CreateDBInstanceReadReplicaResponse -> Rep CreateDBInstanceReadReplicaResponse x

to :: Rep CreateDBInstanceReadReplicaResponse x -> CreateDBInstanceReadReplicaResponse

NFData CreateDBInstanceReadReplicaResponse

Methods

rnf :: CreateDBInstanceReadReplicaResponse -> ()

type Rep CreateDBInstanceReadReplicaResponse

type Rep CreateDBInstanceReadReplicaResponse = D1 (MetaData "CreateDBInstanceReadReplicaResponse" "Network.AWS.RDS.CreateDBInstanceReadReplica" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "CreateDBInstanceReadReplicaResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cdirrrsDBInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBInstance))) (S1 (MetaSel (Just Symbol "_cdirrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cdirrrsDBInstance :: Lens' CreateDBInstanceReadReplicaResponse (Maybe DBInstance)

Undocumented member.

cdirrrsResponseStatus :: Lens' CreateDBInstanceReadReplicaResponse Int

• - | The response status code.