aws neptune create-db-instance
Creates a new DB instance
Options
| Name | Description |
|---|---|
--db-name <string> | Not supported |
--db-instance-identifier <string> | 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 |
--allocated-storage <integer> | The amount of storage (in gibibytes) to allocate for the DB instance. Type: Integer Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume |
--db-instance-class <string> | The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions |
--engine <string> | The name of the database engine to be used for this instance. Valid Values: neptune |
--master-username <string> | The name for the master user. Not used |
--master-user-password <string> | The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Not used |
--db-security-groups <list> | A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine |
--vpc-security-group-ids <list> | 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 |
--availability-zone <string> | The EC2 Availability Zone that the DB instance is created in Default: A random, system-chosen Availability Zone in the endpoint's AWS 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 AWS Region as the current endpoint |
--db-subnet-group-name <string> | 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 |
--preferred-maintenance-window <string> | 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 AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window |
--db-parameter-group-name <string> | 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 |
--backup-retention-period <integer> | 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 |
--preferred-backup-window <string> | 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 |
--port <integer> | 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 |
--multi-az | 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 |
--no-multi-az | 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 |
--engine-version <string> | The version number of the database engine to use. Currently, setting this parameter has no effect |
--auto-minor-version-upgrade | Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true |
--no-auto-minor-version-upgrade | Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true |
--license-model <string> | License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license |
--iops <integer> | The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance |
--option-group-name <string> | (Not supported by Neptune) |
--character-set-name <string> | (Not supported by Neptune) |
--publicly-accessible | This flag should no longer be used |
--no-publicly-accessible | This flag should no longer be used |
--tags <list> | The tags to assign to the new instance |
--db-cluster-identifier <string> | The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String |
--storage-type <string> | Specifies the storage type to be associated with the DB instance. Not applicable. Storage is managed by the DB Cluster |
--tde-credential-arn <string> | The ARN from the key store with which to associate the instance for TDE encryption |
--tde-credential-password <string> | The password for the given ARN from the key store in order to access the device |
--storage-encrypted | 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 |
--no-storage-encrypted | 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 |
--kms-key-id <string> | The AWS 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 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. 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 the KmsKeyId parameter, then Amazon Neptune 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 |
--domain <string> | Specify the Active Directory Domain to create the instance in |
--copy-tags-to-snapshot | True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false |
--no-copy-tags-to-snapshot | True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false |
--monitoring-interval <integer> | 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 set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 |
--monitoring-role-arn <string> | 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 a MonitoringRoleArn value |
--domain-iam-role-name <string> | Specify the name of the IAM role to be used when making API calls to the Directory Service |
--promotion-tier <integer> | 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 |
--timezone <string> | The time zone of the DB instance |
--enable-iam-database-authentication | True to enable AWS Identity and Access Management (IAM) authentication for Neptune. Default: false |
--no-enable-iam-database-authentication | True to enable AWS Identity and Access Management (IAM) authentication for Neptune. Default: false |
--enable-performance-insights | (Not supported by Neptune) |
--no-enable-performance-insights | (Not supported by Neptune) |
--performance-insights-kms-key-id <string> | (Not supported by Neptune) |
--enable-cloudwatch-logs-exports <list> | The list of log types that need to be enabled for exporting to CloudWatch Logs |
--deletion-protection | 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 |
--no-deletion-protection | 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 |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |