Builder
Properties
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
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 instance. By default, this parameter is disabled.
The automation mode of the RDS Custom DB instance. If full
, the DB instance automates monitoring and instance recovery. If all paused
, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
The CA certificate identifier to use for the DB instance's server certificate.
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
The new compute and memory capacity of the DB instance, for example db.m4.large
. 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 or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
The identifier of DB instance to modify. This value is stored as a lowercase string.
The name of the DB parameter group to apply to the DB instance.
The port number on which the database accepts connections.
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
Specifies whether to remove the DB instance from the Active Directory domain.
The Active Directory directory ID to move the DB instance to. Specify none
to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
The fully qualified domain name (FQDN) of an Active Directory domain.
The name of the IAM role to use when making API calls to the Directory Service.
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
Specifies whether to enable Performance Insights for the DB instance.
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request.
The license model for the DB instance.
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
The new password for the master user.
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0
.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, 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.
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
The network type of the DB instance.
The new identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately
, or will occur during the next maintenance window if you disable ApplyImmediately
. This value is stored as a lowercase string.
The option group to associate the DB instance with.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The number of days to retain Performance Insights data.
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod
parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
The weekly time range during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter causes a reboot of the DB instance. If you change this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Specifies whether the DB instance is publicly accessible.
A value that sets the open mode of a replica database to either mounted or read-only.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
The storage throughput value for the DB instance.
The storage type to associate with the DB instance.
The ARN from the key store with which to associate the instance for TDE encryption.
The password for the given ARN from the key store in order to access the device.
Specifies whether the DB instance class of the DB instance uses its default processor features.
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
Functions
construct an aws.sdk.kotlin.services.rds.model.CloudwatchLogsExportConfiguration inside the given block