Safe Haskell | None |
---|---|
Language | Haskell2010 |
Network.AWS.RDS.CreateDBInstance
Description
Creates a new DB instance.
http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html
- data CreateDBInstance
- createDBInstance :: Text -> Int -> Text -> Text -> Text -> Text -> CreateDBInstance
- cdbiAllocatedStorage :: Lens' CreateDBInstance Int
- cdbiAutoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool)
- cdbiAvailabilityZone :: Lens' CreateDBInstance (Maybe Text)
- cdbiBackupRetentionPeriod :: Lens' CreateDBInstance (Maybe Int)
- cdbiCharacterSetName :: Lens' CreateDBInstance (Maybe Text)
- cdbiDBInstanceClass :: Lens' CreateDBInstance Text
- cdbiDBInstanceIdentifier :: Lens' CreateDBInstance Text
- cdbiDBName :: Lens' CreateDBInstance (Maybe Text)
- cdbiDBParameterGroupName :: Lens' CreateDBInstance (Maybe Text)
- cdbiDBSecurityGroups :: Lens' CreateDBInstance [Text]
- cdbiDBSubnetGroupName :: Lens' CreateDBInstance (Maybe Text)
- cdbiEngine :: Lens' CreateDBInstance Text
- cdbiEngineVersion :: Lens' CreateDBInstance (Maybe Text)
- cdbiIops :: Lens' CreateDBInstance (Maybe Int)
- cdbiLicenseModel :: Lens' CreateDBInstance (Maybe Text)
- cdbiMasterUserPassword :: Lens' CreateDBInstance Text
- cdbiMasterUsername :: Lens' CreateDBInstance Text
- cdbiMultiAZ :: Lens' CreateDBInstance (Maybe Bool)
- cdbiOptionGroupName :: Lens' CreateDBInstance (Maybe Text)
- cdbiPort :: Lens' CreateDBInstance (Maybe Int)
- cdbiPreferredBackupWindow :: Lens' CreateDBInstance (Maybe Text)
- cdbiPreferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text)
- cdbiPubliclyAccessible :: Lens' CreateDBInstance (Maybe Bool)
- cdbiStorageType :: Lens' CreateDBInstance (Maybe Text)
- cdbiTags :: Lens' CreateDBInstance [Tag]
- cdbiTdeCredentialArn :: Lens' CreateDBInstance (Maybe Text)
- cdbiTdeCredentialPassword :: Lens' CreateDBInstance (Maybe Text)
- cdbiVpcSecurityGroupIds :: Lens' CreateDBInstance [Text]
- data CreateDBInstanceResponse
- createDBInstanceResponse :: CreateDBInstanceResponse
- cdbirDBInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance)
Request
data CreateDBInstance Source
Request constructor
CreateDBInstance
constructor.
The fields accessible through corresponding lenses are:
cdbiAllocatedStorage
::
Int
cdbiAutoMinorVersionUpgrade
::
Maybe
Bool
cdbiAvailabilityZone
::
Maybe
Text
cdbiBackupRetentionPeriod
::
Maybe
Int
cdbiCharacterSetName
::
Maybe
Text
cdbiDBInstanceClass
::
Text
cdbiDBInstanceIdentifier
::
Text
cdbiDBName
::
Maybe
Text
cdbiDBParameterGroupName
::
Maybe
Text
cdbiDBSecurityGroups
::
[Text
]cdbiDBSubnetGroupName
::
Maybe
Text
cdbiEngine
::
Text
cdbiEngineVersion
::
Maybe
Text
cdbiIops
::
Maybe
Int
cdbiLicenseModel
::
Maybe
Text
cdbiMasterUserPassword
::
Text
cdbiMasterUsername
::
Text
cdbiMultiAZ
::
Maybe
Bool
cdbiOptionGroupName
::
Maybe
Text
cdbiPort
::
Maybe
Int
cdbiPreferredBackupWindow
::
Maybe
Text
cdbiPreferredMaintenanceWindow
::
Maybe
Text
cdbiPubliclyAccessible
::
Maybe
Bool
cdbiStorageType
::
Maybe
Text
cdbiTags
::
[Tag
]cdbiTdeCredentialArn
::
Maybe
Text
cdbiTdeCredentialPassword
::
Maybe
Text
cdbiVpcSecurityGroupIds
::
[Text
]
Request lenses
cdbiAllocatedStorage :: Lens' CreateDBInstance 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 3072.
PostgreSQL
Constraints: Must be an integer from 5 to 3072.
Oracle
Constraints: Must be an integer from 10 to 3072.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)
cdbiAutoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool) Source
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: true
cdbiAvailabilityZone :: Lens' CreateDBInstance (Maybe Text) Source
The EC2 Availability Zone that the database instance will be created in.
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.
cdbiBackupRetentionPeriod :: 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
cdbiCharacterSetName :: Lens' CreateDBInstance (Maybe Text) Source
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
cdbiDBInstanceClass :: 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'
cdbiDBInstanceIdentifier :: 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
cdbiDBName :: 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, no 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.
cdbiDBParameterGroupName :: 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
cdbiDBSecurityGroups :: 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.
cdbiDBSubnetGroupName :: 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.
cdbiEngine :: 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
cdbiEngineVersion :: Lens' CreateDBInstance (Maybe Text) Source
The version number of the database engine to use.
MySQL
Example: '5.1.42'
Type: String
PostgreSQL
Example: '9.3'
Type: String
Oracle
Example: '11.2.0.2.v2'
Type: String
SQL Server
Example: '10.50.2789.0.v1'
cdbiIops :: 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.
cdbiLicenseModel :: Lens' CreateDBInstance (Maybe Text) Source
License model information for this DB instance.
Valid values: 'license-included' | 'bring-your-own-license' | 'general-public-license'
cdbiMasterUserPassword :: Lens' CreateDBInstance 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.
cdbiMasterUsername :: Lens' CreateDBInstance 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.
cdbiMultiAZ :: 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.
cdbiOptionGroupName :: 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
cdbiPort :: 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'.
cdbiPreferredBackupWindow :: Lens' CreateDBInstance (Maybe Text) Source
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. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format 'hh24:mi-hh24:mi'. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
cdbiPreferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text) Source
The weekly time range (in UTC) during which system maintenance can occur.
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.
cdbiPubliclyAccessible :: 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.
cdbiStorageType :: Lens' CreateDBInstance (Maybe Text) Source
Specifies 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.
cdbiTdeCredentialArn :: Lens' CreateDBInstance (Maybe Text) Source
The ARN from the Key Store with which to associate the instance for TDE encryption.
cdbiTdeCredentialPassword :: Lens' CreateDBInstance (Maybe Text) Source
The password for the given ARN from the Key Store in order to access the device.
cdbiVpcSecurityGroupIds :: 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.
Response
Response constructor
createDBInstanceResponse :: CreateDBInstanceResponse Source
CreateDBInstanceResponse
constructor.
The fields accessible through corresponding lenses are: