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 CreateDBCluster API operation.

Syntax

New-NPTDBCluster
-DBClusterIdentifier <String>
-AvailabilityZone <String[]>
-BackupRetentionPeriod <Int32>
-CharacterSetName <String>
-DatabaseName <String>
-DBClusterParameterGroupName <String>
-DBSubnetGroupName <String>
-EnableCloudwatchLogsExport <String[]>
-EnableIAMDatabaseAuthentication <Boolean>
-Engine <String>
-EngineVersion <String>
-KmsKeyId <String>
-MasterUsername <String>
-MasterUserPassword <String>
-OptionGroupName <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-PreSignedUrl <String>
-ReplicationSourceIdentifier <String>
-StorageEncrypted <Boolean>
-Tag <Tag[]>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

Parameters

-AvailabilityZone <String[]>
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvailabilityZones
-BackupRetentionPeriod <Int32>
The number of days for which automated backups are retained. You must specify a minimum value of 1.Default: 1Constraints:
  • Must be a value from 1 to 35
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CharacterSetName <String>
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabaseName <String>
The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The DB cluster 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: my-cluster1
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DBClusterParameterGroupName <String>
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.Constraints:
  • If supplied, must match the name of an existing DBClusterParameterGroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSubnetGroupName <String>
A DB subnet group to associate with this DB cluster.Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.Example: mySubnetgroup
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 mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Engine <String>
The name of the database engine to be used for this DB cluster.Valid Values: neptune
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version number of the database engine to use.Example: 1.0.1
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
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)
-KmsKeyId <String>
The AWS KMS key identifier for an encrypted DB cluster.The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.If an encryption key is not specified in KmsKeyId:
  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.
  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, 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.If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUsername <String>
The name of the master user for the DB cluster.Constraints:
  • Must be 1 to 16 letters or numbers.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserPassword <String>
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".Constraints: Must contain from 8 to 41 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionGroupName <String>
A value that indicates that the DB cluster should be associated with the specified option group.Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DBClusterIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^DBClusterIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which the instances in the DB cluster accept connections. Default: 8182
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredBackupWindow <String>
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.Constraints:
  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredMaintenanceWindow <String>
The weekly time range 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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.Constraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreSignedUrl <String>
This parameter is not currently supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicationSourceIdentifier <String>
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DBCluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptune.Model.CreateDBClusterResponse). Specifying the name of a property of type Amazon.Neptune.Model.CreateDBClusterResponse 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 cluster is encrypted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The tags to assign to the new DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcSecurityGroupId <String[]>
A list of EC2 VPC security groups to associate with this DB cluster.
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)
Aliases AK
-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 (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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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)
Aliases AWSProfilesLocation, 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)
Aliases AWSProfileName, StoredCredentials
-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 (ByPropertyName)
-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)
Aliases SecretAccessKey, SK
-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)
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases RegionToCall
-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)

Inputs

System.String
You can pipe a String object to this cmdlet for the DBClusterIdentifier parameter.

Outputs

Amazon.Neptune.Model.DBCluster or Amazon.Neptune.Model.CreateDBClusterResponse
This cmdlet returns an Amazon.Neptune.Model.DBCluster object. The service call response (type Amazon.Neptune.Model.CreateDBClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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