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

Syntax

Edit-NPTDBCluster
-DBClusterIdentifier <String>
-AllowMajorVersionUpgrade <Boolean>
-ApplyImmediately <Boolean>
-BackupRetentionPeriod <Int32>
-CopyTagsToSnapshot <Boolean>
-DBClusterParameterGroupName <String>
-DBInstanceParameterGroupName <String>
-DeletionProtection <Boolean>
-CloudwatchLogsExportConfiguration_DisableLogType <String[]>
-EnableIAMDatabaseAuthentication <Boolean>
-CloudwatchLogsExportConfiguration_EnableLogType <String[]>
-EngineVersion <String>
-MasterUserPassword <String>
-ServerlessV2ScalingConfiguration_MaxCapacity <Double>
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
-NewDBClusterIdentifier <String>
-OptionGroupName <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-StorageType <String>
-VpcSecurityGroupId <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonNeptuneConfig>

Description

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

Parameters

-AllowMajorVersionUpgrade <Boolean>
A value that indicates whether upgrades between different major versions are allowed.Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses 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 specifies 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 set to false, changes to the DB cluster are applied during the next maintenance window.The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier 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?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)
-ClientConfig <AmazonNeptuneConfig>
Amazon.PowerShell.Cmdlets.NPT.AmazonNeptuneClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudwatchLogsExportConfiguration_DisableLogType <String[]>
The list of log types to disable. 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)
AliasesCloudwatchLogsExportConfiguration_DisableLogTypes
-CloudwatchLogsExportConfiguration_EnableLogType <String[]>
The list of log types to enable. 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)
AliasesCloudwatchLogsExportConfiguration_EnableLogTypes
-CopyTagsToSnapshot <Boolean>
If set to true, tags are copied to any snapshot of the DB cluster that is created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.Constraints:
  • Must match the identifier of an existing DBCluster.
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 DBInstanceParameterGroupName, 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 the target DB cluster version.
  • 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)
-EnableIAMDatabaseAuthentication <Boolean>
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.Default: false
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 the ApplyImmediately parameter is set to true.For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
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)
-MasterUserPassword <String>
Not supported by Neptune.
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
  • Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionGroupName <String>
Not supported by Neptune.
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 Amazon 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?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 Amazon Region, occurring on a random day of the week.Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.Constraints: Minimum 30-minute window.
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.Neptune.Model.ModifyDBClusterResponse). Specifying the name of a property of type Amazon.Neptune.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 Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <String>
The storage type to associate with the DB cluster.Valid Values:
  • standard   –   ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.
  • iopt1   –   Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcSecurityGroupId <String[]>
A list of VPC security groups that the DB cluster will belong to. 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.Neptune.Model.DBCluster or Amazon.Neptune.Model.ModifyDBClusterResponse
This cmdlet returns an Amazon.Neptune.Model.DBCluster object. The service call response (type Amazon.Neptune.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