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.
neptune_modify_db_cluster(DBClusterIdentifier, NewDBClusterIdentifier,
ApplyImmediately, BackupRetentionPeriod, DBClusterParameterGroupName,
VpcSecurityGroupIds, Port, MasterUserPassword, OptionGroupName,
PreferredBackupWindow, PreferredMaintenanceWindow,
EnableIAMDatabaseAuthentication, CloudwatchLogsExportConfiguration,
EngineVersion, DeletionProtection)
A list with the following syntax:
list(
DBCluster = list(
AllocatedStorage = 123,
AvailabilityZones = list(
"string"
),
BackupRetentionPeriod = 123,
CharacterSetName = "string",
DatabaseName = "string",
DBClusterIdentifier = "string",
DBClusterParameterGroup = "string",
DBSubnetGroup = "string",
Status = "string",
PercentProgress = "string",
EarliestRestorableTime = as.POSIXct(
"2015-01-01"
),
Endpoint = "string",
ReaderEndpoint = "string",
MultiAZ = TRUE|FALSE,
Engine = "string",
EngineVersion = "string",
LatestRestorableTime = as.POSIXct(
"2015-01-01"
),
Port = 123,
MasterUsername = "string",
DBClusterOptionGroupMemberships = list(
list(
DBClusterOptionGroupName = "string",
Status = "string"
)
),
PreferredBackupWindow = "string",
PreferredMaintenanceWindow = "string",
ReplicationSourceIdentifier = "string",
ReadReplicaIdentifiers = list(
"string"
),
DBClusterMembers = list(
list(
DBInstanceIdentifier = "string",
IsClusterWriter = TRUE|FALSE,
DBClusterParameterGroupStatus = "string",
PromotionTier = 123
)
),
VpcSecurityGroups = list(
list(
VpcSecurityGroupId = "string",
Status = "string"
)
),
HostedZoneId = "string",
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
DbClusterResourceId = "string",
DBClusterArn = "string",
AssociatedRoles = list(
list(
RoleArn = "string",
Status = "string",
FeatureName = "string"
)
),
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
CloneGroupId = "string",
ClusterCreateTime = as.POSIXct(
"2015-01-01"
),
EnabledCloudwatchLogsExports = list(
"string"
),
DeletionProtection = TRUE|FALSE
)
)
[required] The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
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
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 the
NewDBClusterIdentifier
and MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then 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
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
The name of the DB cluster parameter group to use for the DB cluster.
A list of VPC security groups that the DB cluster will belong to.
The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
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.
(Not supported by Neptune)
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.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The 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, Sun.
Constraints: Minimum 30-minute window.
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
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
describe_db_engine_versions
.
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.
svc$modify_db_cluster(
DBClusterIdentifier = "string",
NewDBClusterIdentifier = "string",
ApplyImmediately = TRUE|FALSE,
BackupRetentionPeriod = 123,
DBClusterParameterGroupName = "string",
VpcSecurityGroupIds = list(
"string"
),
Port = 123,
MasterUserPassword = "string",
OptionGroupName = "string",
PreferredBackupWindow = "string",
PreferredMaintenanceWindow = "string",
EnableIAMDatabaseAuthentication = TRUE|FALSE,
CloudwatchLogsExportConfiguration = list(
EnableLogTypes = list(
"string"
),
DisableLogTypes = list(
"string"
)
),
EngineVersion = "string",
DeletionProtection = TRUE|FALSE
)