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

Syntax

Edit-RDSDBCluster
-DBClusterIdentifier <String>
-AllocatedStorage <Int32>
-AllowEngineModeChange <Boolean>
-AllowMajorVersionUpgrade <Boolean>
-ApplyImmediately <Boolean>
-AutoMinorVersionUpgrade <Boolean>
-ScalingConfiguration_AutoPause <Boolean>
-AwsBackupRecoveryPointArn <String>
-BacktrackWindow <Int64>
-BackupRetentionPeriod <Int32>
-CACertificateIdentifier <String>
-CopyTagsToSnapshot <Boolean>
-DatabaseInsightsMode <DatabaseInsightsMode>
-DBClusterInstanceClass <String>
-DBClusterParameterGroupName <String>
-DBInstanceParameterGroupName <String>
-DeletionProtection <Boolean>
-CloudwatchLogsExportConfiguration_DisableLogType <String[]>
-Domain <String>
-DomainIAMRoleName <String>
-EnableGlobalWriteForwarding <Boolean>
-EnableHttpEndpoint <Boolean>
-EnableIAMDatabaseAuthentication <Boolean>
-EnableLimitlessDatabase <Boolean>
-EnableLocalWriteForwarding <Boolean>
-CloudwatchLogsExportConfiguration_EnableLogType <String[]>
-EnablePerformanceInsight <Boolean>
-EngineMode <String>
-EngineVersion <String>
-Iops <Int32>
-ManageMasterUserPassword <Boolean>
-MasterUserPassword <String>
-MasterUserSecretKmsKeyId <String>
-ScalingConfiguration_MaxCapacity <Int32>
-ServerlessV2ScalingConfiguration_MaxCapacity <Double>
-ScalingConfiguration_MinCapacity <Int32>
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
-MonitoringInterval <Int32>
-MonitoringRoleArn <String>
-NetworkType <String>
-NewDBClusterIdentifier <String>
-OptionGroupName <String>
-PerformanceInsightsKMSKeyId <String>
-PerformanceInsightsRetentionPeriod <Int32>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-RotateMasterUserPassword <Boolean>
-ScalingConfiguration_SecondsBeforeTimeout <Int32>
-ScalingConfiguration_SecondsUntilAutoPause <Int32>
-ServerlessV2ScalingConfiguration_SecondsUntilAutoPause <Int32>
-StorageType <String>
-ScalingConfiguration_TimeoutAction <String>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonRDSConfig>

Description

Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on 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 only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowEngineModeChange <Boolean>
Specifies whether engine mode changes from serverless to provisioned are allowed.Valid for Cluster Type: Aurora Serverless v1 DB clusters onlyConstraints:
  • You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowMajorVersionUpgrade <Boolean>
Specifies whether major version upgrades are allowed.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApplyImmediately <Boolean>
Specifies whether the modifications in this request are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.By default, this parameter is disabled.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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 clusters.For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsBackupRecoveryPointArn <String>
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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. Specify a minimum value of 1.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)
-ClientConfig <AmazonRDSConfig>
Amazon.PowerShell.Cmdlets.RDS.AmazonRDSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudwatchLogsExportConfiguration_DisableLogType <String[]>
The list of log types to disable.The following values are valid for each DB engine:
  • Aurora MySQL - audit | error | general | slowquery
  • Aurora PostgreSQL - postgresql
  • RDS for MySQL - error | general | slowquery
  • RDS for PostgreSQL - postgresql | upgrade
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudwatchLogsExportConfiguration_DisableLogTypes
-CloudwatchLogsExportConfiguration_EnableLogType <String[]>
The list of log types to enable.The following values are valid for each DB engine:
  • Aurora MySQL - audit | error | general | slowquery
  • Aurora PostgreSQL - postgresql
  • RDS for MySQL - error | general | slowquery
  • RDS for PostgreSQL - postgresql | upgrade
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudwatchLogsExportConfiguration_EnableLogTypes
-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>
Specifies the mode of Database Insights to enable for the DB cluster.If you change the value from standard to advanced, you must set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.If you change the value from advanced to standard, you must set the PerformanceInsightsEnabled parameter to false.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • Must match the identifier of an existing DB cluster.
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.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 use for the DB cluster.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceParameterGroupName <String>
The name of the DB parameter group to apply to all instances of the DB cluster.When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.Valid for Cluster Type: Aurora DB clusters onlyDefault: The existing name settingConstraints:
  • The DB parameter group must be in the same DB parameter group family as this DB cluster.
  • The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
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 move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.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)
-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 an Aurora Serverless v1 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 Aurora Serverless v1 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.This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.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 when you create your Aurora Limitless Database DB cluster.
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
-EngineMode <String>
The DB engine mode of the DB cluster, either provisioned or serverless.The DB engine mode can be modified only from serverless to provisioned.For more information, see CreateDBCluster.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 which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.To list all of the available engine versions for Aurora MySQL, use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"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"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)
-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 Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.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)
-ManageMasterUserPassword <Boolean>
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.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 clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserPassword <String>
The new 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 both of the following conditions are met:
  • The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
  • You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.If you are turning on ManageMasterUserPassword and 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.
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.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: Multi-AZ DB clusters onlyValid 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 To create an IAM role for Amazon RDS 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: Multi-AZ DB clusters only
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)
-NewDBClusterIdentifier <String>
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DBClusterIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^DBClusterIdentifier' instead. This parameter will be removed in a future version.
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 DB cluster accepts connections.Valid for Cluster Type: Aurora DB clusters onlyValid Values: 1150-65535Default: The same port as the original DB cluster.
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.The 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.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersConstraints:
  • 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, in Universal Coordinated Time (UTC).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)
-RotateMasterUserPassword <Boolean>
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.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 secret value contains the updated password.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:
  • You must apply the change immediately when rotating the master user password.
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.ModifyDBClusterResponse). Specifying the name of a property of type Amazon.RDS.Model.ModifyDBClusterResponse 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.
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)
-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.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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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
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.ModifyDBClusterResponse
This cmdlet returns an Amazon.RDS.Model.DBCluster object. The service call response (type Amazon.RDS.Model.ModifyDBClusterResponse) 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