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

Syntax

Edit-DOCDBCluster
-DBClusterIdentifier <String>
-ApplyImmediately <Boolean>
-BackupRetentionPeriod <Int32>
-DBClusterParameterGroupName <String>
-DeletionProtection <Boolean>
-CloudwatchLogsExportConfiguration_DisableLogType <String[]>
-CloudwatchLogsExportConfiguration_EnableLogType <String[]>
-EngineVersion <String>
-MasterUserPassword <String>
-NewDBClusterIdentifier <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-VpcSecurityGroupId <String[]>
-Force <SwitchParameter>

Description

Modifies a setting for an Amazon DocumentDB DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Parameters

-ApplyImmediately <Boolean>
A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.Default: false
Required?False
Position?Named
Accept pipeline input?False
-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?False
-CloudwatchLogsExportConfiguration_DisableLogType <String[]>
The list of log types to disable.
Required?False
Position?Named
Accept pipeline input?False
AliasesCloudwatchLogsExportConfiguration_DisableLogTypes
-CloudwatchLogsExportConfiguration_EnableLogType <String[]>
The list of log types to enable.
Required?False
Position?Named
Accept pipeline input?False
AliasesCloudwatchLogsExportConfiguration_EnableLogTypes
-DBClusterIdentifier <String>
The DB cluster identifier for the cluster that is being modified. This parameter is not case sensitive.Constraints:
  • Must match the identifier of an existing DBCluster.
Required?False
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?False
-DeletionProtection <Boolean>
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Required?False
Position?Named
Accept pipeline input?False
-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 the ApplyImmediately parameter is set to true.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-MasterUserPassword <String>
The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).Constraints: Must contain from 8 to 41 characters.
Required?False
Position?Named
Accept pipeline input?False
-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.
  • Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
Required?False
Position?Named
Accept pipeline input?False
-Port <Int32>
The port number on which the DB cluster accepts connections.Constraints: Must be a value from 1150 to 65535. Default: The same port as the original DB cluster.
Required?False
Position?Named
Accept pipeline input?False
-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. 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?False
-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. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, SunConstraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?False
-VpcSecurityGroupId <String[]>
A list of virtual private cloud (VPC) security groups that the DB cluster will belong to.
Required?False
Position?Named
Accept pipeline input?False
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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the DBClusterIdentifier parameter.

Outputs

This cmdlet returns a Amazon.DocDB.Model.DBCluster object. The service call response (type Amazon.DocDB.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