AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateDBInstance operation. Creates a new DB instance.
Namespace: Amazon.Neptune.Model
Assembly: AWSSDK.Neptune.dll
Version: 3.x.y.z
public class CreateDBInstanceRequest : AmazonNeptuneRequest IAmazonWebServiceRequest
The CreateDBInstanceRequest type exposes the following members
Name | Description | |
---|---|---|
CreateDBInstanceRequest() |
Name | Type | Description | |
---|---|---|---|
AllocatedStorage | System.Int32 |
Gets and sets the property AllocatedStorage. Not supported by Neptune. |
|
AutoMinorVersionUpgrade | System.Boolean |
Gets and sets the property AutoMinorVersionUpgrade. Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: |
|
AvailabilityZone | System.String |
Gets and sets the property AvailabilityZone. 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:
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter
is set to |
|
BackupRetentionPeriod | System.Int32 |
Gets and sets the property BackupRetentionPeriod. 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:
|
|
CharacterSetName | System.String |
Gets and sets the property CharacterSetName. (Not supported by Neptune) |
|
CopyTagsToSnapshot | System.Boolean |
Gets and sets the property CopyTagsToSnapshot. True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. |
|
DBClusterIdentifier | System.String |
Gets and sets the property DBClusterIdentifier. The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String |
|
DBInstanceClass | System.String |
Gets and sets the property DBInstanceClass.
The compute and memory capacity of the DB instance, for example, |
|
DBInstanceIdentifier | System.String |
Gets and sets the property DBInstanceIdentifier. The DB instance identifier. This parameter is stored as a lowercase string. Constraints:
Example: |
|
DBName | System.String |
Gets and sets the property DBName. Not supported. |
|
DBParameterGroupName | System.String |
Gets and sets the property DBParameterGroupName. 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:
|
|
DBSecurityGroups | System.Collections.Generic.List<System.String> |
Gets and sets the property DBSecurityGroups. A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. |
|
DBSubnetGroupName | System.String |
Gets and sets the property DBSubnetGroupName. 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. |
|
DeletionProtection | System.Boolean |
Gets and sets the property DeletionProtection. 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. |
|
Domain | System.String |
Gets and sets the property Domain. Specify the Active Directory Domain to create the instance in. |
|
DomainIAMRoleName | System.String |
Gets and sets the property DomainIAMRoleName. Specify the name of the IAM role to be used when making API calls to the Directory Service. |
|
EnableCloudwatchLogsExports | System.Collections.Generic.List<System.String> |
Gets and sets the property EnableCloudwatchLogsExports. The list of log types that need to be enabled for exporting to CloudWatch Logs. |
|
EnableIAMDatabaseAuthentication | System.Boolean |
Gets and sets the property EnableIAMDatabaseAuthentication. Not supported by Neptune (ignored). |
|
EnablePerformanceInsights | System.Boolean |
Gets and sets the property EnablePerformanceInsights. (Not supported by Neptune) |
|
Engine | System.String |
Gets and sets the property Engine. The name of the database engine to be used for this instance.
Valid Values: |
|
EngineVersion | System.String |
Gets and sets the property EngineVersion. The version number of the database engine to use. Currently, setting this parameter has no effect. |
|
Iops | System.Int32 |
Gets and sets the property Iops. The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. |
|
KmsKeyId | System.String |
Gets and sets the property KmsKeyId. 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 |
|
LicenseModel | System.String |
Gets and sets the property LicenseModel. License model information for this DB instance.
Valid values: |
|
MasterUsername | System.String |
Gets and sets the property MasterUsername. Not supported by Neptune. |
|
MasterUserPassword | System.String |
Gets and sets the property MasterUserPassword. Not supported by Neptune. |
|
MonitoringInterval | System.Int32 |
Gets and sets the property MonitoringInterval. 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
Valid Values: |
|
MonitoringRoleArn | System.String |
Gets and sets the property MonitoringRoleArn.
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics
to Amazon CloudWatch Logs. For example,
If |
|
MultiAZ | System.Boolean |
Gets and sets the property MultiAZ. 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. |
|
OptionGroupName | System.String |
Gets and sets the property OptionGroupName. (Not supported by Neptune) |
|
PerformanceInsightsKMSKeyId | System.String |
Gets and sets the property PerformanceInsightsKMSKeyId. (Not supported by Neptune) |
|
Port | System.Int32 |
Gets and sets the property Port. 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: Type: Integer |
|
PreferredBackupWindow | System.String |
Gets and sets the property PreferredBackupWindow. 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. |
|
PreferredMaintenanceWindow | System.String |
Gets and sets the property PreferredMaintenanceWindow. The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: 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. |
|
PromotionTier | System.Int32 |
Gets and sets the property PromotionTier. 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 |
|
PubliclyAccessible | System.Boolean |
Gets and sets the property PubliclyAccessible. This flag should no longer be used. |
|
StorageEncrypted | System.Boolean |
Gets and sets the property StorageEncrypted. 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 |
|
StorageType | System.String |
Gets and sets the property StorageType. Specifies the storage type to be associated with the DB instance. Not applicable. Storage is managed by the DB Cluster. |
|
Tags | System.Collections.Generic.List<Amazon.Neptune.Model.Tag> |
Gets and sets the property Tags. The tags to assign to the new instance. |
|
TdeCredentialArn | System.String |
Gets and sets the property TdeCredentialArn. The ARN from the key store with which to associate the instance for TDE encryption. |
|
TdeCredentialPassword | System.String |
Gets and sets the property TdeCredentialPassword. The password for the given ARN from the key store in order to access the device. |
|
Timezone | System.String |
Gets and sets the property Timezone. The time zone of the DB instance. |
|
VpcSecurityGroupIds | System.Collections.Generic.List<System.String> |
Gets and sets the property VpcSecurityGroupIds. 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. |
This example creates a DB instance.
var response = client.CreateDBInstance(new CreateDBInstanceRequest { AllocatedStorage = 5, DBInstanceClass = "db.t2.micro", DBInstanceIdentifier = "mymysqlinstance", Engine = "MySQL", MasterUserPassword = "MyPassword", MasterUsername = "MyUser" }); DBInstance dbInstance = response.DBInstance;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5