Network.AWS.RDS.CreateDBCluster

Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Creating a Request

createDBCluster

Arguments

:: Text

cdcDBClusterIdentifier

-> Text

cdcEngine

-> CreateDBCluster

Creates a value of CreateDBCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdcEngineVersion - The version number of the database engine to use. Aurora Example: 5.6.10a
• cdcStorageEncrypted - Specifies whether the DB cluster is encrypted.
• cdcMasterUserPassword - The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
• cdcReplicationSourceIdentifier - The Amazon Resource Name (ARN) of the source DB cluster if this DB cluster is created as a Read Replica.
• cdcMasterUsername - The name of the master user for the DB cluster. Constraints: * Must be 1 to 16 alphanumeric characters. * First character must be a letter. * Cannot be a reserved word for the chosen database engine.
• cdcDBSubnetGroupName - A DB subnet group to associate with this DB cluster. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
• cdcPreferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
• cdcAvailabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones .
• cdcCharacterSetName - A value that indicates that the DB cluster should be associated with the specified CharacterSet.
• cdcKMSKeyId - The KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
• cdcPreferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: * Must be in the format hh24:mi-hh24:mi . * Times should be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes.
• cdcBackupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: * Must be a value from 1 to 35
• cdcVPCSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster.
• cdcDatabaseName - The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
• cdcDBClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used. Constraints: * Must be 1 to 255 alphanumeric characters * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens
• cdcOptionGroupName - A value that indicates that the DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
• cdcTags - Undocumented member.
• cdcPort - The port number on which the instances in the DB cluster accept connections. Default: 3306
• cdcDBClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 alphanumeric characters or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
• cdcEngine - The name of the database engine to be used for this DB cluster. Valid Values: aurora

data CreateDBCluster

See: createDBCluster smart constructor.

Instances

Eq CreateDBCluster

Methods

(==) :: CreateDBCluster -> CreateDBCluster -> Bool

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

Data CreateDBCluster

Methods

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

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

toConstr :: CreateDBCluster -> Constr

dataTypeOf :: CreateDBCluster -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateDBCluster

Methods

readsPrec :: Int -> ReadS CreateDBCluster

readList :: ReadS [CreateDBCluster]

readPrec :: ReadPrec CreateDBCluster

readListPrec :: ReadPrec [CreateDBCluster]

Show CreateDBCluster

Methods

showsPrec :: Int -> CreateDBCluster -> ShowS

show :: CreateDBCluster -> String

showList :: [CreateDBCluster] -> ShowS

Generic CreateDBCluster

Associated Types

type Rep CreateDBCluster :: * -> *

Methods

from :: CreateDBCluster -> Rep CreateDBCluster x

to :: Rep CreateDBCluster x -> CreateDBCluster

Hashable CreateDBCluster

Methods

hashWithSalt :: Int -> CreateDBCluster -> Int

hash :: CreateDBCluster -> Int

NFData CreateDBCluster

Methods

rnf :: CreateDBCluster -> ()

AWSRequest CreateDBCluster

Associated Types

type Rs CreateDBCluster :: *

Methods

request :: CreateDBCluster -> Request CreateDBCluster

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

ToPath CreateDBCluster

Methods

toPath :: CreateDBCluster -> ByteString

ToHeaders CreateDBCluster

Methods

toHeaders :: CreateDBCluster -> [Header]

ToQuery CreateDBCluster

Methods

toQuery :: CreateDBCluster -> QueryString

type Rep CreateDBCluster

type Rep CreateDBCluster = D1 (MetaData "CreateDBCluster" "Network.AWS.RDS.CreateDBCluster" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "CreateDBCluster'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdcEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdcStorageEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdcMasterUserPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cdcReplicationSourceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdcMasterUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdcDBSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdcPreferredMaintenanceWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdcAvailabilityZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_cdcCharacterSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdcKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdcPreferredBackupWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdcBackupRetentionPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdcVPCSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_cdcDatabaseName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdcDBClusterParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdcOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdcTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag])))) ((:*:) (S1 (MetaSel (Just Symbol "_cdcPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_cdcDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cdcEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))))

type Rs CreateDBCluster

type Rs CreateDBCluster = CreateDBClusterResponse

Request Lenses

cdcEngineVersion :: Lens' CreateDBCluster (Maybe Text)

The version number of the database engine to use. Aurora Example: 5.6.10a

cdcStorageEncrypted :: Lens' CreateDBCluster (Maybe Bool)

Specifies whether the DB cluster is encrypted.

cdcMasterUserPassword :: Lens' CreateDBCluster (Maybe Text)

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.

cdcReplicationSourceIdentifier :: Lens' CreateDBCluster (Maybe Text)

The Amazon Resource Name (ARN) of the source DB cluster if this DB cluster is created as a Read Replica.

cdcMasterUsername :: Lens' CreateDBCluster (Maybe Text)

The name of the master user for the DB cluster. Constraints: * Must be 1 to 16 alphanumeric characters. * First character must be a letter. * Cannot be a reserved word for the chosen database engine.

cdcDBSubnetGroupName :: Lens' CreateDBCluster (Maybe Text)

A DB subnet group to associate with this DB cluster. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup

cdcPreferredMaintenanceWindow :: Lens' CreateDBCluster (Maybe Text)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.

cdcAvailabilityZones :: Lens' CreateDBCluster [Text]

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones .

cdcCharacterSetName :: Lens' CreateDBCluster (Maybe Text)

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

cdcKMSKeyId :: Lens' CreateDBCluster (Maybe Text)

The KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

cdcPreferredBackupWindow :: Lens' CreateDBCluster (Maybe Text)

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: * Must be in the format hh24:mi-hh24:mi . * Times should be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes.

cdcBackupRetentionPeriod :: Lens' CreateDBCluster (Maybe Int)

The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: * Must be a value from 1 to 35

cdcVPCSecurityGroupIds :: Lens' CreateDBCluster [Text]

A list of EC2 VPC security groups to associate with this DB cluster.

cdcDatabaseName :: Lens' CreateDBCluster (Maybe Text)

The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

cdcDBClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text)

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used. Constraints: * Must be 1 to 255 alphanumeric characters * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens

cdcOptionGroupName :: Lens' CreateDBCluster (Maybe Text)

A value that indicates that the DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

cdcTags :: Lens' CreateDBCluster [Tag]

Undocumented member.

cdcPort :: Lens' CreateDBCluster (Maybe Int)

The port number on which the instances in the DB cluster accept connections. Default: 3306

cdcDBClusterIdentifier :: Lens' CreateDBCluster Text

The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 alphanumeric characters or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1

cdcEngine :: Lens' CreateDBCluster Text

The name of the database engine to be used for this DB cluster. Valid Values: aurora

Destructuring the Response

createDBClusterResponse

Arguments

:: Int

cdcrsResponseStatus

-> CreateDBClusterResponse

Creates a value of CreateDBClusterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdcrsDBCluster - Undocumented member.
• cdcrsResponseStatus - -- | The response status code.

data CreateDBClusterResponse

See: createDBClusterResponse smart constructor.

Instances

Eq CreateDBClusterResponse

Methods

(==) :: CreateDBClusterResponse -> CreateDBClusterResponse -> Bool

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

Data CreateDBClusterResponse

Methods

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

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

toConstr :: CreateDBClusterResponse -> Constr

dataTypeOf :: CreateDBClusterResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateDBClusterResponse

Methods

readsPrec :: Int -> ReadS CreateDBClusterResponse

readList :: ReadS [CreateDBClusterResponse]

readPrec :: ReadPrec CreateDBClusterResponse

readListPrec :: ReadPrec [CreateDBClusterResponse]

Show CreateDBClusterResponse

Methods

showsPrec :: Int -> CreateDBClusterResponse -> ShowS

show :: CreateDBClusterResponse -> String

showList :: [CreateDBClusterResponse] -> ShowS

Generic CreateDBClusterResponse

Associated Types

type Rep CreateDBClusterResponse :: * -> *

Methods

from :: CreateDBClusterResponse -> Rep CreateDBClusterResponse x

to :: Rep CreateDBClusterResponse x -> CreateDBClusterResponse

NFData CreateDBClusterResponse

Methods

rnf :: CreateDBClusterResponse -> ()

type Rep CreateDBClusterResponse

type Rep CreateDBClusterResponse = D1 (MetaData "CreateDBClusterResponse" "Network.AWS.RDS.CreateDBCluster" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "CreateDBClusterResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cdcrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBCluster))) (S1 (MetaSel (Just Symbol "_cdcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cdcrsDBCluster :: Lens' CreateDBClusterResponse (Maybe DBCluster)

Undocumented member.

cdcrsResponseStatus :: Lens' CreateDBClusterResponse Int

• - | The response status code.