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 DocumentDB Elastic Clusters CreateCluster API operation.

Syntax

New-DOCECluster
-ClusterName <String>
-AdminUserName <String>
-AdminUserPassword <String>
-AuthType <Auth>
-BackupRetentionPeriod <Int32>
-KmsKeyId <String>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-ShardCapacity <Int32>
-ShardCount <Int32>
-ShardInstanceCount <Int32>
-SubnetId <String[]>
-Tag <Hashtable>
-VpcSecurityGroupId <String[]>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDocDBElasticConfig>

Description

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

Parameters

-AdminUserName <String>
The name of the Amazon DocumentDB elastic clusters administrator.Constraints:
  • Must be from 1 to 63 letters or numbers.
  • The first character must be a letter.
  • Cannot be a reserved word.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdminUserPassword <String>
The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.Constraints:
  • Must contain from 8 to 100 characters.
  • Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthType <Auth>
The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BackupRetentionPeriod <Int32>
The number of days for which automatic snapshots are retained.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonDocDBElasticConfig>
Amazon.PowerShell.Cmdlets.DOCE.AmazonDocDBElasticClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The client token for the elastic cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterName <String>
The name of the new elastic cluster. 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: my-cluster
Required?True
Position?1
Accept pipeline input?True (ByValue, 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)
-KmsKeyId <String>
The KMS key identifier to use to encrypt the new elastic cluster.The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version.
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, as determined by the backupRetentionPeriod.
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:miDefault: 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)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.CreateClusterResponse 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)
-ShardCapacity <Int32>
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShardCount <Int32>
The number of shards assigned to the elastic cluster. Maximum is 32.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShardInstanceCount <Int32>
The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SubnetId <String[]>
The Amazon EC2 subnet IDs for the new elastic cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetIds
-Tag <Hashtable>
The tags to be assigned to the new elastic cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcSecurityGroupId <String[]>
A list of EC2 VPC security groups to associate with the new elastic 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)
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.DocDBElastic.Model.Cluster object. The service call response (type Amazon.DocDBElastic.Model.CreateClusterResponse) 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