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 Relational Database Service CreateDBShardGroup API operation.

Syntax

New-RDSDBShardGroup
-DBShardGroupIdentifier <String>
-ComputeRedundancy <Int32>
-DBClusterIdentifier <String>
-MaxACU <Double>
-MinACU <Double>
-PubliclyAccessible <Boolean>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonRDSConfig>

Description

Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB clusters only

Parameters

-ClientConfig <AmazonRDSConfig>
Amazon.PowerShell.Cmdlets.RDS.AmazonRDSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeRedundancy <Int32>
Specifies whether to create standby standby DB data access shard for the DB shard group. Valid values are the following:
  • 0 - Creates a DB shard group without a standby DB data access shard. This is the default value.
  • 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ).
  • 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The name of the primary DB cluster for the DB shard group.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBShardGroupIdentifier <String>
The name of the DB shard group.
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)
-MaxACU <Double>
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MinACU <Double>
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DBShardGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^DBShardGroupIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PubliclyAccessible <Boolean>
Specifies whether the DB shard group is publicly accessible.When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.Default: The default behavior varies depending on whether DBSubnetGroupName is specified.If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.CreateDBShardGroupResponse). Specifying the name of a property of type Amazon.RDS.Model.CreateDBShardGroupResponse 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 service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
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

This cmdlet returns an Amazon.RDS.Model.CreateDBShardGroupResponse object containing multiple properties.

Supported Version

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