AWS Tools for Windows PowerShell
Command Reference

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.

Synopsis

Calls the Amazon Neptune CreateDBInstance API operation.

Syntax

New-NPTDBInstance
-DBInstanceIdentifier <String>
-AllocatedStorage <Int32>
-AutoMinorVersionUpgrade <Boolean>
-AvailabilityZone <String>
-BackupRetentionPeriod <Int32>
-CharacterSetName <String>
-CopyTagsToSnapshot <Boolean>
-DBClusterIdentifier <String>
-DBInstanceClass <String>
-DBName <String>
-DBParameterGroupName <String>
-DBSecurityGroup <String[]>
-DBSubnetGroupName <String>
-DeletionProtection <Boolean>
-Domain <String>
-DomainIAMRoleName <String>
-EnableCloudwatchLogsExport <String[]>
-EnableIAMDatabaseAuthentication <Boolean>
-EnablePerformanceInsight <Boolean>
-Engine <String>
-EngineVersion <String>
-Iops <Int32>
-KmsKeyId <String>
-LicenseModel <String>
-MasterUsername <String>
-MasterUserPassword <String>
-MonitoringInterval <Int32>
-MonitoringRoleArn <String>
-MultiAZ <Boolean>
-OptionGroupName <String>
-PerformanceInsightsKMSKeyId <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-PromotionTier <Int32>
-StorageEncrypted <Boolean>
-StorageType <String>
-Tag <Tag[]>
-TdeCredentialArn <String>
-TdeCredentialPassword <String>
-Timezone <String>
-VpcSecurityGroupId <String[]>
-PubliclyAccessible <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new DB instance.

Parameters

-AllocatedStorage <Int32>
The amount of storage (in gibibytes) to allocate for the DB instance.Type: IntegerNot 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoMinorVersionUpgrade <Boolean>
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.Default: true
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZone <String>
The EC2 Availability Zone that the DB instance is created inDefault: 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BackupRetentionPeriod <Int32>
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: 1Constraints:
  • Must be a value from 0 to 35
  • Cannot be set to 0 if the DB instance is a source to Read Replicas
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CharacterSetName <String>
(Not supported by Neptune)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CopyTagsToSnapshot <Boolean>
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The identifier of the DB cluster that the instance will belong to.For information on creating a DB cluster, see CreateDBCluster.Type: String
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceClass <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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceIdentifier <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
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DBName <String>
Not supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBParameterGroupName <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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSecurityGroup <String[]>
A list of DB security groups to associate with this DB instance.Default: The default DB security group for the database engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDBSecurityGroups
-DBSubnetGroupName <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String>
Specify the Active Directory Domain to create the instance in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainIAMRoleName <String>
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableCloudwatchLogsExport <String[]>
The list of log types that need to be enabled for exporting to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnableCloudwatchLogsExports
-EnableIAMDatabaseAuthentication <Boolean>
True to enable AWS Identity and Access Management (IAM) authentication for Neptune.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnablePerformanceInsight <Boolean>
(Not supported by Neptune)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnablePerformanceInsights
-Engine <String>
The name of the database engine to be used for this instance.Valid Values: neptune
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version number of the database engine to use. Currently, setting this parameter has no effect.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Iops <Int32>
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LicenseModel <String>
License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUsername <String>
The name for the master user. Not used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserPassword <String>
The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Not used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringInterval <Int32>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringRoleArn <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MultiAZ <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionGroupName <String>
(Not supported by Neptune)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DBInstanceIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^DBInstanceIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformanceInsightsKMSKeyId <String>
(Not supported by Neptune)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
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: 8182Type: Integer
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredBackupWindow <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredMaintenanceWindow <String>
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:miThe 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PromotionTier <Int32>
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: 1Valid Values: 0 - 15
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PubliclyAccessible <Boolean>
This flag should no longer be used.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DBInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptune.Model.CreateDBInstanceResponse). Specifying the name of a property of type Amazon.Neptune.Model.CreateDBInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageEncrypted <Boolean>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <String>
Specifies the storage type to be associated with the DB instance.Not applicable. Storage is managed by the DB Cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The tags to assign to the new instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TdeCredentialArn <String>
The ARN from the key store with which to associate the instance for TDE encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TdeCredentialPassword <String>
The password for the given ARN from the key store in order to access the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Timezone <String>
The time zone of the DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcSecurityGroupId <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSecurityGroupIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.Neptune.Model.DBInstance object. The service call response (type Amazon.Neptune.Model.CreateDBInstanceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z