Modify Db Cluster
neptune_modify_db_cluster | R Documentation |
Modify a setting for a DB cluster¶
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.
Usage¶
neptune_modify_db_cluster(DBClusterIdentifier, NewDBClusterIdentifier,
ApplyImmediately, BackupRetentionPeriod, DBClusterParameterGroupName,
VpcSecurityGroupIds, Port, MasterUserPassword, OptionGroupName,
PreferredBackupWindow, PreferredMaintenanceWindow,
EnableIAMDatabaseAuthentication, CloudwatchLogsExportConfiguration,
EngineVersion, AllowMajorVersionUpgrade, DBInstanceParameterGroupName,
DeletionProtection, CopyTagsToSnapshot,
ServerlessV2ScalingConfiguration, StorageType)
Arguments¶
DBClusterIdentifier
[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.
NewDBClusterIdentifier
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
ApplyImmediately
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 tofalse
, changes to the DB cluster are applied during the next maintenance window.The
ApplyImmediately
parameter only affectsNewDBClusterIdentifier
values. If you set theApplyImmediately
parameter value to false, then changes toNewDBClusterIdentifier
values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediately
parameter.Default:
false
BackupRetentionPeriod
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
DBClusterParameterGroupName
The name of the DB cluster parameter group to use for the DB cluster.
VpcSecurityGroupIds
A list of VPC security groups that the DB cluster will belong to.
Port
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.
MasterUserPassword
Not supported by Neptune.
OptionGroupName
Not supported by Neptune.
PreferredBackupWindow
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.
PreferredMaintenanceWindow
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 Amazon Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
EnableIAMDatabaseAuthentication
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default:
false
CloudwatchLogsExportConfiguration
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.
EngineVersion
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
.AllowMajorVersionUpgrade
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.DBInstanceParameterGroupName
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
DBInstanceParameterGroupName
parameter is only valid in combination with theAllowMajorVersionUpgrade
parameter.
DeletionProtection
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.
CopyTagsToSnapshot
If set to true, tags are copied to any snapshot of the DB cluster that is created.
ServerlessV2ScalingConfiguration
Contains the scaling configuration of a Neptune Serverless DB cluster.
For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.
StorageType
The storage type to associate with the DB cluster.
Valid Values:
standard | iopt1
Default:
standard
Value¶
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"
),
CopyTagsToSnapshot = TRUE|FALSE,
EnabledCloudwatchLogsExports = list(
"string"
),
PendingModifiedValues = list(
PendingCloudwatchLogsExports = list(
LogTypesToEnable = list(
"string"
),
LogTypesToDisable = list(
"string"
)
),
DBClusterIdentifier = "string",
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
EngineVersion = "string",
BackupRetentionPeriod = 123,
StorageType = "string",
AllocatedStorage = 123,
Iops = 123
),
DeletionProtection = TRUE|FALSE,
CrossAccountClone = TRUE|FALSE,
AutomaticRestartTime = as.POSIXct(
"2015-01-01"
),
ServerlessV2ScalingConfiguration = list(
MinCapacity = 123.0,
MaxCapacity = 123.0
),
GlobalClusterIdentifier = "string",
IOOptimizedNextAllowedModificationTime = as.POSIXct(
"2015-01-01"
),
StorageType = "string"
)
)
Request syntax¶
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",
AllowMajorVersionUpgrade = TRUE|FALSE,
DBInstanceParameterGroupName = "string",
DeletionProtection = TRUE|FALSE,
CopyTagsToSnapshot = TRUE|FALSE,
ServerlessV2ScalingConfiguration = list(
MinCapacity = 123.0,
MaxCapacity = 123.0
),
StorageType = "string"
)