Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a new DB instance.
See: AWS API Reference for CreateDBInstance.
- createDBInstance :: Text -> Text -> Text -> CreateDBInstance
- data CreateDBInstance
- cdiDBSecurityGroups :: Lens' CreateDBInstance [Text]
- cdiEngineVersion :: Lens' CreateDBInstance (Maybe Text)
- cdiStorageEncrypted :: Lens' CreateDBInstance (Maybe Bool)
- cdiDBClusterIdentifier :: Lens' CreateDBInstance (Maybe Text)
- cdiAutoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool)
- cdiMasterUserPassword :: Lens' CreateDBInstance (Maybe Text)
- cdiMasterUsername :: Lens' CreateDBInstance (Maybe Text)
- cdiPubliclyAccessible :: Lens' CreateDBInstance (Maybe Bool)
- cdiDBSubnetGroupName :: Lens' CreateDBInstance (Maybe Text)
- cdiIOPS :: Lens' CreateDBInstance (Maybe Int)
- cdiDomain :: Lens' CreateDBInstance (Maybe Text)
- cdiTDECredentialPassword :: Lens' CreateDBInstance (Maybe Text)
- cdiLicenseModel :: Lens' CreateDBInstance (Maybe Text)
- cdiPreferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text)
- cdiCharacterSetName :: Lens' CreateDBInstance (Maybe Text)
- cdiPreferredBackupWindow :: Lens' CreateDBInstance (Maybe Text)
- cdiAvailabilityZone :: Lens' CreateDBInstance (Maybe Text)
- cdiBackupRetentionPeriod :: Lens' CreateDBInstance (Maybe Int)
- cdiKMSKeyId :: Lens' CreateDBInstance (Maybe Text)
- cdiDBParameterGroupName :: Lens' CreateDBInstance (Maybe Text)
- cdiVPCSecurityGroupIds :: Lens' CreateDBInstance [Text]
- cdiMultiAZ :: Lens' CreateDBInstance (Maybe Bool)
- cdiAllocatedStorage :: Lens' CreateDBInstance (Maybe Int)
- cdiTDECredentialARN :: Lens' CreateDBInstance (Maybe Text)
- cdiOptionGroupName :: Lens' CreateDBInstance (Maybe Text)
- cdiCopyTagsToSnapshot :: Lens' CreateDBInstance (Maybe Bool)
- cdiDBName :: Lens' CreateDBInstance (Maybe Text)
- cdiTags :: Lens' CreateDBInstance [Tag]
- cdiPort :: Lens' CreateDBInstance (Maybe Int)
- cdiStorageType :: Lens' CreateDBInstance (Maybe Text)
- cdiDBInstanceIdentifier :: Lens' CreateDBInstance Text
- cdiDBInstanceClass :: Lens' CreateDBInstance Text
- cdiEngine :: Lens' CreateDBInstance Text
- createDBInstanceResponse :: Int -> CreateDBInstanceResponse
- data CreateDBInstanceResponse
- cdirsDBInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance)
- cdirsStatus :: Lens' CreateDBInstanceResponse Int
Creating a Request
Creates a value of CreateDBInstance
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdiDBSecurityGroups
cdiEngineVersion
cdiStorageEncrypted
cdiDBClusterIdentifier
cdiAutoMinorVersionUpgrade
cdiMasterUserPassword
cdiMasterUsername
cdiPubliclyAccessible
cdiDBSubnetGroupName
cdiIOPS
cdiDomain
cdiTDECredentialPassword
cdiLicenseModel
cdiPreferredMaintenanceWindow
cdiCharacterSetName
cdiPreferredBackupWindow
cdiAvailabilityZone
cdiBackupRetentionPeriod
cdiKMSKeyId
cdiDBParameterGroupName
cdiVPCSecurityGroupIds
cdiMultiAZ
cdiAllocatedStorage
cdiTDECredentialARN
cdiOptionGroupName
cdiCopyTagsToSnapshot
cdiDBName
cdiTags
cdiPort
cdiStorageType
cdiDBInstanceIdentifier
cdiDBInstanceClass
cdiEngine
data CreateDBInstance Source
See: createDBInstance
smart constructor.
Request Lenses
cdiDBSecurityGroups :: Lens' CreateDBInstance [Text] Source
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
cdiEngineVersion :: Lens' CreateDBInstance (Maybe Text) Source
The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.
MySQL
- __Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 5.1.73a | 5.1.73b'
- __Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 5.5.40 | 5.5.40a'
- Version 5.5 (Available in all regions): ' 5.5.40b | 5.5.41 | 5.5.42'
- Version 5.6 (Available in all regions): ' 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23'
MySQL
- __Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 5.1.73a | 5.1.73b'
- __Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 5.5.40 | 5.5.40a'
- Version 5.5 (Available in all regions): ' 5.5.40b | 5.5.41 | 5.5.42'
- Version 5.6 (Available in all regions): ' 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23'
MySQL
- __Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 5.1.73a | 5.1.73b'
- __Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 5.5.40 | 5.5.40a'
- Version 5.5 (Available in all regions): ' 5.5.40b | 5.5.41 | 5.5.42'
- Version 5.6 (Available in all regions): ' 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23'
MySQL
- __Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 5.1.73a | 5.1.73b'
- __Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 5.5.40 | 5.5.40a'
- Version 5.5 (Available in all regions): ' 5.5.40b | 5.5.41 | 5.5.42'
- Version 5.6 (Available in all regions): ' 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23'
Oracle Database Enterprise Edition (oracle-ee)
- __Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- Version 11.2 (Available in all regions): ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- Version 12.1 (Available in all regions): ' 12.1.0.1.v1'
Oracle Database Enterprise Edition (oracle-ee)
- __Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- Version 11.2 (Available in all regions): ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- Version 12.1 (Available in all regions): ' 12.1.0.1.v1'
Oracle Database Enterprise Edition (oracle-ee)
- __Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- Version 11.2 (Available in all regions): ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- Version 12.1 (Available in all regions): ' 12.1.0.1.v1'
Oracle Database Standard Edition (oracle-se)
- __Version 11.2 (Only available in the following regions: us-west-1):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- __Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):__ ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- __Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):__ ' 12.1.0.1.v1'
Oracle Database Standard Edition (oracle-se)
- __Version 11.2 (Only available in the following regions: us-west-1):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- __Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):__ ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- __Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):__ ' 12.1.0.1.v1'
Oracle Database Standard Edition (oracle-se)
- __Version 11.2 (Only available in the following regions: us-west-1):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- __Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):__ ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- __Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):__ ' 12.1.0.1.v1'
Oracle Database Standard Edition One (oracle-se1)
- __Version 11.2 (Only available in the following regions: us-west-1):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- __Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):__ ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- __Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):__ ' 12.1.0.1.v1'
Oracle Database Standard Edition One (oracle-se1)
- __Version 11.2 (Only available in the following regions: us-west-1):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- __Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):__ ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- __Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):__ ' 12.1.0.1.v1'
Oracle Database Standard Edition One (oracle-se1)
- __Version 11.2 (Only available in the following regions: us-west-1):__ ' 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7'
- __Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):__ ' 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3'
- __Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):__ ' 12.1.0.1.v1'
PostgreSQL
- __Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 9.3.1 | 9.3.2'
- Version 9.3 (Available in all regions): ' 9.3.3 | 9.3.5 | 9.3.6'
- Version 9.4 (Available in all regions): ' 9.4.1'
PostgreSQL
- __Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 9.3.1 | 9.3.2'
- Version 9.3 (Available in all regions): ' 9.3.3 | 9.3.5 | 9.3.6'
- Version 9.4 (Available in all regions): ' 9.4.1'
PostgreSQL
- __Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):__ ' 9.3.1 | 9.3.2'
- Version 9.3 (Available in all regions): ' 9.3.3 | 9.3.5 | 9.3.6'
- Version 9.4 (Available in all regions): ' 9.4.1'
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
- __Version 10.50 (Only available in the following regions: eu-central-1, us-west-1):__ ' 10.50.2789.0.v1'
- __Version 11.00 (Only available in the following regions: eu-central-1, us-west-1):__ ' 11.00.2100.60.v1'
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
- __Version 10.50 (Only available in the following regions: eu-central-1, us-west-1):__ ' 10.50.2789.0.v1'
- __Version 11.00 (Only available in the following regions: eu-central-1, us-west-1):__ ' 11.00.2100.60.v1'
Microsoft SQL Server Express Edition (sqlserver-ex)
- Version 10.50 (Available in all regions): ' 10.50.2789.0.v1'
- Version 11.00 (Available in all regions): ' 11.00.2100.60.v1'
Microsoft SQL Server Express Edition (sqlserver-ex)
- Version 10.50 (Available in all regions): ' 10.50.2789.0.v1'
- Version 11.00 (Available in all regions): ' 11.00.2100.60.v1'
Microsoft SQL Server Standard Edition (sqlserver-se)
- Version 10.50 (Available in all regions): ' 10.50.2789.0.v1'
- Version 11.00 (Available in all regions): ' 11.00.2100.60.v1'
Microsoft SQL Server Standard Edition (sqlserver-se)
- Version 10.50 (Available in all regions): ' 10.50.2789.0.v1'
- Version 11.00 (Available in all regions): ' 11.00.2100.60.v1'
Microsoft SQL Server Web Edition (sqlserver-web)
- Version 10.50 (Available in all regions): ' 10.50.2789.0.v1'
- Version 11.00 (Available in all regions): ' 11.00.2100.60.v1'
Microsoft SQL Server Web Edition (sqlserver-web)
- Version 10.50 (Available in all regions): ' 10.50.2789.0.v1'
- Version 11.00 (Available in all regions): ' 11.00.2100.60.v1'
cdiStorageEncrypted :: Lens' CreateDBInstance (Maybe Bool) Source
Specifies whether the DB instance is encrypted.
Default: false
cdiDBClusterIdentifier :: Lens' CreateDBInstance (Maybe Text) Source
The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
cdiAutoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool) Source
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: true
cdiMasterUserPassword :: Lens' CreateDBInstance (Maybe Text) Source
The password for the master database user. Can be any printable ASCII character except "/", """, or "'".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
cdiMasterUsername :: Lens' CreateDBInstance (Maybe Text) Source
The name of master user for the client DB instance.
MySQL
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
- Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
- Must be 1 to 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Must be 1 to 63 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
cdiPubliclyAccessible :: Lens' CreateDBInstance (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.
cdiDBSubnetGroupName :: Lens' CreateDBInstance (Maybe Text) Source
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
cdiIOPS :: Lens' CreateDBInstance (Maybe Int) Source
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: To use PIOPS, this value must be an integer greater than 1000.
cdiDomain :: Lens' CreateDBInstance (Maybe Text) Source
Specify the Active Directory Domain to create the instance in.
cdiTDECredentialPassword :: Lens' CreateDBInstance (Maybe Text) Source
The password for the given ARN from the Key Store in order to access the device.
cdiLicenseModel :: Lens' CreateDBInstance (Maybe Text) Source
License model information for this DB instance.
Valid values: 'license-included' | 'bring-your-own-license' | 'general-public-license'
cdiPreferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text) Source
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.
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.
cdiCharacterSetName :: Lens' CreateDBInstance (Maybe Text) Source
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
cdiPreferredBackupWindow :: Lens' CreateDBInstance (Maybe Text) Source
The daily time range during which automated backups are created if
automated backups are enabled, using the BackupRetentionPeriod
parameter. For more information, see
DB Instance Backups.
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.
cdiAvailabilityZone :: Lens' CreateDBInstance (Maybe Text) Source
The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: 'us-east-1d'
Constraint: The AvailabilityZone parameter cannot be specified if the
MultiAZ parameter is set to true
. The specified Availability Zone must
be in the same region as the current endpoint.
cdiBackupRetentionPeriod :: Lens' CreateDBInstance (Maybe Int) Source
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
- Must be a value from 0 to 35
- Cannot be set to 0 if the DB instance is a source to Read Replicas
cdiKMSKeyId :: Lens' CreateDBInstance (Maybe Text) Source
The KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resoure Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, 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.
cdiDBParameterGroupName :: Lens' CreateDBInstance (Maybe Text) Source
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine 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
cdiVPCSecurityGroupIds :: Lens' CreateDBInstance [Text] Source
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
cdiMultiAZ :: Lens' CreateDBInstance (Maybe Bool) Source
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.
cdiAllocatedStorage :: Lens' CreateDBInstance (Maybe Int) Source
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
cdiTDECredentialARN :: Lens' CreateDBInstance (Maybe Text) Source
The ARN from the Key Store with which to associate the instance for TDE encryption.
cdiOptionGroupName :: Lens' CreateDBInstance (Maybe Text) Source
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
cdiCopyTagsToSnapshot :: Lens' CreateDBInstance (Maybe Bool) Source
This property is not currently implemented.
cdiDBName :: Lens' CreateDBInstance (Maybe Text) Source
The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
- Must contain 1 to 64 alphanumeric characters
- Cannot be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
- Must contain 1 to 63 alphanumeric characters
- Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
- Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
- Cannot be longer than 8 characters
SQL Server
Not applicable. Must be null.
cdiTags :: Lens' CreateDBInstance [Tag] Source
Undocumented member.
cdiPort :: Lens' CreateDBInstance (Maybe Int) Source
The port number on which the database accepts connections.
MySQL
Default: '3306'
Valid Values: '1150-65535'
Type: Integer
PostgreSQL
Default: '5432'
Valid Values: '1150-65535'
Type: Integer
Oracle
Default: '1521'
Valid Values: '1150-65535'
SQL Server
Default: '1433'
Valid Values: '1150-65535' except for '1434', '3389', '47001', '49152', and '49152' through '49156'.
cdiStorageType :: Lens' CreateDBInstance (Maybe Text) Source
Specifies the storage type to be associated with the DB instance.
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
cdiDBInstanceIdentifier :: Lens' CreateDBInstance Text Source
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
cdiDBInstanceClass :: Lens' CreateDBInstance Text Source
The compute and memory capacity of the DB instance.
Valid Values: 'db.t1.micro | 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'
cdiEngine :: Lens' CreateDBInstance Text Source
The name of the database engine to be used for this instance.
Valid Values: MySQL
| 'oracle-se1' | 'oracle-se' | 'oracle-ee' |
'sqlserver-ee' | 'sqlserver-se' | 'sqlserver-ex' | 'sqlserver-web' |
postgres
Not every database engine is available for every AWS region.
Destructuring the Response
createDBInstanceResponse Source
Creates a value of CreateDBInstanceResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateDBInstanceResponse Source
See: createDBInstanceResponse
smart constructor.
Response Lenses
cdirsDBInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance) Source
Undocumented member.
cdirsStatus :: Lens' CreateDBInstanceResponse Int Source
The response status code.