Builder

class Builder

Properties

Link copied to clipboard

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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:

Link copied to clipboard

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Link copied to clipboard

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.

Link copied to clipboard

The CA certificate identifier to use for the DB instance's server certificate.

Link copied to clipboard

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

Link copied to clipboard

The log types to be enabled for export to CloudWatch Logs for a specific DB instance.

Link copied to clipboard

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.

Link copied to clipboard

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.

Link copied to clipboard

The identifier of DB instance to modify. This value is stored as a lowercase string.

Link copied to clipboard

The name of the DB parameter group to apply to the DB instance.

Link copied to clipboard

The port number on which the database accepts connections.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Link copied to clipboard

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.

Link copied to clipboard

Specifies whether to remove the DB instance from the Active Directory domain.

Link copied to clipboard

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.

Link copied to clipboard

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

Link copied to clipboard

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

Link copied to clipboard

The fully qualified domain name (FQDN) of an Active Directory domain.

Link copied to clipboard

The name of the IAM role to use when making API calls to the Directory Service.

Link copied to clipboard

The Active Directory organizational unit for your DB instance to join.

Link copied to clipboard

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

Link copied to clipboard

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

Link copied to clipboard

Specifies whether to enable Performance Insights for the DB instance.

Link copied to clipboard

The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.

Link copied to clipboard

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.

Link copied to clipboard
var iops: Int?

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Link copied to clipboard

The license model for the DB instance.

Link copied to clipboard

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

Link copied to clipboard

The new password for the master user.

Link copied to clipboard

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

Link copied to clipboard

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

Link copied to clipboard

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.

Link copied to clipboard

The network type of the DB instance.

Link copied to clipboard

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.

Link copied to clipboard

The option group to associate the DB instance with.

Link copied to clipboard

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

Link copied to clipboard

The number of days to retain Performance Insights data.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Link copied to clipboard

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.

Link copied to clipboard

Specifies whether the DB instance is publicly accessible.

Link copied to clipboard

A value that sets the open mode of a replica database to either mounted or read-only.

Link copied to clipboard

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.

Link copied to clipboard

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

Link copied to clipboard

The storage throughput value for the DB instance.

Link copied to clipboard

The storage type to associate with the DB instance.

Link copied to clipboard

The ARN from the key store with which to associate the instance for TDE encryption.

Link copied to clipboard

The password for the given ARN from the key store in order to access the device.

Link copied to clipboard

Specifies whether the DB instance class of the DB instance uses its default processor features.

Link copied to clipboard

A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.