{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.RDS.CreateDBCluster -- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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 in the /Amazon RDS User Guide./ -- module Network.AWS.RDS.CreateDBCluster ( -- * Creating a Request createDBCluster , CreateDBCluster -- * Request Lenses , cdcEngineVersion , cdcStorageEncrypted , cdcMasterUserPassword , cdcReplicationSourceIdentifier , cdcMasterUsername , cdcDBSubnetGroupName , cdcPreferredMaintenanceWindow , cdcAvailabilityZones , cdcCharacterSetName , cdcKMSKeyId , cdcPreferredBackupWindow , cdcBackupRetentionPeriod , cdcVPCSecurityGroupIds , cdcDatabaseName , cdcDBClusterParameterGroupName , cdcOptionGroupName , cdcTags , cdcPort , cdcDBClusterIdentifier , cdcEngine -- * Destructuring the Response , createDBClusterResponse , CreateDBClusterResponse -- * Response Lenses , cdcrsDBCluster , cdcrsResponseStatus ) where import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.RDS.Types import Network.AWS.RDS.Types.Product import Network.AWS.Request import Network.AWS.Response -- | -- -- -- -- /See:/ 'createDBCluster' smart constructor. data CreateDBCluster = CreateDBCluster' { _cdcEngineVersion :: !(Maybe Text) , _cdcStorageEncrypted :: !(Maybe Bool) , _cdcMasterUserPassword :: !(Maybe Text) , _cdcReplicationSourceIdentifier :: !(Maybe Text) , _cdcMasterUsername :: !(Maybe Text) , _cdcDBSubnetGroupName :: !(Maybe Text) , _cdcPreferredMaintenanceWindow :: !(Maybe Text) , _cdcAvailabilityZones :: !(Maybe [Text]) , _cdcCharacterSetName :: !(Maybe Text) , _cdcKMSKeyId :: !(Maybe Text) , _cdcPreferredBackupWindow :: !(Maybe Text) , _cdcBackupRetentionPeriod :: !(Maybe Int) , _cdcVPCSecurityGroupIds :: !(Maybe [Text]) , _cdcDatabaseName :: !(Maybe Text) , _cdcDBClusterParameterGroupName :: !(Maybe Text) , _cdcOptionGroupName :: !(Maybe Text) , _cdcTags :: !(Maybe [Tag]) , _cdcPort :: !(Maybe Int) , _cdcDBClusterIdentifier :: !Text , _cdcEngine :: !Text } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | 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 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 . -- -- * '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 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@ createDBCluster :: Text -- ^ 'cdcDBClusterIdentifier' -> Text -- ^ 'cdcEngine' -> CreateDBCluster createDBCluster pDBClusterIdentifier_ pEngine_ = CreateDBCluster' { _cdcEngineVersion = Nothing , _cdcStorageEncrypted = Nothing , _cdcMasterUserPassword = Nothing , _cdcReplicationSourceIdentifier = Nothing , _cdcMasterUsername = Nothing , _cdcDBSubnetGroupName = Nothing , _cdcPreferredMaintenanceWindow = Nothing , _cdcAvailabilityZones = Nothing , _cdcCharacterSetName = Nothing , _cdcKMSKeyId = Nothing , _cdcPreferredBackupWindow = Nothing , _cdcBackupRetentionPeriod = Nothing , _cdcVPCSecurityGroupIds = Nothing , _cdcDatabaseName = Nothing , _cdcDBClusterParameterGroupName = Nothing , _cdcOptionGroupName = Nothing , _cdcTags = Nothing , _cdcPort = Nothing , _cdcDBClusterIdentifier = pDBClusterIdentifier_ , _cdcEngine = pEngine_ } -- | The version number of the database engine to use. __Aurora__ Example: @5.6.10a@ cdcEngineVersion :: Lens' CreateDBCluster (Maybe Text) cdcEngineVersion = lens _cdcEngineVersion (\ s a -> s{_cdcEngineVersion = a}); -- | Specifies whether the DB cluster is encrypted. cdcStorageEncrypted :: Lens' CreateDBCluster (Maybe Bool) cdcStorageEncrypted = lens _cdcStorageEncrypted (\ s a -> s{_cdcStorageEncrypted = a}); -- | 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. cdcMasterUserPassword :: Lens' CreateDBCluster (Maybe Text) cdcMasterUserPassword = lens _cdcMasterUserPassword (\ s a -> s{_cdcMasterUserPassword = a}); -- | The Amazon Resource Name (ARN) of the source DB cluster if this DB cluster is created as a Read Replica. cdcReplicationSourceIdentifier :: Lens' CreateDBCluster (Maybe Text) cdcReplicationSourceIdentifier = lens _cdcReplicationSourceIdentifier (\ s a -> s{_cdcReplicationSourceIdentifier = a}); -- | 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. cdcMasterUsername :: Lens' CreateDBCluster (Maybe Text) cdcMasterUsername = lens _cdcMasterUsername (\ s a -> s{_cdcMasterUsername = a}); -- | 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@ cdcDBSubnetGroupName :: Lens' CreateDBCluster (Maybe Text) cdcDBSubnetGroupName = lens _cdcDBSubnetGroupName (\ s a -> s{_cdcDBSubnetGroupName = a}); -- | 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 in the /Amazon RDS User Guide./ Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. cdcPreferredMaintenanceWindow :: Lens' CreateDBCluster (Maybe Text) cdcPreferredMaintenanceWindow = lens _cdcPreferredMaintenanceWindow (\ s a -> s{_cdcPreferredMaintenanceWindow = a}); -- | A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see . cdcAvailabilityZones :: Lens' CreateDBCluster [Text] cdcAvailabilityZones = lens _cdcAvailabilityZones (\ s a -> s{_cdcAvailabilityZones = a}) . _Default . _Coerce; -- | A value that indicates that the DB cluster should be associated with the specified CharacterSet. cdcCharacterSetName :: Lens' CreateDBCluster (Maybe Text) cdcCharacterSetName = lens _cdcCharacterSetName (\ s a -> s{_cdcCharacterSetName = a}); -- | 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. cdcKMSKeyId :: Lens' CreateDBCluster (Maybe Text) cdcKMSKeyId = lens _cdcKMSKeyId (\ s a -> s{_cdcKMSKeyId = a}); -- | 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 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. cdcPreferredBackupWindow :: Lens' CreateDBCluster (Maybe Text) cdcPreferredBackupWindow = lens _cdcPreferredBackupWindow (\ s a -> s{_cdcPreferredBackupWindow = a}); -- | 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 cdcBackupRetentionPeriod :: Lens' CreateDBCluster (Maybe Int) cdcBackupRetentionPeriod = lens _cdcBackupRetentionPeriod (\ s a -> s{_cdcBackupRetentionPeriod = a}); -- | A list of EC2 VPC security groups to associate with this DB cluster. cdcVPCSecurityGroupIds :: Lens' CreateDBCluster [Text] cdcVPCSecurityGroupIds = lens _cdcVPCSecurityGroupIds (\ s a -> s{_cdcVPCSecurityGroupIds = a}) . _Default . _Coerce; -- | 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. cdcDatabaseName :: Lens' CreateDBCluster (Maybe Text) cdcDatabaseName = lens _cdcDatabaseName (\ s a -> s{_cdcDatabaseName = a}); -- | 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 cdcDBClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text) cdcDBClusterParameterGroupName = lens _cdcDBClusterParameterGroupName (\ s a -> s{_cdcDBClusterParameterGroupName = a}); -- | 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. cdcOptionGroupName :: Lens' CreateDBCluster (Maybe Text) cdcOptionGroupName = lens _cdcOptionGroupName (\ s a -> s{_cdcOptionGroupName = a}); -- | Undocumented member. cdcTags :: Lens' CreateDBCluster [Tag] cdcTags = lens _cdcTags (\ s a -> s{_cdcTags = a}) . _Default . _Coerce; -- | The port number on which the instances in the DB cluster accept connections. Default: @3306@ cdcPort :: Lens' CreateDBCluster (Maybe Int) cdcPort = lens _cdcPort (\ s a -> s{_cdcPort = a}); -- | 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@ cdcDBClusterIdentifier :: Lens' CreateDBCluster Text cdcDBClusterIdentifier = lens _cdcDBClusterIdentifier (\ s a -> s{_cdcDBClusterIdentifier = a}); -- | The name of the database engine to be used for this DB cluster. Valid Values: @aurora@ cdcEngine :: Lens' CreateDBCluster Text cdcEngine = lens _cdcEngine (\ s a -> s{_cdcEngine = a}); instance AWSRequest CreateDBCluster where type Rs CreateDBCluster = CreateDBClusterResponse request = postQuery rds response = receiveXMLWrapper "CreateDBClusterResult" (\ s h x -> CreateDBClusterResponse' <$> (x .@? "DBCluster") <*> (pure (fromEnum s))) instance Hashable CreateDBCluster instance NFData CreateDBCluster instance ToHeaders CreateDBCluster where toHeaders = const mempty instance ToPath CreateDBCluster where toPath = const "/" instance ToQuery CreateDBCluster where toQuery CreateDBCluster'{..} = mconcat ["Action" =: ("CreateDBCluster" :: ByteString), "Version" =: ("2014-10-31" :: ByteString), "EngineVersion" =: _cdcEngineVersion, "StorageEncrypted" =: _cdcStorageEncrypted, "MasterUserPassword" =: _cdcMasterUserPassword, "ReplicationSourceIdentifier" =: _cdcReplicationSourceIdentifier, "MasterUsername" =: _cdcMasterUsername, "DBSubnetGroupName" =: _cdcDBSubnetGroupName, "PreferredMaintenanceWindow" =: _cdcPreferredMaintenanceWindow, "AvailabilityZones" =: toQuery (toQueryList "AvailabilityZone" <$> _cdcAvailabilityZones), "CharacterSetName" =: _cdcCharacterSetName, "KmsKeyId" =: _cdcKMSKeyId, "PreferredBackupWindow" =: _cdcPreferredBackupWindow, "BackupRetentionPeriod" =: _cdcBackupRetentionPeriod, "VpcSecurityGroupIds" =: toQuery (toQueryList "VpcSecurityGroupId" <$> _cdcVPCSecurityGroupIds), "DatabaseName" =: _cdcDatabaseName, "DBClusterParameterGroupName" =: _cdcDBClusterParameterGroupName, "OptionGroupName" =: _cdcOptionGroupName, "Tags" =: toQuery (toQueryList "Tag" <$> _cdcTags), "Port" =: _cdcPort, "DBClusterIdentifier" =: _cdcDBClusterIdentifier, "Engine" =: _cdcEngine] -- | /See:/ 'createDBClusterResponse' smart constructor. data CreateDBClusterResponse = CreateDBClusterResponse' { _cdcrsDBCluster :: !(Maybe DBCluster) , _cdcrsResponseStatus :: !Int } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | 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. createDBClusterResponse :: Int -- ^ 'cdcrsResponseStatus' -> CreateDBClusterResponse createDBClusterResponse pResponseStatus_ = CreateDBClusterResponse' { _cdcrsDBCluster = Nothing , _cdcrsResponseStatus = pResponseStatus_ } -- | Undocumented member. cdcrsDBCluster :: Lens' CreateDBClusterResponse (Maybe DBCluster) cdcrsDBCluster = lens _cdcrsDBCluster (\ s a -> s{_cdcrsDBCluster = a}); -- | -- | The response status code. cdcrsResponseStatus :: Lens' CreateDBClusterResponse Int cdcrsResponseStatus = lens _cdcrsResponseStatus (\ s a -> s{_cdcrsResponseStatus = a}); instance NFData CreateDBClusterResponse