/AWS1/CL_NEP=>MODIFYDBCLUSTER()¶
About ModifyDBCluster¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DBCLUSTERIDENTIFIER TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
Optional arguments:¶
IV_NEWDBCLUSTERIDENTIFIER TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
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
IV_APPLYIMMEDIATELY TYPE /AWS1/NEPBOOLEAN /AWS1/NEPBOOLEAN¶
A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindowsetting for the DB cluster. If this parameter is set tofalse, changes to the DB cluster are applied during the next maintenance window.The
ApplyImmediatelyparameter only affectsNewDBClusterIdentifiervalues. If you set theApplyImmediatelyparameter value to false, then changes toNewDBClusterIdentifiervalues are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediatelyparameter.Default:
false
IV_BACKUPRETENTIONPERIOD TYPE /AWS1/NEPINTEGEROPTIONAL /AWS1/NEPINTEGEROPTIONAL¶
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
IV_DBCLUSTERPARAMGROUPNAME TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The name of the DB cluster parameter group to use for the DB cluster.
IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_NEPVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST¶
A list of VPC security groups that the DB cluster will belong to.
IV_PORT TYPE /AWS1/NEPINTEGEROPTIONAL /AWS1/NEPINTEGEROPTIONAL¶
The port number on which the DB cluster accepts connections.
Constraints: Value must be
1150-65535Default: The same port as the original DB cluster.
IV_MASTERUSERPASSWORD TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
Not supported by Neptune.
IV_OPTIONGROUPNAME TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
Not supported by Neptune.
IV_PREFERREDBACKUPWINDOW TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriodparameter.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.
IV_PREFERREDMAINTENANCEWIN00 TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
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.
IV_ENBIAMDATABASEAUTHNTCTN TYPE /AWS1/NEPBOOLEANOPTIONAL /AWS1/NEPBOOLEANOPTIONAL¶
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default:
false
IO_CLOUDWATCHLOGSEXPORTCONF TYPE REF TO /AWS1/CL_NEPCLOUDWATCHLOGSEX00 /AWS1/CL_NEPCLOUDWATCHLOGSEX00¶
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. See Using the CLI to publish Neptune audit logs to CloudWatch Logs.
IV_ENGINEVERSION TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
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
ApplyImmediatelyparameter is set to true.For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
IV_ALLOWMAJORVERSIONUPGRADE TYPE /AWS1/NEPBOOLEAN /AWS1/NEPBOOLEAN¶
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
EngineVersionparameter that uses a different major version than the DB cluster's current version.
IV_DBINSTANCEPARAMGROUPNAME TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
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 setting
Constraints:
The DB parameter group must be in the same DB parameter group family as the target DB cluster version.
The
DBInstanceParameterGroupNameparameter is only valid in combination with theAllowMajorVersionUpgradeparameter.
IV_DELETIONPROTECTION TYPE /AWS1/NEPBOOLEANOPTIONAL /AWS1/NEPBOOLEANOPTIONAL¶
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.
IV_COPYTAGSTOSNAPSHOT TYPE /AWS1/NEPBOOLEANOPTIONAL /AWS1/NEPBOOLEANOPTIONAL¶
If set to
true, tags are copied to any snapshot of the DB cluster that is created.
IO_SERVERLESSV2SCALINGCONF TYPE REF TO /AWS1/CL_NEPSERVERLESSV2SCAC00 /AWS1/CL_NEPSERVERLESSV2SCAC00¶
Contains the scaling configuration of a Neptune Serverless DB cluster.
For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.
IV_STORAGETYPE TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The storage type to associate with the DB cluster.
Valid Values:
standard | iopt1Default:
standard