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

Syntax

New-RDSDBCluster
-DBClusterIdentifier <String>
-AllocatedStorage <Int32>
-AutoMinorVersionUpgrade <Boolean>
-ScalingConfiguration_AutoPause <Boolean>
-AvailabilityZone <String[]>
-BacktrackWindow <Int64>
-BackupRetentionPeriod <Int32>
-CACertificateIdentifier <String>
-CharacterSetName <String>
-ClusterScalabilityType <ClusterScalabilityType>
-CopyTagsToSnapshot <Boolean>
-DatabaseInsightsMode <DatabaseInsightsMode>
-DatabaseName <String>
-DBClusterInstanceClass <String>
-DBClusterParameterGroupName <String>
-DBSubnetGroupName <String>
-DBSystemId <String>
-DeletionProtection <Boolean>
-Domain <String>
-DomainIAMRoleName <String>
-EnableCloudwatchLogsExport <String[]>
-EnableGlobalWriteForwarding <Boolean>
-EnableHttpEndpoint <Boolean>
-EnableIAMDatabaseAuthentication <Boolean>
-EnableLimitlessDatabase <Boolean>
-EnableLocalWriteForwarding <Boolean>
-EnablePerformanceInsight <Boolean>
-Engine <String>
-EngineLifecycleSupport <String>
-EngineMode <String>
-EngineVersion <String>
-GlobalClusterIdentifier <String>
-RdsCustomClusterConfiguration_InterconnectSubnetId <String>
-Iops <Int32>
-KmsKeyId <String>
-ManageMasterUserPassword <Boolean>
-MasterUserAuthenticationType <MasterUserAuthenticationType>
-MasterUsername <String>
-MasterUserPassword <String>
-MasterUserSecretKmsKeyId <String>
-ScalingConfiguration_MaxCapacity <Int32>
-ServerlessV2ScalingConfiguration_MaxCapacity <Double>
-ScalingConfiguration_MinCapacity <Int32>
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
-MonitoringInterval <Int32>
-MonitoringRoleArn <String>
-NetworkType <String>
-OptionGroupName <String>
-PerformanceInsightsKMSKeyId <String>
-PerformanceInsightsRetentionPeriod <Int32>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-PreSignedUrl <String>
-PubliclyAccessible <Boolean>
-RdsCustomClusterConfiguration_ReplicaMode <ReplicaMode>
-ReplicationSourceIdentifier <String>
-ScalingConfiguration_SecondsBeforeTimeout <Int32>
-ScalingConfiguration_SecondsUntilAutoPause <Int32>
-ServerlessV2ScalingConfiguration_SecondsUntilAutoPause <Int32>
-SourceRegion <String>
-StorageEncrypted <Boolean>
-StorageType <String>
-Tag <Tag[]>
-ScalingConfiguration_TimeoutAction <String>
-RdsCustomClusterConfiguration_TransitGatewayMulticastDomainId <String>
-VpcSecurityGroupId <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonRDSConfig>

Description

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters

-AllocatedStorage <Int32>
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.Valid for Cluster Type: Multi-AZ DB clusters onlyThis setting is required to create a Multi-AZ DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoMinorVersionUpgrade <Boolean>
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZone <String[]>
A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.For the first three DB instances that you create, RDS distributes each DB instance to a different AZ that you specify. For additional DB instances that you create, RDS randomly distributes them to the AZs that you specified. For example, if you create a DB cluster with one writer instance and three reader instances, RDS might distribute the writer instance to AZ 1, the first reader instance to AZ 2, the second reader instance to AZ 3, and the third reader instance to either AZ 1, AZ 2, or AZ 3. For more information, see Availability Zones and High availability for Aurora DB instances in the Amazon Aurora User Guide.Valid for Cluster Type: Aurora DB clusters onlyConstraints:
  • Can't specify more than three AZs.
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvailabilityZones
-BacktrackWindow <Int64>
The target backtrack window, in seconds. To disable backtracking, set this value to 0.Valid for Cluster Type: Aurora MySQL DB clusters onlyDefault: 0Constraints:
  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BackupRetentionPeriod <Int32>
The number of days for which automated backups are retained.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersDefault: 1Constraints:
  • Must be a value from 1 to 35.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CACertificateIdentifier <String>
The CA certificate identifier to use for the DB cluster's server certificate.For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.Valid for Cluster Type: Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CharacterSetName <String>
The name of the character set (CharacterSet) to associate the DB cluster with.Valid for Cluster Type: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonRDSConfig>
Amazon.PowerShell.Cmdlets.RDS.AmazonRDSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterScalabilityType <ClusterScalabilityType>
Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.Valid for: Aurora DB clusters onlyYou can't modify this setting after you create the DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CopyTagsToSnapshot <Boolean>
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabaseInsightsMode <DatabaseInsightsMode>
The mode of Database Insights to enable for the DB cluster.If you set this value to advanced, you must also set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabaseName <String>
The name for your database of up to 64 alphanumeric characters. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The identifier for this DB cluster. This parameter is stored as a lowercase string.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
  • First character must be a letter.
  • Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DBClusterInstanceClass <String>
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.This setting is required to create a Multi-AZ DB cluster.Valid for Cluster Type: Multi-AZ DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterParameterGroupName <String>
The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • If supplied, must match the name of an existing DB cluster parameter group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSubnetGroupName <String>
A DB subnet group to associate with this DB cluster.This setting is required to create a Multi-AZ DB cluster.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • Must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSystemId <String>
Reserved for future use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String>
The Active Directory directory ID to create the DB cluster in.For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.For more information, see Kerberos authentication in the Amazon Aurora User Guide.Valid for Cluster Type: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainIAMRoleName <String>
The name of the IAM role to use when making API calls to the Directory Service.Valid for Cluster Type: Aurora DB clusters only
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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersThe following values are valid for each DB engine:
  • Aurora MySQL - audit | error | general | instance | slowquery | iam-db-auth-error
  • Aurora PostgreSQL - instance | postgresql | iam-db-auth-error
  • RDS for MySQL - error | general | slowquery | iam-db-auth-error
  • RDS for PostgreSQL - postgresql | upgrade | iam-db-auth-error
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnableCloudwatchLogsExports
-EnableGlobalWriteForwarding <Boolean>
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.Valid for Cluster Type: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableHttpEndpoint <Boolean>
Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.For more information, see Using RDS Data API in the Amazon Aurora User Guide.Valid for Cluster Type: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableIAMDatabaseAuthentication <Boolean>
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.For more information, see IAM Database Authentication in the Amazon Aurora User Guide or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableLimitlessDatabase <Boolean>
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.Valid for: Aurora DB clusters onlyThis setting is no longer used. Instead use the ClusterScalabilityType setting.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableLocalWriteForwarding <Boolean>
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.Valid for: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnablePerformanceInsight <Boolean>
Specifies whether to turn on Performance Insights for the DB cluster.For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnablePerformanceInsights
-Engine <String>
The database engine to use for this DB cluster.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersValid Values:
  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres
  • neptune - For information about using Amazon Neptune, see the Amazon Neptune User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineLifecycleSupport <String>
The life cycle type for this DB cluster.By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabledDefault: open-source-rds-extended-support
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineMode <String>
The DB engine mode of the DB cluster, either provisioned or serverless.The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:Valid for Cluster Type: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version number of the database engine to use.To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.To list all of the available engine versions for Aurora PostgreSQL, use the following command:aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for RDS for MySQL, use the following command:aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for RDS for PostgreSQL, use the following command:aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"For information about a specific engine, see the following topics:Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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)
-GlobalClusterIdentifier <String>
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.Valid for Cluster Type: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Iops <Int32>
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide.This setting is required to create a Multi-AZ DB cluster.Valid for Cluster Type: Multi-AZ DB clusters onlyConstraints:
  • Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
The Amazon Web Services KMS key identifier for an encrypted DB cluster.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.When a KMS key isn't specified in KmsKeyId:
  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.
  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS 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.If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManageMasterUserPassword <Boolean>
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserAuthenticationType <MasterUserAuthenticationType>
Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.You can specify one of the following values:
  • password - Use standard database authentication with a password.
  • iam-db-auth - Use IAM database authentication for the master user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersThis option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUsername <String>
The name of the master user for the DB cluster.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • Must be 1 to 16 letters or numbers.
  • First character must be a letter.
  • Can't 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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • Must contain from 8 to 41 characters.
  • Can contain any printable ASCII character except "/", """, or "@".
  • Can't be specified if ManageMasterUserPassword is turned on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserSecretKmsKeyId <String>
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed 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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringInterval <Int32>
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersValid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringRoleArn <String>
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkType <String>
The network type of the DB cluster.The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.Valid for Cluster Type: Aurora DB clusters onlyValid Values: IPV4 | DUAL
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionGroupName <String>
The option group to associate the DB cluster with.DB clusters are associated with a default option group that can't be modified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformanceInsightsKMSKeyId <String>
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformanceInsightsRetentionPeriod <Int32>
The number of days to retain Performance Insights data.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersValid Values:
  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731
Default: 7 daysIf you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which the instances in the DB cluster accept connections.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersValid Values: 1150-65535Default:
  • RDS for MySQL and Aurora MySQL - 3306
  • RDS for PostgreSQL and Aurora PostgreSQL - 5432
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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersThe default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora 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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersThe 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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.Constraints:
  • Must be in the format ddd:hh24:mi-ddd:hh24:mi.
  • Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
  • Must be in Universal Coordinated Time (UTC).
  • Must be at least 30 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreSignedUrl <String>
When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.The presigned URL request must contain the following parameter values:
  • KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
  • DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.
  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.Valid for Cluster Type: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PubliclyAccessible <Boolean>
Specifies whether the DB cluster is publicly accessible.Valid for Cluster Type: Multi-AZ DB clusters onlyWhen the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is controlled by its security group settings.When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.The default behavior when PubliclyAccessible is not specified depends on whether a DBSubnetGroup is specified.If DBSubnetGroup isn't specified, PubliclyAccessible defaults to true.If DBSubnetGroup is specified, PubliclyAccessible defaults to false unless the value of DBSubnetGroup is default, in which case PubliclyAccessible defaults to true.If PubliclyAccessible is true and the VPC that the DBSubnetGroup is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsCustomClusterConfiguration_InterconnectSubnetId <String>
Reserved for future use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsCustomClusterConfiguration_ReplicaMode <ReplicaMode>
Reserved for future use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsCustomClusterConfiguration_TransitGatewayMulticastDomainId <String>
Reserved for future use.
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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_AutoPause <Boolean>
Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_MaxCapacity <Int32>
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The maximum capacity must be greater than or equal to the minimum capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_MinCapacity <Int32>
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The minimum capacity must be less than or equal to the maximum capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_SecondsBeforeTimeout <Int32>
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.Specify a value between 60 and 600 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_SecondsUntilAutoPause <Int32>
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.Specify a value between 300 and 86,400 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_TimeoutAction <String>
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
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.RDS.Model.CreateDBClusterResponse). Specifying the name of a property of type Amazon.RDS.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)
-ServerlessV2ScalingConfiguration_MaxCapacity <Double>
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerlessV2ScalingConfiguration_SecondsUntilAutoPause <Int32>
Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceRegion <String>
The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageEncrypted <Boolean>
Specifies whether the DB cluster is encrypted.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <String>
The storage type to associate with the DB cluster.For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.This setting is required to create a Multi-AZ DB cluster.When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersValid Values:
  • Aurora DB clusters - aurora | aurora-iopt1
  • Multi-AZ DB clusters - io1 | io2 | gp3
Default:
  • Aurora DB clusters - aurora
  • Multi-AZ DB clusters - io1
When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to aurora.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Tags to assign to the DB cluster.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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

Amazon.RDS.Model.DBCluster or Amazon.RDS.Model.CreateDBClusterResponse
This cmdlet returns an Amazon.RDS.Model.DBCluster object. The service call response (type Amazon.RDS.Model.CreateDBClusterResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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