rds_modify_db_cluster: Modifies the settings of an Amazon Aurora DB cluster or a...
In paws.database: 'Amazon Web Services' Database Services
View source: R/rds_operations.R
rds_modify_db_cluster R Documentation
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB
cluster
Description
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
See https://www.paws-r-sdk.com/docs/rds_modify_db_cluster/ for full documentation.
Usage
rds_modify_db_cluster(
DBClusterIdentifier,
NewDBClusterIdentifier = NULL,
ApplyImmediately = NULL,
BackupRetentionPeriod = NULL,
DBClusterParameterGroupName = NULL,
VpcSecurityGroupIds = NULL,
Port = NULL,
MasterUserPassword = NULL,
OptionGroupName = NULL,
PreferredBackupWindow = NULL,
PreferredMaintenanceWindow = NULL,
EnableIAMDatabaseAuthentication = NULL,
BacktrackWindow = NULL,
CloudwatchLogsExportConfiguration = NULL,
EngineVersion = NULL,
AllowMajorVersionUpgrade = NULL,
DBInstanceParameterGroupName = NULL,
Domain = NULL,
DomainIAMRoleName = NULL,
ScalingConfiguration = NULL,
DeletionProtection = NULL,
EnableHttpEndpoint = NULL,
CopyTagsToSnapshot = NULL,
EnableGlobalWriteForwarding = NULL,
DBClusterInstanceClass = NULL,
AllocatedStorage = NULL,
StorageType = NULL,
Iops = NULL,
AutoMinorVersionUpgrade = NULL,
MonitoringInterval = NULL,
MonitoringRoleArn = NULL,
EnablePerformanceInsights = NULL,
PerformanceInsightsKMSKeyId = NULL,
PerformanceInsightsRetentionPeriod = NULL,
ServerlessV2ScalingConfiguration = NULL,
NetworkType = NULL,
ManageMasterUserPassword = NULL,
RotateMasterUserPassword = NULL,
MasterUserSecretKmsKeyId = NULL,
EngineMode = NULL,
AllowEngineModeChange = NULL,
EnableLocalWriteForwarding = NULL,
AwsBackupRecoveryPointArn = NULL,
EnableLimitlessDatabase = NULL,
CACertificateIdentifier = NULL
)
Arguments
DBClusterIdentifier
[required] The DB cluster identifier for the cluster being modified. This parameter
isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
NewDBClusterIdentifier
The new DB cluster identifier for the DB cluster when renaming a DB
cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
ApplyImmediately
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 disabled, changes to the DB cluster are applied during the
next maintenance window.
Most modifications can be applied immediately or during the next
scheduled maintenance window. Some modifications, such as turning on
deletion protection and changing the master password, are applied
immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
BackupRetentionPeriod
The number of days for which automated backups are retained. Specify a
minimum value of 1.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
VpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Port
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
MasterUserPassword
The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword is turned on.
OptionGroupName
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be
modified.
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 Web Services Region. To view the time
blocks available, see Backup window
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour
block of time for each Amazon Web Services Region, occurring on a random
day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window
in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
EnableIAMDatabaseAuthentication
Specifies whether to enable mapping of Amazon Web Services Identity and
Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled.
For more information, see IAM Database Authentication
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
BacktrackWindow
The target backtrack window, in seconds. To disable backtracking, set
this value to 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200
(72 hours).
CloudwatchLogsExportConfiguration
The configuration setting for the log types to be enabled for export to
CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see
Publishing Database Logs to Amazon CloudWatch Logs
in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora,
see Publishing Database Logs to Amazon CloudWatch Logs
in the Amazon Aurora User Guide.
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 ApplyImmediately is enabled.
If the cluster that you're modifying has one or more read replicas, all
replicas must be running an engine version that's the same or later than
the version you specify.
To list all of the available engine versions for Aurora MySQL, use the
following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use
the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the
following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use
the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
AllowMajorVersionUpgrade
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for
the EngineVersion parameter that is 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 the
DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted
automatically. Also, parameter changes are applied immediately rather
than during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family
as this DB cluster.
The DBInstanceParameterGroupName parameter is valid in combination
with the AllowMajorVersionUpgrade parameter for a major version
upgrade only.
Domain
The Active Directory directory ID to move the DB cluster to. Specify
none to remove the cluster from its current domain. The domain must be
created prior to this operation.
For more information, see Kerberos Authentication
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
DomainIAMRoleName
The name of the IAM role to use when making API calls to the Directory
Service.
Valid for Cluster Type: Aurora DB clusters only
ScalingConfiguration
The scaling properties of the DB cluster. You can only modify scaling
properties for DB clusters in serverless DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
DeletionProtection
Specifies whether the DB cluster has deletion protection enabled. The
database can't be deleted when deletion protection is enabled. By
default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
EnableHttpEndpoint
Specifies whether to enable the HTTP endpoint for an Aurora Serverless
v1 DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service
API (RDS Data API) for running SQL queries on the Aurora Serverless v1
DB cluster. You can also query your database from inside the RDS console
with the RDS query editor.
For more information, see Using RDS Data API
in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To
enable or disable the HTTP endpoint for an Aurora PostgreSQL Serverless
v2 or provisioned DB cluster, use the
enable_http_endpoint and
disable_http_endpoint operations.
Valid for Cluster Type: Aurora DB clusters only
CopyTagsToSnapshot
Specifies whether to copy all tags from the DB cluster to snapshots of
the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
EnableGlobalWriteForwarding
Specifies whether to enable this DB cluster to forward write operations
to the primary cluster of a global cluster (Aurora global database). By
default, write operations are not allowed on Aurora DB clusters that are
secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an
Aurora global database. With this parameter enabled, a secondary cluster
can forward writes to the current primary cluster, and the resulting
changes are replicated back to this cluster. For the primary DB cluster
of an Aurora global database, this value is used immediately if the
primary is demoted by a global cluster API operation, but it does
nothing until then.
Valid for Cluster Type: Aurora DB clusters only
DBClusterInstanceClass
The compute and memory capacity of each DB instance in the Multi-AZ DB
cluster, for example db.m6gd.xlarge. Not all DB instance classes are
available in all Amazon Web Services Regions, or for all database
engines.
For the full list of DB instance classes and availability for your
engine, see DB Instance Class
in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
AllocatedStorage
The amount of storage in gibibytes (GiB) to allocate to each DB instance
in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
StorageType
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters.
For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
Iops
The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage
in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the
DB cluster.
AutoMinorVersionUpgrade
Specifies whether minor engine upgrades are applied automatically to the
DB cluster during the maintenance window. By default, minor engine
upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
MonitoringInterval
The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB cluster. To turn off collecting
Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a
value other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
MonitoringRoleArn
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess. For information on creating a
monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring
in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a
MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
EnablePerformanceInsights
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights
in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
PerformanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance
Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId, then
Amazon RDS uses your default KMS key. There is a default KMS key for
your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
PerformanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
-
7
-
month * 31, where month is a number of months from 1-23.
Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19
months * 31)
-
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon
RDS issues an error.
ServerlessV2ScalingConfiguration
NetworkType
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup specified for the
DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the
IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
ManageMasterUserPassword
Specifies whether to manage the master user password with Amazon Web
Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon
Web Services Secrets Manager, you can turn on this management. In this
case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon
Web Services Secrets Manager, and you specify that the master user
password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword. In this case, RDS deletes the
secret and uses the new password for the master user specified by
MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager
in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
RotateMasterUserPassword
Specifies whether to rotate the secret managed by Amazon Web Services
Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS
in Amazon Web Services Secrets Manager for the DB cluster. The secret
value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager
in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user
password.
MasterUserSecretKmsKeyId
The Amazon Web Services KMS key identifier to encrypt a secret that is
automatically generated and managed in Amazon Web Services Secrets
Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web
Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon
Web Services Secrets Manager, you can't change the KMS key that is
used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master
user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify
MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is
used to encrypt the secret. If the secret is in a different Amazon
Web Services account, then you can't use the aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed
KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
ARN, or alias name for the KMS key. To use a KMS key in a different
Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your
Amazon Web Services account has a different default KMS key for each
Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
EngineMode
The DB engine mode of the DB cluster, either provisioned or
serverless.
The DB engine mode can be modified only from serverless to
provisioned.
For more information, see
CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
AllowEngineModeChange
Specifies whether engine mode changes from serverless to provisioned
are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value
for the EngineMode parameter from the DB cluster's current engine
mode.
EnableLocalWriteForwarding
Specifies whether read replicas can forward write operations to the
writer DB instance in the DB cluster. By default, write operations
aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
AwsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web
Services Backup.
EnableLimitlessDatabase
Specifies whether to enable Aurora Limitless Database. You must enable
Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
CACertificateIdentifier
The CA certificate identifier to use for the DB cluster's server
certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance
in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
paws.database documentation built on Sept. 12, 2024, 6:37 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/rds_operations.R
| rds_modify_db_cluster | R Documentation |
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster
Description
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
See https://www.paws-r-sdk.com/docs/rds_modify_db_cluster/ for full documentation.
Usage
rds_modify_db_cluster(
DBClusterIdentifier,
NewDBClusterIdentifier = NULL,
ApplyImmediately = NULL,
BackupRetentionPeriod = NULL,
DBClusterParameterGroupName = NULL,
VpcSecurityGroupIds = NULL,
Port = NULL,
MasterUserPassword = NULL,
OptionGroupName = NULL,
PreferredBackupWindow = NULL,
PreferredMaintenanceWindow = NULL,
EnableIAMDatabaseAuthentication = NULL,
BacktrackWindow = NULL,
CloudwatchLogsExportConfiguration = NULL,
EngineVersion = NULL,
AllowMajorVersionUpgrade = NULL,
DBInstanceParameterGroupName = NULL,
Domain = NULL,
DomainIAMRoleName = NULL,
ScalingConfiguration = NULL,
DeletionProtection = NULL,
EnableHttpEndpoint = NULL,
CopyTagsToSnapshot = NULL,
EnableGlobalWriteForwarding = NULL,
DBClusterInstanceClass = NULL,
AllocatedStorage = NULL,
StorageType = NULL,
Iops = NULL,
AutoMinorVersionUpgrade = NULL,
MonitoringInterval = NULL,
MonitoringRoleArn = NULL,
EnablePerformanceInsights = NULL,
PerformanceInsightsKMSKeyId = NULL,
PerformanceInsightsRetentionPeriod = NULL,
ServerlessV2ScalingConfiguration = NULL,
NetworkType = NULL,
ManageMasterUserPassword = NULL,
RotateMasterUserPassword = NULL,
MasterUserSecretKmsKeyId = NULL,
EngineMode = NULL,
AllowEngineModeChange = NULL,
EnableLocalWriteForwarding = NULL,
AwsBackupRecoveryPointArn = NULL,
EnableLimitlessDatabase = NULL,
CACertificateIdentifier = NULL
)
Arguments
DBClusterIdentifier |
[required] The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
NewDBClusterIdentifier |
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
Example: |
ApplyImmediately |
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them. By default, this parameter is disabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
BackupRetentionPeriod |
The number of days for which automated backups are retained. Specify a
minimum value of Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Default: Constraints:
|
DBClusterParameterGroupName |
The name of the DB cluster parameter group to use for the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
VpcSecurityGroupIds |
A list of EC2 VPC security groups to associate with this DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
Port |
The port number on which the DB cluster accepts connections. Valid for Cluster Type: Aurora DB clusters only Valid Values: Default: The same port as the original DB cluster. |
MasterUserPassword |
The new password for the master database user. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
OptionGroupName |
The option group to associate the DB cluster with. DB clusters are associated with a default option group that can't be modified. |
PreferredBackupWindow |
The daily time range during which automated backups are created if
automated backups are enabled, using the The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
PreferredMaintenanceWindow |
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Constraints:
|
EnableIAMDatabaseAuthentication |
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only |
BacktrackWindow |
The target backtrack window, in seconds. To disable backtracking, set
this value to Valid for Cluster Type: Aurora MySQL DB clusters only Default: Constraints:
|
CloudwatchLogsExportConfiguration |
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The following values are valid for each DB engine:
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. |
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 If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify. To list all of the available engine versions for Aurora MySQL, use the following command:
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
To list all of the available engine versions for RDS for MySQL, use the following command:
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
AllowMajorVersionUpgrade |
Specifies whether major version upgrades are allowed. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
DBInstanceParameterGroupName |
The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using the
Valid for Cluster Type: Aurora DB clusters only Default: The existing name setting Constraints:
|
Domain |
The Active Directory directory ID to move the DB cluster to. Specify
For more information, see Kerberos Authentication in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only |
DomainIAMRoleName |
The name of the IAM role to use when making API calls to the Directory Service. Valid for Cluster Type: Aurora DB clusters only |
ScalingConfiguration |
The scaling properties of the DB cluster. You can only modify scaling
properties for DB clusters in Valid for Cluster Type: Aurora DB clusters only |
DeletionProtection |
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
EnableHttpEndpoint |
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the Amazon Aurora User Guide. This parameter applies only to Aurora Serverless v1 DB clusters. To
enable or disable the HTTP endpoint for an Aurora PostgreSQL Serverless
v2 or provisioned DB cluster, use the
Valid for Cluster Type: Aurora DB clusters only |
CopyTagsToSnapshot |
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
EnableGlobalWriteForwarding |
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. Valid for Cluster Type: Aurora DB clusters only |
DBClusterInstanceClass |
The compute and memory capacity of each DB instance in the Multi-AZ DB
cluster, for example For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only |
AllocatedStorage |
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only |
StorageType |
The storage type to associate with the DB cluster. For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters. When specified for a Multi-AZ DB cluster, a value for the Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values:
Default:
|
Iops |
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only Constraints:
|
AutoMinorVersionUpgrade |
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only |
MonitoringInterval |
The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB cluster. To turn off collecting
Enhanced Monitoring metrics, specify If Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: Default: |
MonitoringRoleArn |
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
If Valid for Cluster Type: Multi-AZ DB clusters only |
EnablePerformanceInsights |
Specifies whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only |
PerformanceInsightsKMSKeyId |
The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for Valid for Cluster Type: Multi-AZ DB clusters only |
PerformanceInsightsRetentionPeriod |
The number of days to retain Performance Insights data. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values:
Default: If you specify a retention period that isn't valid, such as |
ServerlessV2ScalingConfiguration |
|
NetworkType |
The network type of the DB cluster. The network type is determined by the For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only Valid Values: |
ManageMasterUserPassword |
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the DB cluster doesn't manage the master user password with Amazon
Web Services Secrets Manager, you can turn on this management. In this
case, you can't specify If the DB cluster already manages the master user password with Amazon
Web Services Secrets Manager, and you specify that the master user
password is not managed with Amazon Web Services Secrets Manager, then
you must specify For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
RotateMasterUserPassword |
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
MasterUserSecretKmsKeyId |
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if both of the following conditions are met:
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
EngineMode |
The DB engine mode of the DB cluster, either The DB engine mode can be modified only from For more information, see CreateDBCluster. Valid for Cluster Type: Aurora DB clusters only |
AllowEngineModeChange |
Specifies whether engine mode changes from Valid for Cluster Type: Aurora Serverless v1 DB clusters only Constraints:
|
EnableLocalWriteForwarding |
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only |
AwsBackupRecoveryPointArn |
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. |
EnableLimitlessDatabase |
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB clusters only |
CACertificateIdentifier |
The CA certificate identifier to use for the DB cluster's server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.