Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance\'s compute resources and storage capacity to meet your application\'s demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

• For the alphabetical list of API actions, see API Actions.

• For the alphabetical list of data types, see Data Types.

• For a list of common query parameters, see Common Parameters.

• For descriptions of the error codes, see Common Errors.

Amazon RDS User Guide

• For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.

• For more information about how to use the Query API, see Using the Query API.

Associates an Identity and Access Management (IAM) role with a DB cluster.

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

This command doesn\'t apply to RDS Custom.

Adds a source identifier to an existing RDS event notification subscription.

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

Applies a pending maintenance action to a resource (for example, to a DB instance).

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can\'t authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can\'t authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn\'t removed.

Copies the specified DB cluster parameter group.

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:

• KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

• TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

• SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Copies the specified DB parameter group.

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.

This command doesn\'t apply to RDS Custom.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

Copies the specified option group.

Creates a blue/green deployment.

A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Creates a custom DB engine version (CEV).

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.

You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you\'ve created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Creates a snapshot of a DB cluster.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Creates a new DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

Amazon Aurora doesn\'t support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster.

All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you\'ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

This command doesn\'t apply to RDS Custom.

Creates a new DB proxy.

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy\'s default VPC.

Creates a new DB security group. DB security groups control access to a DB instance.

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don\'t specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.

For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

Creates a new option group. You can create up to 20 option groups.

This command doesn\'t apply to RDS Custom.

Deletes a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

• The CEV must not be the default for RDS Custom. If it is, change the default before running this command.

• The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.

Typically, deletion takes a few minutes.

For more information, see Deleting a CEV in the Amazon RDS User Guide.

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can\'t be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

If you\'re deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can\'t be associated with any DB clusters.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can\'t be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can\'t be canceled or reverted once submitted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can\'t delete the DB instance if both of the following conditions are true:

• The DB cluster is a read replica of another Amazon Aurora DB cluster.

• The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it\'s no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

Deletes a specified DB parameter group. The DB parameter group to be deleted can\'t be associated with any DB instances.

Deletes an existing DB proxy.

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy\'s default VPC.

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

Deletes a DB subnet group.

Deletes an RDS event notification subscription.

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

Deletes an existing option group.

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota\'s maximum value.

This command doesn\'t take any parameters.

Describes one or more blue/green deployments.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

Returns information about endpoints for an Amazon Aurora DB cluster.

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Returns a list of the available DB engines.

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

Describes provisioned RDS instances. This API supports pagination.

Returns a list of DB log files for the DB instance.

This command doesn\'t apply to RDS Custom.

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

Returns the detailed parameter list for a particular DB parameter group.

Returns information about DB proxies.

Returns information about DB proxy endpoints.

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

Returns information about DBProxyTarget objects. This API supports pagination.

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

Returns information about DB snapshots. This API action supports pagination.

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

Returns the default engine and system parameter information for the specified database engine.

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.

Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

Describes all available options.

Describes the available option groups.

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

Lists available reserved DB instance offerings.

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.

Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.

To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

This command doesn\'t apply to RDS Custom.

Downloads all or a portion of the specified log file, up to 1 MB in size.

This command doesn\'t apply to RDS Custom.

Forces a failover for a DB cluster.

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Initiates the failover process for an Aurora global database (GlobalCluster).

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.

For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn\'t required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.

This operation is supported for RDS for Oracle and Microsoft SQL Server.

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.

You might need to override the default certificate in the following situations:

• You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.

• RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.

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.

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.

For more information, see Modifying CEV status in the Amazon RDS User Guide.

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.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.

If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.

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.

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes the settings for an existing DB proxy.

Changes the settings for an existing DB proxy endpoint.

Modifies the properties of a DBProxyTargetGroup.

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn\'t apply to RDS Custom.

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

Modifies an existing RDS event notification subscription. You can\'t modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Modifies a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

Modifies an existing option group.

Promotes a read replica DB instance to a standalone DB instance.

Promotes a read replica DB cluster to a standalone DB cluster.

Purchases a reserved DB instance offering.

You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.

Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

Use this operation only for a non-Aurora Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

This command doesn\'t apply to RDS Custom.

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

Removes a source identifier from an existing RDS event notification subscription.

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

The target DB cluster is created from the source snapshot with a default configuration. If you don\'t specify a security group, the new DB cluster is associated with the default security group.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source\'s original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn\'t allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.

This command doesn\'t apply to RDS Custom.

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

Enables replication of automated backups to a different Amazon Web Services Region.

This command doesn\'t apply to RDS Custom.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.

You can\'t export snapshot data from RDS Custom DB instances.

You can\'t export cluster data from Multi-AZ DB clusters.

For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.

Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.

For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster\'s metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance\'s metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

Stops automated backup replication for a DB instance.

This command doesn\'t apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Switches over a blue/green deployment.

Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.

Data returned by the DescribeAccountAttributes action.

Describes a quota for an Amazon Web Services account.

The following are account quotas:

• AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.

• AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.

• CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.

• DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.

• DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.

• DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.

• DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.

• DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.

  Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.

• DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.

• DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.

• DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.

• EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.

• ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.

• ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.

• OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.

• ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.

• ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.

• SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.

For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.

A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

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.

The mode of the database activity stream.

Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

The mode of the database activity stream.

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn\'t supported, the return value is an empty list.

The status of the policy state of the activity stream.

The status of the modification to the policy state of the database activity stream.

The status of the database activity stream.

The status of the database activity stream.

The status of the modification to the database activity stream.

The status of the database activity stream.

The status of the database activity stream.

', 'refs' => [], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsToResourceMessage' => [ 'base' => '

', 'refs' => [], ], 'ApplyMethod' => [ 'base' => NULL, 'refs' => [ 'Parameter$ApplyMethod' => '

Indicates when to apply parameter updates.

', 'refs' => [], ], 'ApplyPendingMaintenanceActionResult' => [ 'base' => NULL, 'refs' => [], ], 'AttributeValueList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttribute$AttributeValues' => '

The value(s) for the manual DB cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

The value or values for the manual DB snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

The DB security group authorization quota has been reached.

', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'AutomationMode' => [ 'base' => NULL, 'refs' => [ 'DBInstance$AutomationMode' => '

The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

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.

The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

Contains Availability Zone information.

This data type is used as an element in the OrderableDBInstanceOption data type.

A list of Availability Zones for a DB instance.

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Valid for Cluster Type: Aurora DB clusters only

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Valid for: Aurora DB clusters only

Contains the available processor feature information for the DB instance class of a DB instance.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

A list of the available processor features for the DB instance class of a DB instance.

Valid processor features for your DB instance.

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

This setting doesn\'t apply to RDS Custom DB instances.

', 'refs' => [], ], 'BackupPolicyNotFoundFault' => [ 'base' => NULL, 'refs' => [], ], 'BlueGreenDeployment' => [ 'base' => '

Details about a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

A blue/green deployment with the specified name already exists.

The unique identifier of the blue/green deployment.

The unique identifier of the blue/green deployment to delete. This parameter isn\'t case-sensitive.

Constraints:

• Must match an existing blue/green deployment identifier.

The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn\'t case-sensitive.

Constraints:

• Must match an existing blue/green deployment identifier.

The unique identifier of the blue/green deployment.

Constraints:

• Must match an existing blue/green deployment identifier.

A list of blue/green deployments in the current account and Amazon Web Services Region.

The user-supplied name of the blue/green deployment.

The name of the blue/green deployment.

Constraints:

• Can\'t be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

BlueGreenDeploymentIdentifier doesn\'t refer to an existing blue/green deployment.

The status of the blue/green deployment.

Valid Values:

• PROVISIONING - Resources are being created in the green environment.

• AVAILABLE - Resources are available in the green environment.

• SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.

• SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.

• INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn\'t possible.

• SWITCHOVER_FAILED - Switchover was attempted but failed.

• DELETING - The blue/green deployment is being deleted.

Additional information about the status of the blue/green deployment.

Details about a task for a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Either tasks to be performed or tasks that have been completed on the target database before switchover.

The name of the blue/green deployment task.

The status of the blue/green deployment task.

Valid Values:

• PENDING - The resource is being prepared for deployment.

• IN_PROGRESS - The resource is being deployed.

• COMPLETED - The resource has been deployed.

• FAILED - Deployment of the resource failed.

A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

Indicates whether the DB cluster is encrypted.

Indicates whether minor version patches are applied automatically.

This setting is only for non-Aurora Multi-AZ DB clusters.

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

Specifies whether the DB cluster snapshot is encrypted.

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

Indicates whether the database engine version supports read replicas.

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn\'t apply to RDS Custom DB instances.

Indicates whether minor version patches are applied automatically.

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.

For more information, see CreateDBInstance.

Indicates whether the DB instance is encrypted.

Indicates whether tags are copied from the DB instance to snapshots of the DB instance.

This setting doesn\'t apply to Amazon Aurora DB instances. 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.

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.

For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.

Indicates whether 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.

Specifies whether the automated backup is encrypted.

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.

Specifies whether the DB snapshot is encrypted.

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn\'t specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn\'t specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn\'t create a DB snapshot. If you don\'t enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn\'t enabled, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.

If you delete a read replica or an RDS Custom instance, you must enable this setting.

This setting is required for RDS Custom.

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

This setting doesn\'t apply to RDS Custom.

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

This setting doesn\'t apply to RDS Custom.

Boolean value that if true, indicates there is more data to be downloaded.

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

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

Specifies whether major version upgrades are allowed.

Valid for Cluster Type: Aurora DB clusters only

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.

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.

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.

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.

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.

This setting doesn\'t apply to RDS Custom DB instances.

Constraints:

• Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that\'s a different major version than the DB instance\'s current version.

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

Indicate if this option is persistent.

Indicate if this option is permanent.

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

Specifies whether the option requires a port.

Persistent options can\'t be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

Permanent options can never be removed from an option group. An option group containing a permanent option can\'t be removed from a DB instance.

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

If true, you can only use this option with a DB instance that is in a VPC.

Boolean value where true indicates that this option group option can be changed from the default value.

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

A Boolean value that, when true, indicates the option setting can be modified from the default.

Indicates if the option setting is part of a collection.

True if the version is the default version of the option, and otherwise false.

Indicates whether a DB instance is Multi-AZ capable.

Indicates whether a DB instance can have a read replica.

Indicates whether a DB instance is in a VPC.

Indicates whether a DB instance supports encrypted storage.

Indicates whether a DB instance supports provisioned IOPS.

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

Indicates whether a DB instance supports IAM database authentication.

True if a DB instance supports Performance Insights, otherwise false.

Whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

Whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Indicates whether a DB instance supports storage throughput.

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Indicates if the reservation applies to Multi-AZ deployments.

Indicates if the offering applies to Multi-AZ deployments.

A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can\'t use this parameter if there is a list of parameter names specified for the Parameters parameter.

A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn\'t restored to the latest restorable backup time.

Constraints: Can\'t be specified if RestoreToTime parameter is provided.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn\'t restored from the latest backup time.

Constraints: Can\'t be specified if the RestoreTime parameter is provided.

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

Whether there is an override for the default certificate identifier.

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren\'t copied.

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.

Specifies whether the DB cluster is encrypted.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

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

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service 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 query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

Valid for Cluster Type: Aurora DB clusters only

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

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

Specifies whether the DB cluster 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 cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Valid for Cluster Type: Multi-AZ DB clusters only

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:

• If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

• If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:

• If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

• If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

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

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

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

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:

• Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

Specifies whether the DB instance is a Multi-AZ deployment. You can\'t set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

This setting doesn\'t apply to the following DB instances:

• Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)

• RDS Custom

Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.

Specifies whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:

• If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.

• If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:

• If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.

• If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.

Specifes whether the DB instance is encrypted. By default, it isn\'t encrypted.

For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.

This setting doesn\'t apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.

Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

This setting doesn\'t apply to Amazon Aurora DB instances. 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.

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 for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn\'t apply to the following DB instances:

• Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)

• RDS Custom

Specifies 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 DB instances.

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.

This setting doesn\'t apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

Specifies 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.

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

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

• Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

A value that indicates whether the read replica is in a Multi-AZ deployment.

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.

This setting doesn\'t apply to RDS Custom.

A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

This setting doesn\'t apply to RDS Custom.

Default: Inherits from the source DB instance

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.

For more information, see CreateDBInstance.

A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.

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.

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.

A value that indicates whether to enable Performance Insights for the read replica.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

This setting doesn\'t apply to RDS Custom.

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.

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.

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.

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 read replica 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.

A value that indicates whether to activate the subscription. If the event notification subscription isn\'t activated, the subscription is created but not active.

Specifies whether to enable deletion protection for the new global database cluster. The global database can\'t be deleted when deletion protection is enabled.

Specifies whether to enable storage encryption for the new global database cluster.

Constraints:

• Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

Indicates whether the DB cluster has instances in multiple Availability Zones.

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Indicates whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled.

Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service 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 query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

Indicates whether the DB cluster 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 cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

For more information, see CreateDBCluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

Indicates whether Performance Insights is enabled for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

Indicates whether Performance Insights is enabled for the DB instance.

Indicates 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.

Indicates whether engine-native audit fields are included in the database activity stream.

Specifies whether to delete the resources in the green environment. You can\'t specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn\'t case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

A value that indicates whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.

A value that indicates whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.

A value that indicates whether to include engine versions that aren\'t available in the list. The default is to list only available engine versions.

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

A value that indicates whether to show only those reservations that support Multi-AZ.

A value that indicates whether to show only those reservations that support Multi-AZ.

The storage encryption setting for the global database cluster.

The deletion protection setting for the new global database cluster.

Indicates whether engine-native audit fields are included in the database activity stream.

A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.

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

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

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service 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 query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

Valid for Cluster Type: Aurora DB clusters only

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

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

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

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

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

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.

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.

This setting doesn\'t apply to RDS Custom DB instances.

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 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, Amazon RDS applies the change as soon as possible and doesn\'t cause an outage.

For an RDS Custom DB instance, don\'t enable this setting. Otherwise, the operation returns an error.

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

This setting doesn\'t apply to Amazon Aurora DB instances. 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.

Specifies 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 and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

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

Specifies 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 DB instances.

Specifies 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 DB instances.

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

This setting doesn\'t apply to RDS Custom DB instances.

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 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.

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 DB instances.

Specifies 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.

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

If the DB instance 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 instance 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, Amazon 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.

Constraints:

• Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

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.

Constraints:

• You must apply the change immediately when rotating the master user password.

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn\'t use TLS.

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

A value that indicates whether to activate the subscription.

Specifies whether to enable deletion protection for the global database cluster. The global database cluster can\'t be deleted when deletion protection is enabled.

Specifies whether to allow major version upgrades.

Constraints: Must be enabled if you specify a value for the EngineVersion parameter that\'s a different major version than the global cluster\'s current version.

If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

Specifies whether the option can be copied across Amazon Web Services accounts.

Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

Whether a DB instance supports Kerberos Authentication.

A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

Constraint: You can\'t enable force failover if the instance isn\'t configured for Multi-AZ.

A value that indicates whether the restored DB cluster is encrypted.

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.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

A value that indicates whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

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.

Constraints:

• Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

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.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

A value that indicates whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

A value that indicates whether the DB cluster 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 is not permitted if the security group assigned to the DB cluster doesn\'t permit it.

When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:

• If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

• If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:

• If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

• If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

A value that indicates whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

A value that indicates whether the DB cluster 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 is not permitted if the security group assigned to the DB cluster doesn\'t permit it.

When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:

• If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

• If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:

• If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

• If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Multi-AZ DB clusters only

A value that indicates whether the DB instance is a Multi-AZ deployment.

This setting doesn\'t apply to RDS Custom.

Constraint: You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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.

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

If you restore an RDS Custom DB instance, you must disable this parameter.

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

In most cases, tags aren\'t copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

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.

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.

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.

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.

This setting doesn\'t apply to RDS Custom.

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.

A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can\'t set the AvailabilityZone parameter.

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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.

A value that indicates whether the new DB instance is encrypted or not.

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.

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.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

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.

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

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.

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

• Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

A value that indicates whether the DB instance is a Multi-AZ deployment.

This setting doesn\'t apply to RDS Custom.

Constraint: You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

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.

For more information, see CreateDBInstance.

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

This setting doesn\'t apply to RDS Custom.

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

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 RDS Custom.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

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.

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.

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.

This setting doesn\'t apply to RDS Custom.

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.

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it\'s idle (it has no connections).

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.

Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.

Indicates whether engine-native audit fields are included in the database activity stream.

Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.

A value that indicates whether you can use Aurora parallel query with the target engine version.

A value that indicates whether you can use Aurora global databases with the target engine version.

A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.

A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

A CA certificate for an Amazon Web Services account.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Returns the details of the DB instance’s server certificate.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

The details of the DB instance\'s server certificate.

The list of Certificate objects for the Amazon Web Services account.

Data returned by the DescribeCertificates action.

CertificateIdentifier doesn\'t refer to an existing certificate.

This data type is used as a response element in the action DescribeDBEngineVersions.

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn\'t specified.

The type of authentication the proxy uses for connections from clients.

The type of authentication the proxy uses for connections from clients.

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

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.

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, the ApplyImmediately parameter has no effect.

This setting doesn\'t apply to RDS Custom DB instances.

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

The settings that determine the size and behavior of the connection pool for the target group.

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

The settings that determine the size and behavior of the connection pool for the target group.

', 'refs' => [], ], 'CopyDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateBlueGreenDeploymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBlueGreenDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCustomDBEngineVersionFault' => [ 'base' => '

An error occurred while trying to create the CEV.

', 'refs' => [], ], 'CreateDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBInstanceReadReplicaMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSecurityGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSecurityGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CustomAvailabilityZoneNotFoundFault' => [ 'base' => '

CustomAvailabilityZoneId doesn\'t refer to an existing custom Availability Zone identifier.

A value that indicates the AMI information.

The EC2 image

A CEV with the specified name already exists.

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.

The following JSON fields are valid:

MediaImportTemplateVersion

Version of the CEV manifest. The date is in the format YYYY-MM-DD.

databaseInstallationFileNames

Ordered list of installation files for the CEV.

opatchFileNames

Ordered list of OPatch installers used for the Oracle DB engine.

psuRuPatchFileNames

The PSU and RU patches for this CEV.

OtherPatchFileNames

The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.

For more information, see Creating the CEV manifest in the Amazon RDS User Guide.

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they\'re listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

The specified CEV was not found.

You have exceeded your CEV quota.

The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

The database engine. The only supported engines are custom-oracle-ee and custom-oracle-ee-cdb.

The DB engine. The only supported values are custom-oracle-ee and custom-oracle-ee-cdb.

The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.

The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

The availability status to be assigned to the CEV. Valid values are as follows:

available

You can use this CEV to create a new RDS Custom DB instance.

inactive

You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can\'t patch or create new instances with this CEV.

You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

The user already has a DB cluster with the given identifier.

This data type is used as a response element in the DescribeDBClusterBacktracks action.

Contains a list of backtracks for the user.

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

BacktrackIdentifier doesn\'t refer to an existing backtrack.

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

• CreateDBClusterEndpoint

• DescribeDBClusterEndpoints

• ModifyDBClusterEndpoint

• DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

The specified custom endpoint can\'t be created because it already exists.

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

The specified custom endpoint doesn\'t exist.

The cluster already has the maximum number of custom endpoints.

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.

Contains a list of DB clusters for the user.

Contains information about an instance that is part of a DB cluster.

The list of DB instances that make up the DB cluster.

Contains the result of a successful invocation of the DescribeDBClusters action.

DBClusterIdentifier doesn\'t refer to an existing DB cluster.

The list of option group memberships for this DB cluster.

Contains status information for a DB cluster option group.

Contains the details of an Amazon RDS DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

A list of DB cluster parameter groups.

', 'refs' => [], ], 'DBClusterParameterGroupNotFoundFault' => [ 'base' => '

DBClusterParameterGroupName doesn\'t refer to an existing DB cluster parameter group.

', 'refs' => [], ], 'DBClusterQuotaExceededFault' => [ 'base' => '

The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

The specified IAM role Amazon Resource Name (ARN) isn\'t associated with the specified DB cluster.

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

The user already has a DB cluster snapshot with the given identifier.

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

The list of attributes and values for the manual DB cluster snapshot.

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

Provides a list of DB cluster snapshots for the user.

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

DBClusterSnapshotIdentifier doesn\'t refer to an existing DB cluster snapshot.

This data type is used as a response element in the action DescribeDBEngineVersions.

A list of DBEngineVersion elements.

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

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, and StopDBInstance.

The user already has a DB instance with the given identifier.

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

A list of DBInstanceAutomatedBackup instances.

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

No automated backup for this DB instance was found.

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

The list of replicated automated backups associated with the DB instance.

The list of replications to different Amazon Web Services Regions associated with the automated backup.

A list of DBInstance instances.

Contains the result of a successful invocation of the DescribeDBInstances action.

DBInstanceIdentifier doesn\'t refer to an existing DB instance.

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

The specified RoleArn or FeatureName value is already associated with the DB instance.

The specified RoleArn value doesn\'t match the specified feature for the DB instance.

You can\'t associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

Provides a list of status information for a DB instance.

The status of a read replica. If the DB instance isn\'t a read replica, the value is blank.

LogFileName doesn\'t refer to an existing DB log file.

Contains the details of an Amazon RDS DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

A DB parameter group with the same name exists.

Contains the result of a successful invocation of the DescribeDBParameters action.

A list of DBParameterGroup instances.

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

DBParameterGroupName doesn\'t refer to an existing DB parameter group.

The request would result in the user exceeding the allowed number of DB parameter groups.

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

The list of DB parameter groups applied to this DB instance.

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

The DBProxy structure corresponding to the new proxy.

The data structure representing the details of the DB proxy that you delete.

The DBProxy object representing the new settings for the proxy.

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy\'s default VPC.

The data structure representing the details of the DB proxy endpoint that you delete.

The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

The list of ProxyEndpoint objects returned by the API operation.

The name of the DB proxy endpoint to create.

The name of the DB proxy endpoint to delete.

The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

The new identifier for the DBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

The DB proxy endpoint doesn\'t exist.

The DB proxy already has the maximum number of endpoints.

The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

A return value representing an arbitrary number of DBProxy data structures.

The name of the DB proxy associated with the DB proxy endpoint that you create.

The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

The specified proxy name doesn\'t correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

This data type is used as a response element in the DescribeDBProxyTargets action.

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

The settings of the modified DBProxyTarget.

The specified target group isn\'t available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

The specified RDS DB instance or Aurora DB cluster isn\'t available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

Contains the details for an Amazon RDS DB security group.

This data type is used as a response element in the DescribeDBSecurityGroups action.

A DB security group with the name specified in DBSecurityGroupName already exists.

This data type is used as a response element in the following actions:

• ModifyDBInstance

• RebootDBInstance

• RestoreDBInstanceFromDBSnapshot

• RestoreDBInstanceToPointInTime

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

If the option requires access to a port, then this DB security group allows access to the port.

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

A list of DB security groups to associate with this DB instance.

This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.

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 DB instances.

Constraints:

• If supplied, must match existing DB security groups.

A list of DBSecurityGroupMembership name strings used for this option.

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

DBSecurityGroupName doesn\'t refer to an existing DB security group.

A DB security group isn\'t allowed for this action.

The request would result in the user exceeding the allowed number of DB security groups.

A list of DBSecurityGroup instances.

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

DBSnapshotIdentifier is already used by an existing snapshot.

Contains the name and values of a manual DB snapshot attribute

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

The list of attributes and values for the manual DB snapshot.

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

A list of DBSnapshot instances.

Contains the result of a successful invocation of the DescribeDBSnapshots action.

DBSnapshotIdentifier doesn\'t refer to an existing DB snapshot.

Contains the details of an Amazon RDS DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

DBSubnetGroupName is already used by an existing DB subnet group.

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

The DBSubnetGroup shouldn\'t be specified while creating read replicas that lie in the same region as the source instance.

DBSubnetGroupName doesn\'t refer to an existing DB subnet group.

The request would result in the user exceeding the allowed number of DB subnet groups.

A list of DBSubnetGroup instances.

The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.

The DB upgrade failed because a resource the DB depends on can\'t be modified.

The source database for the blue/green deployment.

Before switchover, the source database is the production database in the blue environment.

The target database for the blue/green deployment.

Before switchover, the target database is the clone database in the green environment.

The Amazon Resource Name (ARN) of the source production database.

Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.

The Amazon Resource Name (ARN) of a resource in the blue environment.

The Amazon Resource Name (ARN) of a resource in the green environment.

', 'refs' => [], ], 'DeleteDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'base' => '

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

', 'refs' => [], ], 'DeleteDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBProxyEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBProxyEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBSecurityGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeregisterDBProxyTargetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterDBProxyTargetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeBlueGreenDeploymentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBlueGreenDeploymentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCertificatesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterBacktracksMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterEndpointsMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterSnapshotsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClustersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBEngineVersionsMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBInstanceAutomatedBackupsMessage' => [ 'base' => '

Parameter input for DescribeDBInstanceAutomatedBackups.

', 'refs' => [], ], 'DescribeDBLogFilesDetails' => [ 'base' => '

This data type is used as a response element to DescribeDBLogFiles.

The DB log files returned.

', 'refs' => [], ], 'DescribeDBLogFilesResponse' => [ 'base' => '

The response from a call to DescribeDBLogFiles.

', 'refs' => [], ], 'DescribeDBParametersMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBProxiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBProxiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBProxyEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBProxyEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBProxyTargetGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBProxyTargetGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBProxyTargetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBProxyTargetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBSecurityGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSnapshotAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSnapshotAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBSnapshotsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSubnetGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEngineDefaultParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventCategoriesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEventSubscriptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEventsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeExportTasksMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptionGroupOptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeOptionGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribePendingMaintenanceActionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeReservedDBInstancesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeReservedDBInstancesOfferingsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeSourceRegionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeValidDBInstanceModificationsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeValidDBInstanceModificationsResult' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$Description' => '

An optional description of your CEV.

An optional description of your CEV.

An Active Directory Domain membership record associated with the DB instance or cluster.

The Active Directory Domain membership records associated with the DB cluster.

The Active Directory Domain membership records associated with the DB instance.

Domain doesn\'t refer to an existing Active Directory domain.

The minimum value in the range.

The maximum value in the range.

The amount of the recurring charge.

The fixed price charged for this reserved DB instance.

The hourly price charged for this reserved DB instance.

The fixed price charged for this offering.

The hourly price charged for this offering.

Minimum provisioned IOPS per GiB for a DB instance.

Maximum provisioned IOPS per GiB for a DB instance.

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

A range of double values.

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.

This data type is used as a response element to DownloadDBLogFilePortion.

', 'refs' => [], ], 'EC2SecurityGroup' => [ 'base' => '

This data type is used as a response element in the following actions:

• AuthorizeDBSecurityGroupIngress

• DescribeDBSecurityGroups

• RevokeDBSecurityGroupIngress

Contains a list of EC2SecurityGroup elements.

The AMI configuration prerequisite has not been met.

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

• CreateDBInstance

• DescribeDBInstances

• DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

The connection endpoint for the DB instance.

The listener connection endpoint for SQL Server Always On.

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.

A list of the supported DB engine modes.

A list of the supported DB engine modes.

The valid DB engine modes.

A list of the supported DB engine modes for the target engine version.

This data type is used as a response element in the DescribeEvents action.

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

A list of event categories that trigger notifications for a event notification subscription.

Specifies the category for the event.

The event categories for the specified source type

A list of event categories for the RDS event notification subscription.

A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Contains the results of a successful invocation of the DescribeEventCategories operation.

A list of EventCategoriesMap data types.

Data returned from the DescribeEventCategories operation.

A list of Event instances.

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

You have reached the maximum number of event subscriptions.

A list of EventSubscriptions data types.

Data returned by the DescribeEventSubscriptions action.

Contains the result of a successful invocation of the DescribeEvents action.

The type of source for the export.

The type of source for the export.

Contains the details of a snapshot or cluster export to Amazon S3.

This data type is used as a response element in the DescribeExportTasks action.

You can\'t start an export task that\'s already running.

The export task doesn\'t exist.

Information about an export of a snapshot or cluster to Amazon S3.

', 'refs' => [], ], 'FailoverDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'FailoverGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'FailoverGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'FailoverState' => [ 'base' => '

Contains the state of scheduled or in-process failover operations on an Aurora global database (GlobalCluster). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

• pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster\'s primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

• failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

• cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

The following actions can be filtered:

• DescribeDBClusterBacktracks

• DescribeDBClusterEndpoints

• DescribeDBClusters

• DescribeDBInstances

• DescribePendingMaintenanceActions

A filter that specifies one or more blue/green deployments to describe.

Valid Values:

• blue-green-deployment-identifier - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.

• blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.

• source - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.

• target - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.

This parameter isn\'t currently supported.

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

• db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

• db-cluster-backtrack-status - Accepts any of the following backtrack status values:

  • applying

  • completed

  • failed

  • pending

  The results list includes information about only the backtracks identified by these values.

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

A filter that specifies one or more DB clusters to describe.

Supported Filters:

• clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

• db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

A filter that specifies one or more DB engine versions to describe.

Supported filters:

• db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.

• engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.

• engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

• engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.

• status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:

  • available

  • deprecated

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - automated backups for current instances

  • retained - automated backups for deleted instances and after backup replication is stopped

  • creating - automated backups that are waiting for the first automated snapshot to be available

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

A filter that specifies one or more DB instances to describe.

Supported Filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.

• dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter is not currently supported.

This parameter is not currently supported.

This parameter is not currently supported.

This parameter is not currently supported.

This parameter isn\'t currently supported.

A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

• export-task-identifier - An identifier for the snapshot or cluster export task.

• s3-bucket - The Amazon S3 bucket the data is exported to.

• source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

• status - The status of the export task. Must be lowercase. Valid statuses are the following:

  • canceled

  • canceling

  • complete

  • failed

  • in_progress

  • starting

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

This parameter isn\'t currently supported.

One or more filter values. Filter values are case-sensitive.

A data type representing an Aurora global database.

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

Identifier of the Aurora global database (GlobalCluster) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it\'s the name of the Aurora global database that you want to fail over.

Constraints:

• Must match the identifier of an existing GlobalCluster (Aurora global database).

The list of global clusters returned by this request.

A data structure with information about any primary and secondary clusters associated with an Aurora global database.

The list of primary and secondary clusters within the global database cluster.

The GlobalClusterIdentifier doesn\'t refer to an existing global database cluster.

The number of global database clusters for this account is already at the maximum allowed.

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

This data type is used as a response element in the DescribeDBSecurityGroups action.

Contains a list of IPRange elements.

The IAM role requires additional permissions to export to an Amazon S3 bucket.

The IAM role is missing for exporting to an Amazon S3 bucket.

The request would result in the user exceeding the allowed number of DB instances.

The requested operation can\'t be performed because there aren\'t enough available IP addresses in the proxy\'s subnets. Add more CIDR blocks to the VPC or remove IP address that aren\'t required from the subnets.

The DB cluster doesn\'t have enough capacity for the current operation.

The specified DB instance class isn\'t available in the specified Availability Zone.

There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

Specifies the allocated storage size in gibibytes (GiB).

Specifies the port that the DB cluster was listening on at the time of the snapshot.

Specifies the percentage of the estimated data that has been transferred.

The amount of storage in gibibytes (GiB) allocated for the DB instance.

The number of days for which automatic DB snapshots are retained.

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.

Specifies the allocated storage size in gibibytes (GiB).

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

Specifies the allocated storage size in gibibytes (GiB).

Specifies the port that the database engine was listening on at the time of the snapshot.

The percentage of the estimated data that has been transferred.

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

• If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

• If NumberOfLines is specified and Marker isn\'t specified, then the most recent lines from the end of the log file are returned.

• If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

• You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

Specifies the port that the database engine is listening on.

The progress of the snapshot or cluster export task as a percentage.

The total amount of data exported, in gigabytes.

The minimum value in the range.

The maximum value in the range.

The duration of the reservation in seconds.

The number of reserved DB instances.

The duration of the offering in seconds.

The number of days for which automatic DB snapshots are retained.

The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

Constraints: Must be between 1 and 100.

Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn\'t specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

Default: 120

Constraints: between 1 and 3600, or 0 representing unlimited

The number of days for which automated backups are retained.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Default: 1

Constraints:

• Must be a value from 1 to 35.

The port number on which the instances in the DB cluster accept connections.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: 1150-65535

Default:

• RDS for MySQL and Aurora MySQL - 3306

• RDS for PostgreSQL and Aurora PostgreSQL - 5432

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

This setting is required to create a Multi-AZ DB cluster.

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 Provisioned IOPS storage in the Amazon RDS User Guide.

This setting is required to create a Multi-AZ DB cluster.

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.

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

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.

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

This setting doesn\'t apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

Amazon RDS Custom

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

• Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

RDS for MariaDB

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

• Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

• Magnetic storage (standard): Must be an integer from 5 to 3072.

RDS for MySQL

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

• Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

• Magnetic storage (standard): Must be an integer from 5 to 3072.

RDS for Oracle

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

• Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

• Magnetic storage (standard): Must be an integer from 10 to 3072.

RDS for PostgreSQL

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

• Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

• Magnetic storage (standard): Must be an integer from 5 to 3072.

RDS for SQL Server

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3):

  • Enterprise and Standard editions: Must be an integer from 20 to 16384.

  • Web and Express editions: Must be an integer from 20 to 16384.

• Provisioned IOPS storage (io1):

  • Enterprise and Standard editions: Must be an integer from 100 to 16384.

  • Web and Express editions: Must be an integer from 100 to 16384.

• Magnetic storage (standard):

  • Enterprise and Standard editions: Must be an integer from 20 to 1024.

  • Web and Express editions: Must be an integer from 20 to 1024.

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

This setting doesn\'t apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

• Must be a value from 0 to 35.

• Can\'t be set to 0 if the DB instance is a source to read replicas.

• Can\'t be set to 0 for an RDS Custom for Oracle DB instance.

The port number on which the database accepts connections.

This setting doesn\'t apply to Aurora DB instances. The port number is managed by the cluster.

Valid Values: 1150-65535

Default:

• RDS for MariaDB - 3306

• RDS for Microsoft SQL Server - 1433

• RDS for MySQL - 3306

• RDS for Oracle - 1521

• RDS for PostgreSQL - 5432

Constraints:

• For RDS for Microsoft SQL Server, the value can\'t be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.

This setting doesn\'t apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

Constraints:

• For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.

• For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for 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.

If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.

This setting doesn\'t apply to RDS Custom DB instances.

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

Default: 0

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.

This setting doesn\'t apply to RDS Custom DB instances.

Default: 1

Valid Values: 0 - 15

The number of days to retain Performance Insights data.

This setting doesn\'t apply to RDS Custom DB instances.

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 returns an error.

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 the following DB instances:

• Amazon Aurora (Storage is managed by the DB cluster.)

• RDS Custom

The storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

This setting doesn\'t apply to RDS Custom.

Valid Values: 0, 1, 5, 10, 15, 30, 60

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.

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.

Specifies the storage throughput value for the read replica.

This setting doesn\'t apply to RDS Custom or Amazon Aurora.

The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.

The number of days for which automatic DB snapshots are retained.

The port that the database engine is listening on.

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

The number of days to retain Performance Insights data.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

A value that specifies the capacity that the DB cluster scales to next.

The current capacity of the DB cluster.

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

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.

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for 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.

The number of days to retain Performance Insights data.

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

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

The storage throughput for the DB instance.

This setting applies only to the gp3 storage type.

The IOPS (I/O operations per second) value for the automated backup.

The retention period for the automated backups.

Specifies the storage throughput for the automated backup.

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Specifies the storage throughput for the DB snapshot.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The number of minutes to retrieve events for.

Default: 60

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 10000.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The DB cluster capacity.

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

Constraints:

• For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

• For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

Specify a value between 10 and 600 seconds.

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.

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.

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

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.

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

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.

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

For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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.

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.

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.

This setting doesn\'t apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

• Must be a value from 0 to 35.

• Can\'t be set to 0 if the DB instance is a source to read replicas.

• Can\'t be set to 0 for an RDS Custom for Oracle DB instance.

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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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

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.

If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.

This setting doesn\'t apply to RDS Custom DB instances.

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

Default: 0

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 the ApplyImmediately parameter.

This setting doesn\'t apply to RDS Custom DB instances.

Valid Values: 1150-65535

Default:

• Amazon Aurora - 3306

• RDS for MariaDB - 3306

• RDS for Microsoft SQL Server - 1433

• RDS for MySQL - 3306

• RDS for Oracle - 1521

• RDS for PostgreSQL - 5432

Constraints:

• For RDS for Microsoft SQL Server, the value can\'t be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.

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.

This setting doesn\'t apply to RDS Custom DB instances.

Default: 1

Valid Values: 0 - 15

The number of days to retain Performance Insights data.

This setting doesn\'t apply to RDS Custom DB instances.

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 returns an error.

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 DB instances.

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

Default: 60

Constraints:

• Must be at least 60.

• Must be no more than 1,440.

The storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

If required, the port configured for this option to use.

The optional port for the option.

If the option requires a port, specifies the default port for the option.

Minimum storage size for a DB instance.

Maximum storage size for a DB instance.

Minimum total provisioned IOPS for a DB instance.

Maximum total provisioned IOPS for a DB instance.

Minimum storage throughput for a DB instance.

Maximum storage throughput for a DB instance.

The allocated storage size for the DB instance specified in gibibytes (GiB).

The port for the DB instance.

The number of days for which automated backups are retained.

The Provisioned IOPS value for the DB instance.

The storage throughput of the DB instance.

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 35.

• Can\'t be set to 0 if the DB instance is a source to read replicas.

The number of instances to reserve.

Default: 1

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn\'t a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Multi-AZ DB clusters only

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn\'t specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

Specifies the storage throughput value for the DB instance.

This setting doesn\'t apply to RDS Custom or Amazon Aurora.

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Default: 0

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.

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.

Specifies the storage throughput value for the DB instance.

This setting doesn\'t apply to RDS Custom or Amazon Aurora.

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine isn\'t supported.

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.

Specifies the storage throughput value for the DB instance.

This setting doesn\'t apply to RDS Custom or Amazon Aurora.

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The maximum capacity must be greater than or equal to the minimum capacity.

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Specify a value between 300 and 86,400 seconds.

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

Specify a value between 60 and 600 seconds.

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it\'s idle (it has no connections).

The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

The retention period for the replicated automated backups.

The blue/green deployment can\'t be switched over or deleted because there is an invalid configuration in the green environment.

You can\'t delete the CEV.

Capacity isn\'t a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The requested operation can\'t be performed on the endpoint while the endpoint is in this state.

The supplied value isn\'t a valid DB cluster snapshot state.

The requested operation can\'t be performed while the cluster is in this state.

The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.

The DB instance isn\'t in a valid state.

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can\'t delete it when the parameter group is in this state.

You can\'t perform this operation while the DB proxy endpoint is in a particular state.

The requested operation can\'t be performed while the proxy is in this state.

The state of the DB security group doesn\'t allow deletion.

The state of the DB snapshot doesn\'t allow deletion.

The DBSubnetGroup doesn\'t belong to the same VPC as that of an existing cross-region read replica of the same source instance.

The DB subnet group cannot be deleted because it\'s in use.

The DB subnet isn\'t in the available state.

This error can occur if someone else is modifying a subscription. You should retry the action.

The export is invalid for exporting to an Amazon S3 bucket.

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

You can\'t cancel an export task that has completed.

The global cluster is in an invalid state and can\'t perform the requested operation.

The option group isn\'t in the available state.

Cannot restore from VPC backup to non-VPC DB instance.

The specified Amazon S3 bucket name can\'t be found or Amazon RDS isn\'t authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

The DB subnet group doesn\'t cover all Availability Zones after it\'s created because of users\' change.

An error occurred accessing an Amazon Web Services KMS key.

The tag key (name) of the tag to be removed.

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don\'t already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

', 'refs' => [], ], 'LogTypeList' => [ 'base' => NULL, 'refs' => [ 'CloudwatchLogsExportConfiguration$EnableLogTypes' => '

The list of log types to enable.

The list of log types to disable.

The list of log types that need to be enabled for exporting to CloudWatch Logs.

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.

The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

This setting doesn\'t apply to the following DB instances:

• Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)

• RDS Custom

The following values are valid for each DB engine:

• RDS for MariaDB - audit | error | general | slowquery

• RDS for Microsoft SQL Server - agent | error

• RDS for MySQL - audit | error | general | slowquery

• RDS for Oracle - alert | audit | listener | trace | oemagent

• RDS for PostgreSQL - postgresql | upgrade

The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

This setting doesn\'t apply to RDS Custom.

A list of log types that this DB cluster 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 Aurora User Guide.

The types of logs that the database engine has available for export to CloudWatch Logs.

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 Monitoring Amazon RDS log files in the Amazon RDS User Guide.

Log types that are in the process of being deactivated. After they are deactivated, these log types aren\'t exported to CloudWatch Logs.

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

This setting doesn\'t apply to RDS Custom.

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

This setting doesn\'t apply to RDS Custom.

The amount currently used toward the quota maximum.

The maximum allowed value for the quota.

A POSIX timestamp when the last log entry was written.

The size, in bytes, of the log file for the specified DB instance.

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

Filters the available log files for files larger than the specified size.

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).

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

The number of change records stored for Backtrack.

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).

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora DB clusters only

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user 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.

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user 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.

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints:

• Must be a minimum of 20.

• Can\'t exceed 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

The minimum DB engine version required for each corresponding allowed value for an option setting.

The minimum DB engine version required for the corresponding allowed value for this option setting.

', 'refs' => [], ], 'ModifyDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBProxyEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyTargetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyTargetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotAttributeMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'NetworkTypeNotSupported' => [ 'base' => '

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

Option details.

A list of all available options

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

', 'refs' => [ 'CopyOptionGroupResult$OptionGroup' => NULL, 'CreateOptionGroupResult$OptionGroup' => NULL, 'ModifyOptionGroupResult$OptionGroup' => NULL, 'OptionGroupsList$member' => NULL, ], ], 'OptionGroupAlreadyExistsFault' => [ 'base' => '

The option group you are trying to create already exists.

Provides information on the option groups the DB instance is a member of.

The list of option group memberships for this DB instance.

The specified option group could not be found.

Available option.

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

The option settings that are available (and the default value) for each option in an option group.

The versions that are available for the option.

List of available option group options.

', 'refs' => [], ], 'OptionGroupQuotaExceededFault' => [ 'base' => '

The quota of 20 option groups was exceeded for this Amazon Web Services account.

List of option groups.

List of option groups.

Options in this list are removed from the option group.

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

The option settings for this option.

The option settings to include in an option group.

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

The options that conflict with this option.

The options that are prerequisites for this option.

Indicates what options are available in the option group.

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

A data type that represents an Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

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.

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

Provides a list of parameters for the DB cluster parameter group.

A list of Parameter values.

Contains a list of engine default parameters.

A list of parameters in the DB cluster parameter group to modify.

Valid Values (for the application method): immediate | pending-reboot

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.

For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.

A list of parameter names in the DB cluster parameter group to reset to the default values. You can\'t use this parameter if the ResetAllParameters parameter is enabled.

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

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.

Provides information about a pending maintenance action for a resource.

A list that provides details about the pending maintenance actions for the resource.

A list of the pending maintenance actions for the resource.

Data returned from the DescribePendingMaintenanceActions action.

This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name 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 the DBInstanceClass 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.

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 Amazon Aurora or RDS Custom DB instances.

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.

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

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

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 DB instances.

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

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.

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

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.

', 'refs' => [], ], 'PromoteReadReplicaDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'PromoteReadReplicaMessage' => [ 'base' => '

', 'refs' => [], ], 'PromoteReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'base' => '

Provisioned IOPS not available in the specified Availability Zone.

', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'base' => NULL, 'refs' => [], ], 'Range' => [ 'base' => '

A range of integer values.

The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.

The valid range of provisioned IOPS. For example, 1000-256,000.

The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).

The 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.

The identifiers of the read replicas associated with this DB instance.

Contains one or more identifiers of the read replicas associated with this DB cluster.

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

', 'refs' => [], ], 'RebootDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RecurringCharge' => [ 'base' => '

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

The recurring price charged to run this reserved DB instance.

The recurring price charged to run this reserved DB instance.

', 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceMessage' => [ 'base' => '

', 'refs' => [], ], 'ReplicaMode' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceReadReplicaMessage$ReplicaMode' => '

The open mode of the replica database: mounted or read-only.

Mounted DB replicas are included in Oracle Database 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.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

For RDS Custom, you must specify this parameter and set it to mounted. The value won\'t be set by default. After replica creation, you can manage the open mode manually.

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.

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

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 DB instances.

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

User already has a reservation with the given identifier.

A list of reserved DB instances.

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

The specified reserved DB Instance not found.

Request would exceed the user\'s DB Instance quota.

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

A list of reserved DB instance offerings.

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

Specified offering does not exist.

', 'refs' => [], ], 'ResetDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ResourceNotFoundFault' => [ 'base' => '

The specified resource ID was not found.

Describes the pending maintenance actions for a resource.

', 'refs' => [], ], 'RestoreDBClusterFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBClusterToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreWindow' => [ 'base' => '

Earliest and latest time an instance can be restored to:

Earliest and latest time an instance can be restored to.

', 'refs' => [], ], 'RevokeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'SNSInvalidTopicFault' => [ 'base' => '

SNS has responded that there is a problem with the SNS topic specified.

You do not have permission to publish to the SNS topic ARN.

The SNS topic ARN does not exist.

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for Cluster Type: Aurora DB clusters only

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

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

The scaling configuration for an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

The request would result in the user exceeding the allowed number of DB snapshots.

The source DB cluster isn\'t supported for a blue/green deployment.

The source DB instance isn\'t supported for a blue/green deployment.

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can\'t end with a hyphen or contain two consecutive hyphens.

Constraints:

• If SourceIds are supplied, SourceType must also be provided.

• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

• If the source type is an RDS Proxy, a DBProxyName value must be supplied.

A list of source IDs for the RDS event notification subscription.

The requested source could not be found.

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.

Contains the result of a successful invocation of the DescribeSourceRegions action.

The event source to retrieve events for. If no value is specified, all events are returned.

Specifies the source type for this event.

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

The aurora-iopt1 storage type isn\'t available, because you modified the DB cluster to use this storage type less than one month ago.

The specified StorageType can\'t be associated with the DB instance.

The name of the Amazon RDS quota for this Amazon Web Services account.

The name of the DB cluster to associate the IAM role with.

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

The name of the DB instance to associate the IAM role with.

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

The name of the RDS event notification subscription you want to add a source identifier to.

The identifier of the event source to be added.

Constraints:

• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

• If the source type is an RDS Proxy, a DBProxyName value must be supplied.

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can\'t be undone.

Valid values:

• immediate - Apply the maintenance action immediately.

• next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

• undo-opt-in - Cancel any existing next-maintenance opt-in requests.

The name of the DB security group to add authorization to.

The IP range to authorize.

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn\'t an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

The name of the Availability Zone.

The name of the processor feature. Valid names are coreCount and threadsPerCore.

The default value for the processor feature of the DB instance class.

The allowed values for the processor feature of the DB instance class.

The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

The identifier of the snapshot or cluster export task to cancel.

The unique key that identifies a certificate.

The type of the certificate.

The thumbprint of the certificate.

The Amazon Resource Name (ARN) for the certificate.

The CA identifier of the CA certificate used for the DB instance\'s server certificate.

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

The name of the character set.

The description of the character set.

The DBClusterIdentifier value for the DB cluster.

The master credentials for the DB cluster.

The database engine version.

The storage type for the DB cluster.

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

Default: no initialization query

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

Constraints:

• Must specify a valid DB cluster parameter group.

The identifier for the copied DB cluster parameter group.

Constraints:

• Can\'t be null, empty, or blank

• Must contain from 1 to 255 letters, numbers, or hyphens

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster-param-group1

A description for the copied DB cluster parameter group.

The identifier of the DB cluster snapshot to copy. This parameter isn\'t case-sensitive.

You can\'t copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

• Must specify a valid system snapshot in the "available" state.

• If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

• If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn\'t case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don\'t specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don\'t specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It\'s ignored in other Amazon Web Services Regions.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

• KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

• DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

• SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

• Must specify a valid DB parameter group.

The identifier for the copied DB parameter group.

Constraints:

• Can\'t be null, empty, or blank

• Must contain from 1 to 255 letters, numbers, or hyphens

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-db-parameter-group

A description for the copied DB parameter group.

The identifier for the source DB snapshot.

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

Constraints:

• Must specify a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

The identifier for the copy of the snapshot.

Constraints:

• Can\'t be null, empty, or blank

• Must contain from 1 to 255 letters, numbers, or hyphens

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don\'t specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It\'s ignored in other Amazon Web Services Regions.

You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don\'t specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

• DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL.

  For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

• KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

• SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.

The external custom Availability Zone (CAZ) identifier for the target CAZ.

Example: rds-caz-aiqhTgQv.

The identifier for the source option group.

Constraints:

• Must specify a valid option group.

The identifier for the copied option group.

Constraints:

• Can\'t be null, empty, or blank

• Must contain from 1 to 255 letters, numbers, or hyphens

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-option-group

The description for the copied option group.

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

The type of the endpoint, one of: READER, WRITER, ANY.

The name of the character set (CharacterSet) to associate the DB cluster with.

Valid for Cluster Type: Aurora DB clusters only

The name for your database of up to 64 alphanumeric characters. If you don\'t provide a name, Amazon RDS doesn\'t create a database in the DB cluster you are creating.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

The identifier for this DB cluster. This parameter 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.

• First character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

The name of the DB cluster parameter group to associate with this DB cluster. If you don\'t specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

• If supplied, must match the name of an existing DB cluster parameter group.

A DB subnet group to associate with this DB cluster.

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

• Must match the name of an existing DB subnet group.

• Must not be default.

Example: mydbsubnetgroup

The database engine to use for this DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres

The version number of the database engine to use.

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.

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"

For information about a specific engine, see the following topics:

• Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.

• Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

• RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.

• RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

The name of the master user for the DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

• Must be 1 to 16 letters or numbers.

• First character must be a letter.

• Can\'t be a reserved word for the chosen database engine.

The 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.

The option group to associate the DB cluster with.

DB clusters are associated with a default option group that can\'t be modified.

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

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. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

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.

The weekly time range during which system maintenance can occur.

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.

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

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.

When a KMS key isn\'t specified in KmsKeyId:

• If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.

• If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn\'t specified, 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.

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.

The presigned URL request must contain the following parameter values:

• KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

• DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.

• ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

Valid for Cluster Type: Aurora DB clusters only

The DB engine mode of the DB cluster, either provisioned or serverless.

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:

• Limitations of Aurora Serverless v1

• Requirements for Aurora Serverless v2

Valid for Cluster Type: Aurora DB clusters only

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Valid for Cluster Type: Aurora DB clusters only

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

For more information, see Kerberos authentication in the Amazon Aurora User Guide.

Valid for Cluster Type: Aurora DB clusters only

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

Valid for Cluster Type: Aurora DB clusters only

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.

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

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.

This setting is required to create a Multi-AZ DB cluster.

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

Default:

• Aurora DB clusters - aurora

• Multi-AZ DB clusters - io1

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 Setting up and enabling 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

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

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

Reserved for future use.

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 the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

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.

If you 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.

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

The name of the DB cluster parameter group.

Constraints:

• Must not match the name of an existing DB cluster parameter group.

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Aurora MySQL

Example: aurora-mysql5.7, aurora-mysql8.0

Aurora PostgreSQL

Example: aurora-postgresql14

RDS for MySQL

Example: mysql8.0

RDS for PostgreSQL

Example: postgres12

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• mysql

• postgres

The description for the DB cluster parameter group.

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1-snapshot1

The identifier of the DB cluster to create a snapshot for. This parameter isn\'t case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Example: my-cluster1

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn\'t specified, no database is created in the DB instance.

Constraints:

• Must contain 1 to 64 letters or numbers.

• Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

• Can\'t be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn\'t specified, no database is created in the DB instance.

Constraints:

• Must contain 1 to 64 letters or numbers.

• Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

• Can\'t be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn\'t specified, a database named postgres is created in the DB instance.

Constraints:

• Must contain 1 to 63 letters, numbers, or underscores.

• Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

• Can\'t be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you don\'t specify a value, the default value is ORCL. You can\'t specify the string null, or any other reserved word, for DBName.

Default: ORCL

Constraints:

• Can\'t be longer than 8 characters

Amazon RDS Custom for Oracle

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don\'t specify a value, the default value is ORCL for non-CDBs and RDSCDB for CDBs.

Default: ORCL

Constraints:

• It must contain 1 to 8 alphanumeric characters.

• It must contain a letter.

• It can\'t be a word reserved by the database engine.

Amazon RDS Custom for SQL Server

Not applicable. Must be null.

SQL Server

Not applicable. Must be null.

Amazon Aurora MySQL

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn\'t specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.

Constraints:

• It must contain 1 to 64 alphanumeric characters.

• It can\'t be a word reserved by the database engine.

Amazon Aurora PostgreSQL

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn\'t specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.

Constraints:

• It must contain 1 to 63 alphanumeric characters.

• It must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).

• It can\'t be a word reserved by the database engine.

The identifier for this DB instance. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

The compute and memory capacity of the DB instance, for example db.m5.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.

The database engine to use for this DB instance.

Not every database engine is available in every Amazon Web Services Region.

Valid Values:

• aurora-mysql (for Aurora MySQL DB instances)

• aurora-postgresql (for Aurora PostgreSQL DB instances)

• custom-oracle-ee (for RDS Custom for Oracle DB instances)

• custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)

• custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)

• custom-sqlserver-se (for RDS Custom for SQL Server DB instances)

• custom-sqlserver-web (for RDS Custom for SQL Server DB instances)

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

The name for the master user.

This setting doesn\'t apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.

This setting is required for RDS DB instances.

Constraints:

• Must be 1 to 16 letters, numbers, or underscores.

• First character must be a letter.

• Can\'t be a reserved word for the chosen database engine.

The password for the master user.

This setting doesn\'t apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.

Constraints:

• Can\'t be specified if ManageMasterUserPassword is turned on.

• Can include any printable ASCII character except "/", """, or "@".

Length Constraints:

• RDS for MariaDB - Must contain from 8 to 41 characters.

• RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

• RDS for MySQL - Must contain from 8 to 41 characters.

• RDS for Oracle - Must contain from 8 to 30 characters.

• RDS for PostgreSQL - Must contain from 8 to 128 characters.

The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don\'t specify one.

Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.

Constraints:

• The AvailabilityZone parameter can\'t be specified if the DB instance is a Multi-AZ deployment.

• The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

Example: us-east-1d

A DB subnet group to associate with this DB instance.

Constraints:

• Must match the name of an existing DB subnet group.

• Must not be default.

Example: mydbsubnetgroup

The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

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.

Constraints:

• Must be in the format ddd:hh24:mi-ddd:hh24:mi.

• The day values must be mon | tue | wed | thu | fri | sat | sun.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred backup window.

• Must be at least 30 minutes.

The name of the DB parameter group to associate with this DB instance. If you don\'t specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.

This setting doesn\'t apply to RDS Custom DB instances.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• The first character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

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. For more information, see Backup window in the Amazon RDS User Guide.

This setting doesn\'t apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.

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.

The version number of the database engine to use.

This setting doesn\'t apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.

For a list of valid engine versions, use the DescribeDBEngineVersions operation.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

Amazon RDS Custom for Oracle

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

Amazon RDS Custom for SQL Server

See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.

RDS for MariaDB

For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide.

RDS for Microsoft SQL Server

For information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide.

RDS for MySQL

For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide.

RDS for Oracle

For information, see Oracle Database Engine release notes in the Amazon RDS User Guide.

RDS for PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

The license model information for this DB instance.

This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.

Valid Values:

• RDS for MariaDB - general-public-license

• RDS for Microsoft SQL Server - license-included

• RDS for MySQL - general-public-license

• RDS for Oracle - bring-your-own-license | license-included

• RDS for PostgreSQL - postgresql-license

The option group to associate the DB instance with.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group. Also, 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 Amazon Aurora or RDS Custom DB instances.

For supported engines, the character set (CharacterSet) to associate the DB instance with.

This setting doesn\'t apply to the following DB instances:

• Amazon Aurora - The character set is managed by the DB cluster. For more information, see CreateDBCluster.

• RDS Custom - However, if you need to change the character set, you can change it on the database itself.

The name of the NCHAR character set for the Oracle DB instance.

This setting doesn\'t apply to RDS Custom DB instances.

The identifier of the DB cluster that this DB instance will belong to.

This setting doesn\'t apply to RDS Custom DB instances.

The storage type to associate with the DB instance.

If you specify io1 or gp3, you must also include a value for the Iops parameter.

This setting doesn\'t apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

Valid Values: gp2 | gp3 | io1 | standard

Default: io1, if the Iops parameter is specified. Otherwise, gp2.

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

This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.

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

This setting doesn\'t apply to RDS Custom DB instances.

The Amazon Web Services KMS key identifier for an 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. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

This setting doesn\'t apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, 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.

For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn\'t use the default key when this parameter is empty. You must explicitly specify a key.

The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

This setting doesn\'t apply to the following DB instances:

• Amazon Aurora (The domain is managed by the DB cluster.)

• RDS Custom

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

Constraints:

• Can\'t be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

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

Constraints:

• Must be in the distinguished name format.

• Can\'t be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

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

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

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 Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

This setting doesn\'t apply to RDS Custom DB instances.

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

This setting doesn\'t apply to the following DB instances:

• Amazon Aurora (The domain is managed by the DB cluster.)

• RDS Custom

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

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.

This setting doesn\'t apply to RDS Custom DB instances.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

This setting is required for RDS Custom.

Constraints:

• 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.

The location for storing automated backups and manual snapshots.

Valie Values:

• outposts (Amazon Web Services Outposts)

• region (Amazon Web Services Region)

Default: region

For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB instance. 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.

Valid Values: IPV4 | DUAL

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 the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

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.

If you 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.

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.

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

This setting doesn\'t apply to RDS Custom DB instances.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don\'t specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.

Constraints:

• Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

• Can\'t be specified if the SourceDBClusterIdentifier parameter is also specified.

• For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.

• For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.

• The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

• If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

• If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn\'t apply to SQL Server or RDS Custom, which don\'t support cross-Region replicas.

The compute and memory capacity of the read replica, 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.

Default: Inherits from the source DB instance.

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.

Example: us-east-1d

The option group the DB instance is associated with. If omitted, the option group associated with the source instance or cluster is used.

This setting doesn\'t apply to RDS Custom.

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn\'t supported for RDS Custom.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn\'t created in a VPC.

Constraints:

• If supplied, must match the name of an existing DBSubnetGroup.

• The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

• All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

  • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

  • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mydbsubnetgroup

Specifies the storage type to be associated with the read replica.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

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, go to 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, then you must supply a MonitoringRoleArn value.

This setting doesn\'t apply to RDS Custom.

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don\'t specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

You can\'t create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.

This setting doesn\'t apply to RDS Custom, which uses the same KMS key as the primary replica.

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It\'s ignored in other Amazon Web Services Regions.

This setting applies only when replicating from a source DB instance. Source DB clusters aren\'t supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don\'t specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

• DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.

  For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

• KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

• SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

This setting doesn\'t apply to RDS Custom.

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.

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created 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.

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

This setting doesn\'t apply to RDS Custom.

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

Constraints:

• Can\'t be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

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

Constraints:

• Must be in the distinguished name format.

• Can\'t be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

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

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

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.

This setting is required for RDS Custom.

The network type of the DB instance.

Valid values:

• IPV4

• DUAL

The network type is determined by the DBSubnetGroup specified for read replica. 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.

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

Constraints:

• Must be the identifier of an existing Multi-AZ DB cluster.

• Can\'t be specified if the SourceDBInstanceIdentifier parameter is also specified.

• The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.

• The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn\'t supported.

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

The description for the DB parameter group.

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

The name for the DB security group. This value is stored as a lowercase string.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

• Must not be "Default"

Example: mysecuritygroup

The description for the DB security group.

The identifier for the DB snapshot.

Constraints:

• Can\'t be null, empty, or blank

• Must contain from 1 to 255 letters, numbers, or hyphens

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

The identifier of the DB instance that you want to create the snapshot of.

Constraints:

• Must match the identifier of an existing DBInstance.

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints:

• Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

• Must not be default.

• First character must be a letter.

Example: mydbsubnetgroup

The description for the DB subnet group.

The name of the subscription.

Constraints: The name must be less than 255 characters.

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn\'t specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

If you provide a value for this parameter, don\'t specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

• DatabaseName

• Engine

• EngineVersion

• StorageEncrypted

The database engine to use for this global database cluster.

Valid Values: aurora-mysql | aurora-postgresql

Constraints:

• Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

The engine version to use for this global database cluster.

Constraints:

• Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

The name for your database of up to 64 alphanumeric characters. If you don\'t specify a name, Amazon Aurora doesn\'t create a database in the global database cluster.

Constraints:

• Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.

Specifies the name of the option group to be created.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup

Specifies the name of the engine that this option group should be associated with.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Specifies the major version of the engine that this option group should be associated with.

The description of the option group.

A value that indicates the ID of the AMI.

A value that indicates the status of a custom engine version (CEV).

If present, specifies the name of the character set that this cluster is associated with.

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

The name of the DB cluster parameter group for the DB cluster.

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

The current state of this DB cluster.

The progress of the operation as a percentage.

The connection endpoint for the primary instance of the DB cluster.

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

The database engine used for this DB cluster.

The version of the database engine.

The master username for the DB cluster.

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

The identifier of the source DB cluster if this DB cluster is a read replica.

The ID that Amazon Route 53 assigns when you create a hosted zone.

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

The Amazon Resource Name (ARN) for the DB cluster.

The ID of the clone group with which the DB cluster is associated.

The DB engine mode of the DB cluster, either provisioned or serverless.

For more information, see CreateDBCluster.

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.

The name of the Amazon Kinesis data stream used for the database activity stream.

The name of the compute and memory capacity class of the DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

The storage type associated with the DB cluster.

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

This setting is only for non-Aurora Multi-AZ DB clusters.

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.

This setting is only for non-Aurora Multi-AZ DB clusters.

The network type of the DB instance.

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.

This setting is only for Aurora DB clusters.

Valid Values: IPV4 | DUAL

Reserved for future use.

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

Contains the backtrack identifier.

The status of the backtrack. This property returns one of the following values:

• applying - The backtrack is currently being applied to or rolled back from the DB cluster.

• completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

• failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

• pending - The backtrack is currently pending application to or rollback from the DB cluster.

A pagination token that can be used in a later DescribeDBClusterBacktracks request.

A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

The DNS address of the endpoint.

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can\'t be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

The type of the endpoint. One of: READER, WRITER, CUSTOM.

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

The Amazon Resource Name (ARN) for the endpoint.

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Specifies the instance identifier for this member of the DB cluster.

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

A pagination token that can be used in a later DescribeDBClusters request.

Specifies the name of the DB cluster option group.

Specifies the status of the DB cluster option group.

The name of the DB cluster parameter group.

The name of the DB parameter group family that this DB cluster parameter group is compatible with.

Provides the customer-specified description for this DB cluster parameter group.

The Amazon Resource Name (ARN) for the DB cluster parameter group.

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the DB cluster parameter group.

Constraints:

• Must be 1 to 255 letters or numbers.

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

• ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.

• PENDING - the IAM role ARN is being associated with the DB cluster.

• INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.

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.

Specifies the identifier for the DB cluster snapshot.

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

Specifies the name of the database engine for this DB cluster snapshot.

Provides the engine mode of the database engine for this DB cluster snapshot.

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

• available

• copying

• creating

Provides the VPC ID associated with the DB cluster snapshot.

Provides the master username for this DB cluster snapshot.

Provides the version of the database engine for this DB cluster snapshot.

Provides the license model information for this DB cluster snapshot.

Provides the type of the DB cluster snapshot.

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

The Amazon Resource Name (ARN) for the DB cluster snapshot.

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

Reserved for future use.

The storage type associated with the DB cluster snapshot.

This setting is only for Aurora DB clusters.

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

The identifier of the manual DB cluster snapshot that the attributes apply to.

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the database engine.

The version number of the database engine.

The name of the DB parameter group family for the database engine.

The description of the database engine.

The description of the database engine version.

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

The status of the DB engine version, either available or deprecated.

The major engine version of the CEV.

The name of the Amazon S3 bucket that contains your database installation files.

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

The ARN of the custom engine version.

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

The name of the compute and memory capacity class of the DB instance.

The database engine used for this DB instance.

The current state of this database.

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

The master username for the DB instance.

Contains the initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

The name of the Availability Zone where the DB instance is located.

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

The version of the database engine.

The identifier of the source DB instance if this DB instance is a read replica.

The license model information for this DB instance. This setting doesn\'t apply to RDS Custom DB instances.

If present, specifies the name of the character set that this instance is associated with.

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.

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

The storage type associated with the DB instance.

The ARN from the key store with which the instance is associated for TDE encryption.

If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

If StorageEncrypted is enabled, 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.

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.

The identifier of the CA certificate for this DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

The Amazon Resource Name (ARN) for the DB instance.

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.

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.

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

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.

The name of the Amazon Kinesis data stream used for the database activity stream.

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.

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB instance. 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 and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid Values: IPV4 | DUAL

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

The identifier of the source DB cluster if this DB instance is a read replica.

The progress of the storage optimization operation as a percentage.

The Amazon Resource Name (ARN) for the automated backups.

The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.

The Amazon Web Services Region associated with the automated backup.

The customer id of the instance that is/was associated with the automated backup.

Provides a list of status information for an automated backup:

• active - automated backups for current instances

• retained - automated backups for deleted instances

• creating - automated backups that are waiting for the first automated snapshot to be available.

The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

Provides the VPC ID associated with the DB instance.

The license model of an automated backup.

The name of the database engine for this automated backup.

The version of the database engine for the automated backup.

License model information for the automated backup.

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

The ARN from the key store with which the automated backup is associated for TDE encryption.

Specifies the storage type associated with the automated backup.

The Amazon Web Services KMS key ID for an automated backup.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

The time zone of the automated backup. 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.

The Amazon Resource Name (ARN) for the replicated automated backups.

Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The Amazon Resource Name (ARN) of the replicated automated backups.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

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.

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.

This value is currently "read replication."

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.

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.

The name of the DB parameter group.

The name of the DB parameter group family that this DB parameter group is compatible with.

Provides the customer-specified description for this DB parameter group.

The Amazon Resource Name (ARN) for the DB parameter group.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the DB parameter group.

The name of the DB parameter group.

The status of parameter updates.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

The Amazon Resource Name (ARN) for the proxy.

The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

Provides the VPC ID of the DB proxy.

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

The Amazon Resource Name (ARN) for the DB proxy endpoint.

The identifier for the DB proxy that is associated with this DB proxy endpoint.

Provides the VPC ID of the DB proxy endpoint.

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

The writer endpoint for the RDS DB instance or Aurora DB cluster.

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

The identifier for the RDS proxy associated with this target group.

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

The Amazon Resource Name (ARN) representing the target group.

The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.

Provides the Amazon Web Services ID of the owner of a specific DB security group.

Specifies the name of the DB security group.

Provides the description of the DB security group.

Provides the VpcId of the DB security group.

The Amazon Resource Name (ARN) for the DB security group.

The name of the DB security group.

The status of the DB security group.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Specifies the identifier for the DB snapshot.

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Specifies the name of the database engine.

Specifies the status of this DB snapshot.

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Provides the VPC ID associated with the DB snapshot.

Provides the master username for the DB snapshot.

Specifies the version of the database engine.

License model information for the restored DB instance.

Provides the type of the DB snapshot.

Provides the option group name for the DB snapshot.

The Amazon Web Services Region that the DB snapshot was created in or copied from.

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

Specifies the storage type associated with DB snapshot.

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

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

The Amazon Resource Name (ARN) for the DB snapshot.

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

The name of the manual DB snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

The identifier of the manual DB snapshot that the attributes apply to.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the DB subnet group.

Provides the description of the DB subnet group.

Provides the VpcId of the DB subnet group.

Provides the status of the DB subnet group.

The Amazon Resource Name (ARN) for the DB subnet group.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

The DB cluster identifier for the DB cluster to be deleted. This parameter isn\'t case-sensitive.

Constraints:

• Must match an existing DBClusterIdentifier.

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

The name of the DB cluster parameter group.

Constraints:

• Must be the name of an existing DB cluster parameter group.

• You can\'t delete a default DB cluster parameter group.

• Can\'t be associated with any DB clusters.

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.

The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn\'t apply to RDS Custom.

The DB instance identifier for the DB instance to be deleted. This parameter isn\'t case-sensitive.

Constraints:

• Must match the name of an existing DB instance.

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

This setting doesn\'t apply to RDS Custom.

Constraints:

• Must be 1 to 255 letters or numbers.

• First character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

• Can\'t be specified when deleting a read replica.

The name of the DB parameter group.

Constraints:

• Must be the name of an existing DB parameter group

• You can\'t delete a default DB parameter group

• Can\'t be associated with any DB instances

The name of the DB proxy to delete.

The name of the DB security group to delete.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can\'t end with a hyphen or contain two consecutive hyphens

• Must not be "Default"

The DB snapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

The name of the database subnet group to delete.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mydbsubnetgroup

The name of the RDS event notification subscription you want to delete.

The cluster identifier of the global database cluster being deleted.

The name of the option group to be deleted.

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

The identifier of the DBProxyTargetGroup.

An optional pagination token provided by a previous DescribeBlueGreenDeployments request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified by MaxRecords.

A pagination token that can be used in a later DescribeBlueGreenDeployments request.

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn\'t case-sensitive.

Constraints:

• Must match an existing CertificateIdentifier.

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

• Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see Universally unique identifier.

Example: 123e4567-e89b-12d3-a456-426655440000

An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of a specific DB cluster parameter group to return details for.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The identifier for the DB cluster snapshot to describe the attributes for.

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can\'t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn\'t case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBCluster.

A specific DB cluster snapshot identifier to describe. This parameter can\'t be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBClusterSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

The type of DB cluster snapshots to be returned. You can specify one of the following values:

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

• public - Return all DB cluster snapshots that have been marked as public.

If you don\'t specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn\'t case-sensitive.

Constraints:

• If supplied, must match an existing DB cluster identifier.

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The database engine to return.

Valid Values:

• aurora-mysql

• aurora-postgresql

• custom-oracle-ee

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

The database engine version to return.

Example: 5.1.49

The name of a specific DB parameter group family to return details for.

Constraints:

• If supplied, must match an existing DBParameterGroupFamily.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The resource ID of the DB instance that is the source of the automated backup. This parameter isn\'t case-sensitive.

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance\' automated backup. This parameter isn\'t case-sensitive.

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn\'t apply to RDS Custom.

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn\'t case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DB instance.

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the log file for the specified DB instance.

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

• Must match the identifier of an existing DBInstance.

Filters the available log files for log file names that contain the specified string.

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

A pagination token that can be used in a later DescribeDBLogFiles request.

The name of a specific DB parameter group to return details for.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of a specific DB parameter group to return details for.

Constraints:

• If supplied, must match the name of an existing DBParameterGroup.

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The identifier of the DBProxy associated with the target group.

The identifier of the DBProxyTargetGroup to describe.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The identifier of the DBProxyTarget to describe.

The identifier of the DBProxyTargetGroup to describe.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the DB security group to return details for.

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The identifier for the DB snapshot to describe the attributes for.

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn\'t case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

A specific DB snapshot identifier to describe. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

The type of snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

• public - Return all DB snapshots that have been marked as public.

• awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

  For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.

  The awsbackup type does not apply to Aurora.

If you don\'t specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

A specific DB resource ID to describe.

The name of the DB subnet group to return details for.

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the DB cluster parameter group family to return engine parameter information for.

An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the DB parameter group family.

Valid Values:

• aurora-mysql5.7

• aurora-mysql8.0

• aurora-postgresql10

• aurora-postgresql11

• aurora-postgresql12

• aurora-postgresql13

• aurora-postgresql14

• custom-oracle-ee-19

• mariadb10.2

• mariadb10.3

• mariadb10.4

• mariadb10.5

• mariadb10.6

• mysql5.7

• mysql8.0

• oracle-ee-19

• oracle-ee-cdb-19

• oracle-ee-cdb-21

• oracle-se2-19

• oracle-se2-cdb-19

• oracle-se2-cdb-21

• postgres10

• postgres11

• postgres12

• postgres13

• postgres14

• sqlserver-ee-11.0

• sqlserver-ee-12.0

• sqlserver-ee-13.0

• sqlserver-ee-14.0

• sqlserver-ee-15.0

• sqlserver-ex-11.0

• sqlserver-ex-12.0

• sqlserver-ex-13.0

• sqlserver-ex-14.0

• sqlserver-ex-15.0

• sqlserver-se-11.0

• sqlserver-se-12.0

• sqlserver-se-13.0

• sqlserver-se-14.0

• sqlserver-se-15.0

• sqlserver-web-11.0

• sqlserver-web-12.0

• sqlserver-web-13.0

• sqlserver-web-14.0

• sqlserver-web-15.0

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy

The name of the RDS event notification subscription you want to describe.

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

• If SourceIdentifier is supplied, SourceType must also be provided.

• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

• If the source type is an RDS Proxy, a DBProxyName value must be supplied.

• Can\'t end with a hyphen or contain two consecutive hyphens.

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The identifier of the snapshot or cluster export task to be described.

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn\'t case-sensitive.

Constraints:

• If supplied, must match an existing DBClusterIdentifier.

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

A required parameter. Options available for the given engine name are described.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

If specified, filters the results to include only options for the specified major engine version.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the option group to describe. Can\'t be supplied together with EngineName or MajorEngineVersion.

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

The name of the engine to retrieve DB instance options for.

Valid Values:

• aurora-mysql

• aurora-postgresql

• custom-oracle-ee

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

RDS Custom supports only the BYOL licensing model.

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

This setting doesn\'t apply to RDS Custom.

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The ARN of a resource to return pending maintenance actions for.

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The source Amazon Web Services Region name. For example, us-east-1.

Constraints:

• Must specify a valid Amazon Web Services Region name.

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The customer identifier or the ARN of your DB instance.

The identifier of the Active Directory Domain.

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

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

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

The Active Directory organizational unit for the DB instance or cluster.

The ARN for the Secrets Manager secret with the credentials for the user that\'s a member of the domain.

Entries from the specified log file.

A pagination token that can be used in a later DownloadDBLogFilePortion request.

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

• Must match the identifier of an existing DBInstance.

The name of the log file to be downloaded.

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

Specifies the name of the EC2 security group.

Specifies the id of the EC2 security group.

Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

Specifies the DNS address of the DB instance.

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Specifies the name of the DB parameter group family that the engine default parameters apply to.

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Provides the identifier for the source of the event.

Provides the text of this event.

The Amazon Resource Name (ARN) for the event.

The source type that the returned categories belong to

The Amazon Web Services customer account associated with the RDS event notification subscription.

The RDS event notification subscription Id.

The topic ARN of the RDS event notification subscription.

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

The time the RDS event notification subscription was created.

The source type for the RDS event notification subscription.

The Amazon Resource Name (ARN) for the event subscription.

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

A unique identifier for the snapshot or cluster export task. This ID isn\'t an identifier for the Amazon S3 bucket where the data is exported.

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

The Amazon S3 bucket that the snapshot or cluster is exported to.

The Amazon S3 bucket prefix that is the file name and path of the exported data.

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it\'s exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.

The progress status of the export task. The status can be one of the following:

• CANCELED

• CANCELING

• COMPLETE

• FAILED

• IN_PROGRESS

• STARTING

The reason the export failed, if it failed.

A warning about the snapshot or cluster export task.

A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.

A DB cluster identifier to force a failover for. This parameter isn\'t case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

The name of the DB instance to promote to the primary DB instance.

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.

This setting isn\'t supported for RDS for MySQL Multi-AZ DB clusters.

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

The name of the filter. Filter names are case-sensitive.

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

The Amazon Resource Name (ARN) for the global database cluster.

Specifies the current state of this global database cluster.

The Aurora database engine used by the global database cluster.

Indicates the database engine version.

The default database name within the new global database cluster.

The Amazon Resource Name (ARN) for each Aurora cluster.

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

Specifies the IP range.

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

The Amazon Resource Name (ARN) of the secret.

The status of the secret.

The possible status values include the following:

• creating - The secret is being created.

• active - The secret is available for normal use and rotation.

• rotating - The secret is being rotated.

• impaired - The secret can be used to access database credentials, but it can\'t be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

  When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

The allowed value for an option setting.

The minimum DB engine version required for the allowed value.

The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

The name of the Amazon Kinesis data stream to be used for the database activity stream.

The new default certificate identifier to override the current one with.

To determine the valid values, use the describe-certificates CLI command or the DescribeCertificates API operation.

The DB cluster identifier for the cluster being modified. This parameter isn\'t case-sensitive.

Constraints:

• Must match the identifier of an existing DB cluster.

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point isn\'t found in the timeout period.

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

The type of the endpoint. One of: READER, WRITER, ANY.

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.

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

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

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.

The option group to associate the DB cluster with.

DB clusters are associated with a default option group that can\'t be modified.

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.

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.

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

The name of the DB parameter group to apply to all instances of the DB cluster.

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.

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

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

Valid for Cluster Type: Aurora DB clusters only

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

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

Default:

• Aurora DB clusters - aurora

• Multi-AZ DB clusters - io1

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

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

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

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

The DB engine mode of the DB cluster, either provisioned or serverless.

For more information, see CreateDBCluster.

Valid for Cluster Type: Aurora DB clusters only

The name of the DB cluster parameter group to modify.

The identifier for the DB cluster snapshot to modify the attributes for.

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

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

Constraints:

• Must match the identifier of an existing DB instance.

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.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.

Default: Uses existing setting

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 DB instances.

Constraints:

• If supplied, must match existing DB subnet group.

Example: mydbsubnetgroup

The new password for the master user.

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 the PendingModifiedValues element of the operation response.

This setting doesn\'t apply to the following DB instances:

• Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.)

• RDS Custom

Default: Uses existing setting

Constraints:

• Can\'t be specified if ManageMasterUserPassword is turned on.

• Can include any printable ASCII character except "/", """, or "@".

Length Constraints:

• RDS for MariaDB - Must contain from 8 to 41 characters.

• RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

• RDS for MySQL - Must contain from 8 to 41 characters.

• RDS for Oracle - Must contain from 8 to 30 characters.

• RDS for PostgreSQL - Must contain from 8 to 128 characters.

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 DB instances.

Default: Uses existing setting

Constraints:

• Must be in the same DB parameter group family as the DB instance.

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.

This setting doesn\'t apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

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.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Constraints:

• Must be in the format ddd:hh24:mi-ddd:hh24:mi.

• The day values must be mon | tue | wed | thu | fri | sat | sun.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred backup window.

• Must be at least 30 minutes.

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 updates the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

If the instance that you\'re modifying is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running.

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.

The license model for the DB instance.

This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.

Valid Values:

• RDS for MariaDB - general-public-license

• RDS for Microsoft SQL Server - license-included

• RDS for MySQL - general-public-license

• RDS for Oracle - bring-your-own-license | license-included

• RDS for PostgreSQL - postgresql-license

The option group to associate the DB instance with.

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 DB instances.

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.

This setting doesn\'t apply to RDS Custom DB instances.

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

The storage type to associate with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops 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 the Iops parameter is specified. Otherwise, gp2.

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

This setting doesn\'t apply to RDS Custom DB instances.

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

This setting doesn\'t apply to RDS Custom DB instances.

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

This setting doesn\'t apply to RDS Custom DB instances.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

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 DB instances.

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

Constraints:

• Can\'t be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

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

Constraints:

• Must be in the distinguished name format.

• Can\'t be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

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

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

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 a MonitoringRoleArn value.

This setting doesn\'t apply to RDS Custom DB instances.

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

This setting doesn\'t apply to RDS Custom DB instances.

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.

This setting doesn\'t apply to RDS Custom DB instances.

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB instance. 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.

Valid Values: IPV4 | DUAL

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 instance doesn\'t manage the master user password in Amazon Web Services Secrets Manager.

  If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can\'t change the KMS key 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.

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.

Note the following requirements:

• Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.

• Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.

Note the following limitations:

• You can\'t convert a CDB to a non-CDB.

• You can\'t convert a replica database.

• You can\'t convert a non-CDB to a CDB and upgrade the engine version in the same command.

• You can\'t convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with --db-parameter-group-name and a new option group with --option-group-name.

The name of the DB parameter group.

Constraints:

• If supplied, must match the name of an existing DBParameterGroup.

The identifier for the DBProxy to modify.

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

The name of the target group to modify.

The name of the proxy.

The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

The identifier for the DB snapshot to modify the attributes for.

The name of the DB snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.

The identifier of the DB snapshot to modify.

The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

• 5.5.46 (supported for 5.1 DB snapshots)

Oracle

• 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots)

• 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots)

• 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

• 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

• 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

PostgreSQL

For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.

The name for the DB subnet group. This value is stored as a lowercase string. You can\'t modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mydbsubnetgroup

The description for the DB subnet group.

The name of the RDS event notification subscription.

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn\'t specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy

The cluster identifier for the global cluster to modify. This parameter isn\'t case-sensitive.

Constraints:

• Must match the identifier of an existing global database cluster.

The new cluster identifier for the global database cluster. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

The version number of the database engine to which you want to upgrade.

To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query \'*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]\'

To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query \'*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]\'

The name of the option group to be modified.

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 once it is associated with a DB instance

The name of the option.

The description of the option.

The version of the option.

The configuration of options to include in a group.

The version for the option.

Specifies the name of the option group.

Provides a description of the option group.

Indicates the name of the engine that this option group can be applied to.

Indicates the major engine version associated with this option group.

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

Specifies the Amazon Resource Name (ARN) for the option group.

Specifies the name of the option group from which this option group is copied.

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

The name of the option group that the instance belongs to.

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, and failed.

The name of the option.

The description of the option.

The name of the engine that this option can be applied to.

Indicates the major engine version that the option is available for.

The minimum required engine version for the option to be applied.

The name of the option group option.

The description of the option group option.

The default value for the option group option.

The DB engine specific parameter type for the option group option.

Indicates the acceptable values for the option group option.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The name of the option that has settings that you can set.

The current value of the option setting.

The default value of the option setting.

The description of the option setting.

The DB engine specific parameter type.

The data type of the option setting.

The allowed values of the option setting.

The version of the option.

The engine type of a DB instance.

The engine version of a DB instance.

The DB instance class for a DB instance.

The license model for a DB instance.

The Availability Zone group for a DB instance.

Indicates the storage type for a DB instance.

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

The Amazon Resource Name (ARN) of the Outpost.

Specifies the name of the parameter.

Specifies the value of the parameter.

Provides a description of the parameter.

Indicates the source of the parameter value.

Specifies the engine specific parameters type.

Specifies the valid data type for the parameter.

Specifies the valid range of values for the parameter.

The earliest engine version to which the parameter can apply.

The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.

Indicates the type of opt-in request that has been received for the resource.

A description providing more detail about the maintenance action.

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

The name of the compute and memory capacity class for the DB instance.

The master credentials for the DB instance.

The database engine version.

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

The database identifier for the DB instance.

The storage type of the DB instance.

The identifier of the CA certificate for the DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

The DB subnet group for the DB instance.

The database engine of the DB instance.

The name of the processor feature. Valid names are coreCount and threadsPerCore.

The value of a processor feature name.

The identifier of the DB cluster read replica to promote. This parameter isn\'t case-sensitive.

Constraints:

• Must match the identifier of an existing DB cluster read replica.

Example: my-cluster-replica1

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

Constraints:

• Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

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 see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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.

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

Customer-specified identifier to track this reservation.

Example: myreservationID

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing DBCluster.

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing DBInstance.

The frequency of the recurring charge.

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

The identifier of the DBProxyTargetGroup.

The cluster identifier to detach from the Aurora global database cluster.

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

The name of the DB cluster to disassociate the IAM role from.

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.