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 MemoryDB CreateCluster API operation.

Syntax

New-MDBCluster
-ClusterName <String>
-ACLName <String>
-AutoMinorVersionUpgrade <Boolean>
-DataTiering <Boolean>
-Description <String>
-Engine <String>
-EngineVersion <String>
-KmsKeyId <String>
-MaintenanceWindow <String>
-MultiRegionClusterName <String>
-NodeType <String>
-NumReplicasPerShard <Int32>
-NumShard <Int32>
-ParameterGroupName <String>
-Port <Int32>
-SecurityGroupId <String[]>
-SnapshotArn <String[]>
-SnapshotName <String>
-SnapshotRetentionLimit <Int32>
-SnapshotWindow <String>
-SnsTopicArn <String>
-SubnetGroupName <String>
-Tag <Tag[]>
-TLSEnabled <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonMemoryDBConfig>

Description

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

Parameters

-ACLName <String>
The name of the Access Control List to associate with the cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoMinorVersionUpgrade <Boolean>
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonMemoryDBConfig>
Amazon.PowerShell.Cmdlets.MDB.AmazonMemoryDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterName <String>
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DataTiering <Boolean>
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
An optional description of the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Engine <String>
The name of the engine to be used for the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version number of the Redis OSS engine to be used for the cluster.
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 ID of the KMS key used to encrypt the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceWindow <String>
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.Valid values for ddd are:
  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat
Example: sun:23:00-mon:01:30
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MultiRegionClusterName <String>
The name of the multi-Region cluster to be created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NodeType <String>
The compute and memory capacity of the nodes in the cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NumReplicasPerShard <Int32>
The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NumShard <Int32>
The number of shards the cluster will contain. The default value is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNumShards
-ParameterGroupName <String>
The name of the parameter group associated with the cluster.
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)
-Port <Int32>
The port number on which each of the nodes accepts connections.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupId <String[]>
A list of security group names to associate with this cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupIds
-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.MemoryDB.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.MemoryDB.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)
-SnapshotArn <String[]>
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSnapshotArns
-SnapshotName <String>
The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnapshotRetentionLimit <Int32>
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnapshotWindow <String>
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnsTopicArn <String>
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SubnetGroupName <String>
The name of the subnet group to be used for the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TLSEnabled <Boolean>
A flag to enable in-transit encryption on the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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.MemoryDB.Model.Cluster or Amazon.MemoryDB.Model.CreateClusterResponse
This cmdlet returns an Amazon.MemoryDB.Model.Cluster object. The service call response (type Amazon.MemoryDB.Model.CreateClusterResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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