Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AWS Tools for Windows PowerShell
Command Reference

Synopsis

Calls the Amazon DocumentDB (with MongoDB compatibility) CreateDBInstance API operation.

Syntax

New-DOCDBInstance
-DBInstanceIdentifier <String>
-AutoMinorVersionUpgrade <Boolean>
-AvailabilityZone <String>
-CACertificateIdentifier <String>
-CopyTagsToSnapshot <Boolean>
-DBClusterIdentifier <String>
-DBInstanceClass <String>
-EnablePerformanceInsight <Boolean>
-Engine <String>
-PerformanceInsightsKMSKeyId <String>
-PreferredMaintenanceWindow <String>
-PromotionTier <Int32>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDocDBConfig>

Description

Creates a new instance.

Parameters

-AutoMinorVersionUpgrade <Boolean>
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZone <String>
The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.Example: us-east-1d
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CACertificateIdentifier <String>
The CA certificate identifier to use for the DB instance's server certificate.For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonDocDBConfig>
Amazon.PowerShell.Cmdlets.DOC.AmazonDocDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CopyTagsToSnapshot <Boolean>
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The identifier of the cluster that the instance will belong to.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceClass <String>
The compute and memory capacity of the instance; for example, db.r5.large.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceIdentifier <String>
The instance identifier. This parameter is stored as a lowercase string.Constraints:
  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The 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)
-EnablePerformanceInsight <Boolean>
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
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 value: docdb
Required?True
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)
-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>
The KMS key identifier for encryption of Performance Insights data.The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
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 Amazon Web Services Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, SunConstraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PromotionTier <Int32>
A value that specifies the order in which an Amazon DocumentDB 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)
-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.DocDB.Model.CreateDBInstanceResponse). Specifying the name of a property of type Amazon.DocDB.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)
-Tag <Tag[]>
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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

Amazon.DocDB.Model.DBInstance or Amazon.DocDB.Model.CreateDBInstanceResponse
This cmdlet returns an Amazon.DocDB.Model.DBInstance object. The service call response (type Amazon.DocDB.Model.CreateDBInstanceResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 4.1.800.0