/AWS1/CL_NEP=>CREATEDBINSTANCE()
¶
About CreateDBInstance¶
Creates a new DB instance.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DBINSTANCEIDENTIFIER
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
IV_DBINSTANCECLASS
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The compute and memory capacity of the DB instance, for example,
db.m4.large
. Not all DB instance classes are available in all Amazon Regions.
IV_ENGINE
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The name of the database engine to be used for this instance.
Valid Values:
neptune
IV_DBCLUSTERIDENTIFIER
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
Optional arguments:¶
IV_DBNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Not supported.
IV_ALLOCATEDSTORAGE
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
Not supported by Neptune.
IV_MASTERUSERNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Not supported by Neptune.
IV_MASTERUSERPASSWORD
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Not supported by Neptune.
IT_DBSECURITYGROUPS
TYPE /AWS1/CL_NEPDBSECGRPNAMELIST_W=>TT_DBSECURITYGROUPNAMELIST
TT_DBSECURITYGROUPNAMELIST
¶
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
IT_VPCSECURITYGROUPIDS
TYPE /AWS1/CL_NEPVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST
TT_VPCSECURITYGROUPIDLIST
¶
A list of EC2 VPC security groups to associate with this DB instance.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
IV_AVAILABILITYZONE
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The EC2 Availability Zone that the DB instance is created in
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Region.
Example:
us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true
. The specified Availability Zone must be in the same Amazon Region as the current endpoint.
IV_DBSUBNETGROUPNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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.
IV_PREFERREDMAINTENANCEWIN00
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
IV_DBPARAMETERGROUPNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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 is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
IV_BACKUPRETENTIONPERIOD
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
The number of days for which automated backups are retained.
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
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
IV_PREFERREDBACKUPWINDOW
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The daily time range during which automated backups are created.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
IV_PORT
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
The port number on which the database accepts connections.
Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.
Default:
8182
Type: Integer
IV_MULTIAZ
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
IV_ENGINEVERSION
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The version number of the database engine to use. Currently, setting this parameter has no effect.
IV_AUTOMINORVERSIONUPGRADE
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default:
true
IV_LICENSEMODEL
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
License model information for this DB instance.
Valid values:
license-included
|bring-your-own-license
|general-public-license
IV_IOPS
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
IV_OPTIONGROUPNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
(Not supported by Neptune)
IV_CHARACTERSETNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
(Not supported by Neptune)
IV_PUBLICLYACCESSIBLE
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
This flag should no longer be used.
IT_TAGS
TYPE /AWS1/CL_NEPTAG=>TT_TAGLIST
TT_TAGLIST
¶
The tags to assign to the new instance.
IV_STORAGETYPE
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Specifies the storage type to be associated with the DB instance.
Not applicable. Storage is managed by the DB Cluster.
IV_TDECREDENTIALARN
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The ARN from the key store with which to associate the instance for TDE encryption.
IV_TDECREDENTIALPASSWORD
TYPE /AWS1/NEPSENSITIVESTRING
/AWS1/NEPSENSITIVESTRING
¶
The password for the given ARN from the key store in order to access the device.
IV_STORAGEENCRYPTED
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
Specifies whether the DB instance is encrypted.
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
IV_KMSKEYID
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The Amazon KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same Amazon 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.
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
parameter, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.
IV_DOMAIN
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Specify the Active Directory Domain to create the instance in.
IV_COPYTAGSTOSNAPSHOT
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
IV_MONITORINGINTERVAL
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
IV_MONITORINGROLEARN
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.
IV_DOMAINIAMROLENAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Specify the name of the IAM role to be used when making API calls to the Directory Service.
IV_PROMOTIONTIER
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
A value that specifies the order in which an Read Replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid Values: 0 - 15
IV_TIMEZONE
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The time zone of the DB instance.
IV_ENBIAMDATABASEAUTHNTCTN
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
Not supported by Neptune (ignored).
IV_ENABLEPERFORMANCEINSIGHTS
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
(Not supported by Neptune)
IV_PERFORMANCEINSIGHTSKMSK00
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
(Not supported by Neptune)
IT_ENABLECLOUDWATCHLOGSEXP
TYPE /AWS1/CL_NEPLOGTYPELIST_W=>TT_LOGTYPELIST
TT_LOGTYPELIST
¶
The list of log types that need to be enabled for exporting to CloudWatch Logs.
IV_DELETIONPROTECTION
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.
DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.