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>
-AllowMajorVersionUpgrade <Boolean>
-ApplyImmediately <Boolean>
-ScalingConfiguration_AutoPause <Boolean>
-BacktrackWindow <Int64>
-BackupRetentionPeriod <Int32>
-CopyTagsToSnapshot <Boolean>
-DBClusterParameterGroupName <String>
-DBInstanceParameterGroupName <String>
-DeletionProtection <Boolean>
-CloudwatchLogsExportConfiguration_DisableLogType <String[]>
-EnableHttpEndpoint <Boolean>
-EnableIAMDatabaseAuthentication <Boolean>
-CloudwatchLogsExportConfiguration_EnableLogType <String[]>
-EngineVersion <String>
-MasterUserPassword <String>
-ScalingConfiguration_MaxCapacity <Int32>
-ScalingConfiguration_MinCapacity <Int32>
-NewDBClusterIdentifier <String>
-OptionGroupName <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-ScalingConfiguration_SecondsUntilAutoPause <Int32>
-ScalingConfiguration_TimeoutAction <String>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

Parameters

-AllowMajorVersionUpgrade <Boolean>
A value that indicates whether major version upgrades are allowed.Constraints: 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>
A value that indicates whether the modifications in this request and any pending modifications 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.The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.By default, this parameter is disabled.
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.Default: 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. You must specify a minimum value of 1.Default: 1Constraints:
  • Must be a value from 1 to 35
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudwatchLogsExportConfiguration_DisableLogType <String[]>
The list of log types to disable.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudwatchLogsExportConfiguration_DisableLogTypes
-CloudwatchLogsExportConfiguration_EnableLogType <String[]>
The list of log types to enable.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudwatchLogsExportConfiguration_EnableLogTypes
-CopyTagsToSnapshot <Boolean>
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
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.Constraints: This identifier must match the identifier of an existing DB cluster.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DBClusterParameterGroupName <String>
The name of the DB cluster parameter group to use for the DB cluster.
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 aren't applied during the next maintenance window but instead are applied immediately.Default: 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 only valid in combination with the AllowMajorVersionUpgrade parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableHttpEndpoint <Boolean>
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableIAMDatabaseAuthentication <Boolean>
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
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.To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), 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"
Required?False
Position?Named
Accept pipeline input?True (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)
-MasterUserPassword <String>
The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".Constraints: Must contain from 8 to 41 characters.
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.Constraints:
  • 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>
A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
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)
-Port <Int32>
The port number on which the DB cluster accepts connections.Constraints: Value must be 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 AWS Region. 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 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).Format: ddd:hh24:mi-ddd:hh24:miThe default is a 30-minute window selected at random from an 8-hour block of time for each AWS 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.Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.Constraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_AutoPause <Boolean>
A value that 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_SecondsUntilAutoPause <Int32>
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
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 from finding a scaling point might be dropped.For more information, see Autoscaling for Aurora Serverless 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)
-VpcSecurityGroupId <String[]>
A list of VPC security groups that the DB cluster will belong to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSecurityGroupIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.RDS.Model.DBCluster object. The service call response (type Amazon.RDS.Model.ModifyDBClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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