Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications
before you call ModifyDBInstance
.
See also: AWS API Documentation
modify-db-instance
--db-instance-identifier <value>
[--allocated-storage <value>]
[--db-instance-class <value>]
[--db-subnet-group-name <value>]
[--db-security-groups <value>]
[--vpc-security-group-ids <value>]
[--apply-immediately | --no-apply-immediately]
[--master-user-password <value>]
[--db-parameter-group-name <value>]
[--backup-retention-period <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--multi-az | --no-multi-az]
[--engine-version <value>]
[--allow-major-version-upgrade | --no-allow-major-version-upgrade]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--license-model <value>]
[--iops <value>]
[--option-group-name <value>]
[--new-db-instance-identifier <value>]
[--storage-type <value>]
[--tde-credential-arn <value>]
[--tde-credential-password <value>]
[--ca-certificate-identifier <value>]
[--domain <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--monitoring-interval <value>]
[--db-port-number <value>]
[--publicly-accessible | --no-publicly-accessible]
[--monitoring-role-arn <value>]
[--domain-iam-role-name <value>]
[--promotion-tier <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--performance-insights-retention-period <value>]
[--cloudwatch-logs-export-configuration <value>]
[--processor-features <value>]
[--use-default-processor-features | --no-use-default-processor-features]
[--deletion-protection | --no-deletion-protection]
[--max-allocated-storage <value>]
[--certificate-rotation-restart | --no-certificate-rotation-restart]
[--replica-mode <value>]
[--enable-customer-owned-ip | --no-enable-customer-owned-ip]
[--aws-backup-recovery-point-arn <value>]
[--automation-mode <value>]
[--resume-full-automation-mode-minutes <value>]
[--network-type <value>]
[--storage-throughput <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--db-instance-identifier
(string)
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
--allocated-storage
(integer)
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see
CreateDBInstance
.
--db-instance-class
(string)
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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide .
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless
ApplyImmediately
is enabled for this request.This setting doesn’t apply to RDS Custom for Oracle.
Default: Uses existing setting
--db-subnet-group-name
(string)
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 .
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable
ApplyImmediately
.This parameter doesn’t apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
--db-security-groups
(list)
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.
This setting doesn’t apply to RDS Custom.
Constraints:
If supplied, must match existing DBSecurityGroups.
(string)
Syntax:
"string" "string" ...
--vpc-security-group-ids
(list)
A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see
ModifyDBCluster
.Constraints:
If supplied, must match existing VpcSecurityGroupIds.
(string)
Syntax:
"string" "string" ...
--apply-immediately
| --no-apply-immediately
(boolean)
A value that indicates 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.If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance , or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling
ApplyImmediately
for each modified parameter and to determine when the changes are applied.
--master-user-password
(string)
The new password for the master user. The password can include any printable ASCII character except “/”, “””, or “@”.
Changing this parameter doesn’t result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the
MasterUserPassword
element exists in thePendingModifiedValues
element of the operation response.This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Note
Amazon RDS API operations never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
--db-parameter-group-name
(string)The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn’t result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn’t rebooted automatically, and the parameter changes aren’t applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn’t apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
--backup-retention-period
(integer)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.
Note
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see
ModifyDBCluster
.Default: Uses existing setting
Constraints:
It must be a value from 0 to 35. It can’t be set to 0 if the DB instance is a source to read replicas. It can’t be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
--preferred-backup-window
(string)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.Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see
ModifyDBCluster
.Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
--preferred-maintenance-window
(string)The weekly time range (in UTC) 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 will cause a reboot of the DB instance. If moving 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.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
--multi-az
|--no-multi-az
(boolean)A value that indicates 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.This setting doesn’t apply to RDS Custom.
--engine-version
(string)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.For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see
CreateDBInstance
, or callDescribeDBEngineVersions
.In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.
--allow-major-version-upgrade
|--no-allow-major-version-upgrade
(boolean)A value that indicates 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.
This setting doesn’t apply to RDS Custom.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance’s current version.
--auto-minor-version-upgrade
|--no-auto-minor-version-upgrade
(boolean)A value that indicates 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 automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn’t met, RDS applies the change as soon as possible and doesn’t cause an outage.
For an RDS Custom DB instance, set
AutoMinorVersionUpgrade
tofalse
. Otherwise, the operation returns an error.
--license-model
(string)The license model for the DB instance.
This setting doesn’t apply to RDS Custom.
Valid values:
license-included
|bring-your-own-license
|general-public-license
--iops
(integer)The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn’t result in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
--option-group-name
(string)A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn’t result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren’t interrupted.
The change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.Permanent options, such as the TDE option for Oracle Advanced Security TDE, can’t be removed from an option group, and that option group can’t be removed from a DB instance after it is associated with a DB instance.
This setting doesn’t apply to RDS Custom.
--new-db-instance-identifier
(string)The new DB instance 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 Apply Immediately. This value is stored as a lowercase string.This setting doesn’t apply to RDS Custom.
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:
mydbinstance
--storage-type
(string)Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (
io1
), you must also include a value for theIops
parameter.If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid values:
gp2 | gp3 | io1 | standard
Default:
io1
if theIops
parameter is specified, otherwisegp2
--tde-credential-arn
(string)The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn’t apply to RDS Custom.
--tde-credential-password
(string)The password for the given ARN from the key store in order to access the device.
This setting doesn’t apply to RDS Custom.
--ca-certificate-identifier
(string)Specifies the certificate to associate with the DB instance.
This setting doesn’t apply to RDS Custom.
--domain
(string)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 MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn’t apply to RDS Custom.
--copy-tags-to-snapshot
|--no-copy-tags-to-snapshot
(boolean)A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
ModifyDBCluster
.
--monitoring-interval
(integer)The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
If
MonitoringRoleArn
is specified, setMonitoringInterval
to a value other than 0.This setting doesn’t apply to RDS Custom.
Valid Values:
0, 1, 5, 10, 15, 30, 60
--db-port-number
(integer)The port number on which the database accepts connections.
The value of the
DBPortNumber
parameter must not match any of the port values specified for options in the option group for the DB instance.If you change the
DBPortNumber
value, your database restarts regardless of the value of theApplyImmediately
parameter.This setting doesn’t apply to RDS Custom.
MySQL
Default:
3306
Valid values:
1150-65535
MariaDB
Default:
3306
Valid values:
1150-65535
PostgreSQL
Default:
5432
Valid values:
1150-65535
Type: Integer
Oracle
Default:
1521
Valid values:
1150-65535
SQL Server
Default:
1433
Valid values:
1150-65535
except1234
,1434
,3260
,3343
,3389
,47001
, and49152-49156
.Amazon Aurora
Default:
3306
Valid values:
1150-65535
--publicly-accessible
|--no-publicly-accessible
(boolean)A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
PubliclyAccessible
only applies to DB instances in a VPC. The DB instance must be part of a public subnet andPubliclyAccessible
must be enabled for it to be publicly accessible.Changes to the
PubliclyAccessible
parameter are applied immediately regardless of the value of theApplyImmediately
parameter.
--monitoring-role-arn
(string)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.If
MonitoringInterval
is set to a value other than 0, supply aMonitoringRoleArn
value.This setting doesn’t apply to RDS Custom.
--domain-iam-role-name
(string)The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn’t apply to RDS Custom.
--promotion-tier
(integer)A value that specifies the order 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 .
This setting doesn’t apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
--enable-iam-database-authentication
|--no-enable-iam-database-authentication
(boolean)A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
This setting doesn’t apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
--enable-performance-insights
|--no-enable-performance-insights
(boolean)A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn’t apply to RDS Custom.
--performance-insights-kms-key-id
(string)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 do not 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.This setting doesn’t apply to RDS Custom.
--performance-insights-retention-period
(integer)The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn’t a valid value, RDS issues an error.
This setting doesn’t apply to RDS Custom.
--cloudwatch-logs-export-configuration
(structure)The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the
CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance immediately. Therefore, theApplyImmediately
parameter has no effect.This setting doesn’t apply to RDS Custom.
EnableLogTypes -> (list)
The list of log types to enable.
(string)
DisableLogTypes -> (list)
The list of log types to disable.
(string)
Shorthand Syntax:
EnableLogTypes=string,string,DisableLogTypes=string,stringJSON Syntax:
{ "EnableLogTypes": ["string", ...], "DisableLogTypes": ["string", ...] }
--processor-features
(list)The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn’t apply to RDS Custom.
(structure)
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the
coreCount
feature name for theName
parameter. To specify the number of threads per core, use thethreadsPerCore
feature name for theName
parameter.You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the
DescribeOrderableDBInstanceOptions
action and specifying the instance class for theDBInstanceClass
parameter.In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call
DescribeDBInstances
,ProcessorFeature
returns non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name -> (string)
The name of the processor feature. Valid names are
coreCount
andthreadsPerCore
.Value -> (string)
The value of a processor feature name.
Shorthand Syntax:
Name=string,Value=string ...JSON Syntax:
[ { "Name": "string", "Value": "string" } ... ]
--use-default-processor-features
|--no-use-default-processor-features
(boolean)A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn’t apply to RDS Custom.
--deletion-protection
|--no-deletion-protection
(boolean)A value that indicates 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 .
--max-allocated-storage
(integer)The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
This setting doesn’t apply to RDS Custom.
--certificate-rotation-restart
|--no-certificate-rotation-restart
(boolean)A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Warning
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide .
This setting doesn’t apply to RDS Custom.
--replica-mode
(string)A value that sets the open mode of a replica database to either mounted or read-only.
Note
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn’t use Active Data Guard to transmit information to the mounted replica. Because it doesn’t accept user connections, a mounted replica can’t serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
This setting doesn’t apply to RDS Custom.
Possible values:
open-read-only
mounted
--enable-customer-owned-ip
|--no-enable-customer-owned-ip
(boolean)A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
--aws-backup-recovery-point-arn
(string)The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn’t apply to RDS Custom.
--automation-mode
(string)The automation mode of the RDS Custom DB instance:
full
orall paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set byResumeFullAutomationModeMinutes
.Possible values:
full
all-paused
--resume-full-automation-mode-minutes
(integer)The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is
60
(default). The maximum value is1,440
.
--network-type
(string)The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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 RDS User Guide.
--storage-throughput
(integer)Specifies the storage throughput value for the DB instance.
This setting applies only to the
gp3
storage type.This setting doesn’t apply to RDS Custom or Amazon Aurora.
--cli-input-json
|--cli-input-yaml
(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by--generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with--cli-input-yaml
.
--generate-cli-skeleton
(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To modify a DB instance
The following
modify-db-instance
example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The--apply-immediately
parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.aws rds modify-db-instance \ --db-instance-identifier database-2 \ --option-group-name test-se-2017 \ --db-parameter-group-name test-sqlserver-se-2017 \ --apply-immediatelyOutput:
{ "DBInstance": { "DBInstanceIdentifier": "database-2", "DBInstanceClass": "db.r4.large", "Engine": "sqlserver-se", "DBInstanceStatus": "available", ...output omitted... "DBParameterGroups": [ { "DBParameterGroupName": "test-sqlserver-se-2017", "ParameterApplyStatus": "applying" } ], "AvailabilityZone": "us-west-2d", ...output omitted... "MultiAZ": true, "EngineVersion": "14.00.3281.6.v1", "AutoMinorVersionUpgrade": false, "ReadReplicaDBInstanceIdentifiers": [], "LicenseModel": "license-included", "OptionGroupMemberships": [ { "OptionGroupName": "test-se-2017", "Status": "pending-apply" } ], "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS", "SecondaryAvailabilityZone": "us-west-2c", "PubliclyAccessible": true, "StorageType": "gp2", ...output omitted... "DeletionProtection": false, "AssociatedRoles": [], "MaxAllocatedStorage": 1000 } }For more information, see Modifying an Amazon RDS DB Instance in the Amazon RDS User Guide.
Output¶
DBInstance -> (structure)
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.DBInstanceIdentifier -> (string)
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass -> (string)
Contains the name of the compute and memory capacity class of the DB instance.
Engine -> (string)
The name of the database engine to be used for this DB instance.
DBInstanceStatus -> (string)
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime -> (timestamp)
The time when a stopped DB instance is restarted automatically.
MasterUsername -> (string)
Contains the master username for the DB instance.
DBName -> (string)
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint -> (structure)
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is
creating
.Address -> (string)
Specifies the DNS address of the DB instance.
Port -> (integer)
Specifies the port that the database engine is listening on.
HostedZoneId -> (string)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage -> (integer)
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime -> (timestamp)
Provides the date and time the DB instance was created.
PreferredBackupWindow -> (string)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.BackupRetentionPeriod -> (integer)
Specifies the number of days for which automatic DB snapshots are retained.
DBSecurityGroups -> (list)
A list of DB security group elements containing
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.(structure)
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
DBSecurityGroupName -> (string)
The name of the DB security group.
Status -> (string)
The status of the DB security group.
VpcSecurityGroups -> (list)
Provides a list of VPC security group elements that the DB instance belongs to.
(structure)
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId -> (string)
The name of the VPC security group.
Status -> (string)
The membership status of the VPC security group.
Currently, the only valid status is
active
.DBParameterGroups -> (list)
Provides the list of DB parameter groups applied to this DB instance.
(structure)
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
DBParameterGroupName -> (string)
The name of the DB parameter group.
ParameterApplyStatus -> (string)
The status of parameter updates.
AvailabilityZone -> (string)
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup -> (structure)
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName -> (string)
The name of the DB subnet group.
DBSubnetGroupDescription -> (string)
Provides the description of the DB subnet group.
VpcId -> (string)
Provides the VpcId of the DB subnet group.
SubnetGroupStatus -> (string)
Provides the status of the DB subnet group.
Subnets -> (list)
Contains a list of
Subnet
elements.(structure)
This data type is used as a response element for the
DescribeDBSubnetGroups
operation.SubnetIdentifier -> (string)
The identifier of the subnet.
SubnetAvailabilityZone -> (structure)
Contains Availability Zone information.
This data type is used as an element in the
OrderableDBInstanceOption
data type.Name -> (string)
The name of the Availability Zone.
SubnetOutpost -> (structure)
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn -> (string)
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus -> (string)
The status of the subnet.
DBSubnetGroupArn -> (string)
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes -> (list)
The network type of the DB subnet group.
Valid values:
IPV4
DUAL
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 RDS User Guide.
(string)
PreferredMaintenanceWindow -> (string)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues -> (structure)
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass -> (string)
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage -> (integer)
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword -> (string)
The master credentials for the DB instance.
Port -> (integer)
The port for the DB instance.
BackupRetentionPeriod -> (integer)
The number of days for which automated backups are retained.
MultiAZ -> (boolean)
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion -> (string)
The database engine version.
LicenseModel -> (string)
The license model for the DB instance.
Valid values:
license-included
|bring-your-own-license
|general-public-license
Iops -> (integer)
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier -> (string)
The database identifier for the DB instance.
StorageType -> (string)
The storage type of the DB instance.
CACertificateIdentifier -> (string)
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName -> (string)
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports -> (structure)
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable -> (list)
Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.
(string)
LogTypesToDisable -> (list)
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
(string)
ProcessorFeatures -> (list)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(structure)
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the
coreCount
feature name for theName
parameter. To specify the number of threads per core, use thethreadsPerCore
feature name for theName
parameter.You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the
DescribeOrderableDBInstanceOptions
action and specifying the instance class for theDBInstanceClass
parameter.In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call
DescribeDBInstances
,ProcessorFeature
returns non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name -> (string)
The name of the processor feature. Valid names are
coreCount
andthreadsPerCore
.Value -> (string)
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled -> (boolean)
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode -> (string)
The automation mode of the RDS Custom DB instance:
full
orall-paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall-paused
, the instance pauses automation for the duration set by--resume-full-automation-mode-minutes
.ResumeFullAutomationModeTime -> (timestamp)
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
StorageThroughput -> (integer)
The storage throughput of the DB instance.
LatestRestorableTime -> (timestamp)
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ -> (boolean)
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn’t apply to RDS Custom.
EngineVersion -> (string)
Indicates the database engine version.
AutoMinorVersionUpgrade -> (boolean)
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier -> (string)
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers -> (list)
Contains one or more identifiers of the read replicas associated with this DB instance.
(string)
ReadReplicaDBClusterIdentifiers -> (list)
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn’t contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string)
ReplicaMode -> (string)
The open mode of an Oracle read replica. The default is
open-read-only
. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .Note
This attribute is only supported in RDS for Oracle.
LicenseModel -> (string)
License model information for this DB instance. This setting doesn’t apply to RDS Custom.
Iops -> (integer)
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships -> (list)
Provides the list of option group memberships for this DB instance.
(structure)
Provides information on the option groups the DB instance is a member of.
OptionGroupName -> (string)
The name of the option group that the instance belongs to.
Status -> (string)
The status of the DB instance’s option group membership. Valid values are:
in-sync
,pending-apply
,pending-removal
,pending-maintenance-apply
,pending-maintenance-removal
,applying
,removing
, andfailed
.CharacterSetName -> (string)
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName -> (string)
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone -> (string)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible -> (boolean)
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos -> (list)
The status of a read replica. If the instance isn’t a read replica, this is blank.
(structure)
Provides a list of status information for a DB instance.
StatusType -> (string)
This value is currently “read replication.”
Normal -> (boolean)
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status -> (string)
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message -> (string)
Details of the error if there is an error for the instance. If the instance isn’t in an error state, this value is blank.
StorageType -> (string)
Specifies the storage type associated with the DB instance.
TdeCredentialArn -> (string)
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort -> (integer)
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier -> (string)
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted -> (boolean)
Specifies whether the DB instance is encrypted.
KmsKeyId -> (string)
If
StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId -> (string)
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier -> (string)
The identifier of the CA certificate for this DB instance.
DomainMemberships -> (list)
The Active Directory Domain membership records associated with the DB instance.
(structure)
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain -> (string)
The identifier of the Active Directory Domain.
Status -> (string)
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN -> (string)
The fully qualified domain name of the Active Directory Domain.
IAMRoleName -> (string)
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot -> (boolean)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
DBCluster
.MonitoringInterval -> (integer)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn -> (string)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn -> (string)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier -> (integer)
A value that specifies the order 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 .
DBInstanceArn -> (string)
The Amazon Resource Name (ARN) for the DB instance.
Timezone -> (string)
The time zone of the DB instance. In most cases, the
Timezone
element is empty.Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.IAMDatabaseAuthenticationEnabled -> (boolean)
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
PerformanceInsightsEnabled -> (boolean)
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId -> (string)
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.
PerformanceInsightsRetentionPeriod -> (integer)
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
EnabledCloudwatchLogsExports -> (list)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
(string)
ProcessorFeatures -> (list)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(structure)
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the
coreCount
feature name for theName
parameter. To specify the number of threads per core, use thethreadsPerCore
feature name for theName
parameter.You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the
DescribeOrderableDBInstanceOptions
action and specifying the instance class for theDBInstanceClass
parameter.In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call
DescribeDBInstances
,ProcessorFeature
returns non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name -> (string)
The name of the processor feature. Valid names are
coreCount
andthreadsPerCore
.Value -> (string)
The value of a processor feature name.
DeletionProtection -> (boolean)
Indicates if the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles -> (list)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(structure)
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName -> (string)
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see
DBEngineVersion
.Status -> (string)
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE
- the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING
- the IAM role ARN is being associated with the DB instance.
INVALID
- the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint -> (structure)
Specifies the listener connection endpoint for SQL Server Always On.
Address -> (string)
Specifies the DNS address of the DB instance.
Port -> (integer)
Specifies the port that the database engine is listening on.
HostedZoneId -> (string)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
MaxAllocatedStorage -> (integer)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList -> (list)
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(structure)
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Key -> (string)
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).Value -> (string)
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).DBInstanceAutomatedBackupsReplications -> (list)
The list of replicated automated backups associated with the DB instance.
(structure)
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn -> (string)
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled -> (boolean)
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn -> (string)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus -> (string)
The status of the database activity stream.
ActivityStreamKmsKeyId -> (string)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName -> (string)
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode -> (string)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded -> (boolean)
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode -> (string)
The automation mode of the RDS Custom DB instance:
full
orall paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set by--resume-full-automation-mode-minutes
.ResumeFullAutomationModeTime -> (timestamp)
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile -> (string)
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget -> (string)
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType -> (string)
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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 RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus -> (string)
The status of the policy state of the activity stream.
StorageThroughput -> (integer)
Specifies the storage throughput for the DB instance.
This setting applies only to the
gp3
storage type.DBSystemId -> (string)
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.