Module Smaws_Client_RDS.Types

type nonrec write_forwarding_status =
  1. | UNKNOWN
  2. | DISABLING
  3. | ENABLING
  4. | DISABLED
  5. | ENABLED
type nonrec string_ = string
type nonrec vpc_security_group_membership = {
  1. status : string_ option;
    (*

    The membership status of the VPC security group.

    Currently, the only valid status is active.

    *)
  2. vpc_security_group_id : string_ option;
    (*

    The name of the VPC security group.

    *)
}

This data type is used as a response element for queries on VPC security group membership.

type nonrec vpc_security_group_membership_list = vpc_security_group_membership list
type nonrec vpc_security_group_id_list = string_ list
type nonrec exception_message = string
type nonrec vpc_encryption_control_violation_exception = {
  1. message : exception_message option;
}

The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.

type nonrec integer = int
type nonrec integer_optional = int
type nonrec range = {
  1. step : integer_optional option;
    (*

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

    *)
  2. to_ : integer option;
    (*

    The maximum value in the range.

    *)
  3. from_ : integer option;
    (*

    The minimum value in the range.

    *)
}

A range of integer values.

type nonrec range_list = range list
type nonrec double = float
type nonrec double_range = {
  1. to_ : double option;
    (*

    The maximum value in the range.

    *)
  2. from_ : double option;
    (*

    The minimum value in the range.

    *)
}

A range of double values.

type nonrec double_range_list = double_range list
type nonrec boolean_ = bool
type nonrec valid_storage_options = {
  1. supports_storage_autoscaling : boolean_ option;
    (*

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

    *)
  2. storage_throughput_to_iops_ratio : double_range_list option;
    (*

    The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.

    *)
  3. provisioned_storage_throughput : range_list option;
    (*

    The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).

    *)
  4. iops_to_storage_ratio : double_range_list option;
    (*

    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.

    *)
  5. provisioned_iops : range_list option;
    (*

    The valid range of provisioned IOPS. For example, 1000-256,000.

    *)
  6. storage_size : range_list option;
    (*

    The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.

    *)
  7. storage_type : string_ option;
    (*

    The valid storage types for your DB instance. For example: gp2, gp3, io1, io2.

    *)
}

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

type nonrec valid_storage_options_list = valid_storage_options list
type nonrec valid_volume_options = {
  1. storage : valid_storage_options_list option;
    (*

    The valid storage options for the additional storage volume.

    *)
  2. volume_name : string_ option;
    (*

    The name of the additional storage volume.

    *)
}

Contains the valid options for an additional storage volume.

type nonrec valid_volume_options_list = valid_volume_options list
type nonrec engine_mode_list = string_ list
type nonrec boolean_optional = bool
type nonrec upgrade_target = {
  1. supports_integrations : boolean_optional option;
    (*

    Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

    *)
  2. supports_local_write_forwarding : boolean_optional option;
    (*

    Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

    Valid for: Aurora DB clusters only

    *)
  3. supports_limitless_database : boolean_optional option;
    (*

    Indicates whether the DB engine version supports Aurora Limitless Database.

    *)
  4. supports_babelfish : boolean_optional option;
    (*

    Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

    *)
  5. supports_global_databases : boolean_optional option;
    (*

    Indicates whether you can use Aurora global databases with the target engine version.

    *)
  6. supports_parallel_query : boolean_optional option;
    (*

    Indicates whether you can use Aurora parallel query with the target engine version.

    *)
  7. supported_engine_modes : engine_mode_list option;
    (*

    A list of the supported DB engine modes for the target engine version.

    *)
  8. is_major_version_upgrade : boolean_ option;
    (*

    Indicates whether upgrading to the target version requires upgrading the major version of the database engine.

    *)
  9. auto_upgrade : boolean_ option;
    (*

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

    This parameter is dynamic, and is set by RDS.

    *)
  10. description : string_ option;
    (*

    The version of the database engine that a DB instance can be upgraded to.

    *)
  11. engine_version : string_ option;
    (*

    The version number of the upgrade target database engine.

    *)
  12. engine : string_ option;
    (*

    The name of the upgrade target database engine.

    *)
}

The version of the database engine that a DB instance can be upgraded to.

type nonrec valid_upgrade_target_list = upgrade_target list
type nonrec available_processor_feature = {
  1. allowed_values : string_ option;
    (*

    The allowed values for the processor feature of the DB instance class.

    *)
  2. default_value : string_ option;
    (*

    The default value for the processor feature of the DB instance class.

    *)
  3. name : string_ option;
    (*

    The name of the processor feature. Valid names are coreCount and threadsPerCore.

    *)
}

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.

type nonrec available_processor_feature_list = available_processor_feature list
type nonrec valid_additional_storage_options = {
  1. volumes : valid_volume_options_list option;
    (*

    The valid additional storage volume options for the DB instance.

    *)
  2. supports_additional_storage_volumes : boolean_ option;
    (*

    Indicates whether the DB instance supports additional storage volumes.

    *)
}

Contains the valid options for additional storage volumes for a DB instance.

type nonrec valid_db_instance_modifications_message = {
  1. additional_storage : valid_additional_storage_options option;
    (*

    The valid additional storage options for the DB instance.

    *)
  2. supports_dedicated_log_volume : boolean_ option;
    (*

    Indicates whether a DB instance supports using a dedicated log volume (DLV).

    *)
  3. valid_processor_features : available_processor_feature_list option;
    (*

    Valid processor features for your DB instance.

    *)
  4. storage : valid_storage_options_list option;
    (*

    Valid storage options for your DB instance.

    *)
}

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

type nonrec description = string
type nonrec auth_user_name = string
type nonrec auth_scheme =
  1. | SECRETS
type nonrec arn = string
type nonrec iam_auth_mode =
  1. | ENABLED
  2. | REQUIRED
  3. | DISABLED
type nonrec client_password_auth_type =
  1. | SQL_SERVER_AUTHENTICATION
  2. | POSTGRES_MD5
  3. | POSTGRES_SCRAM_SHA_256
  4. | MYSQL_CACHING_SHA2_PASSWORD
  5. | MYSQL_NATIVE_PASSWORD
type nonrec user_auth_config = {
  1. client_password_auth_type : client_password_auth_type option;
    (*

    The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:

    • RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD
    • RDS for SQL Server: SQL_SERVER_AUTHENTICATION
    • RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256
    *)
  2. iam_auth : iam_auth_mode option;
    (*

    A value that indicates 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.

    *)
  3. secret_arn : arn option;
    (*

    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    *)
  4. auth_scheme : auth_scheme option;
    (*

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

    *)
  5. user_name : auth_user_name option;
    (*

    The name of the database user to which the proxy connects.

    *)
  6. description : description option;
    (*

    A user-specified description about the authentication used by a proxy to log in as a specific database user.

    *)
}

Specifies the details of authentication used by a proxy to log in as a specific database user.

type nonrec user_auth_config_list = user_auth_config list
type nonrec user_auth_config_info = {
  1. client_password_auth_type : client_password_auth_type option;
    (*

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

    *)
  2. iam_auth : iam_auth_mode option;
    (*

    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.

    *)
  3. secret_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    *)
  4. auth_scheme : auth_scheme option;
    (*

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

    *)
  5. user_name : string_ option;
    (*

    The name of the database user to which the proxy connects.

    *)
  6. description : string_ option;
    (*

    A user-specified description about the authentication used by a proxy to log in as a specific database user.

    *)
}

Returns the details of authentication used by a proxy to log in as a specific database user.

type nonrec user_auth_config_info_list = user_auth_config_info list
type nonrec upgrade_rollout_order =
  1. | LAST
  2. | SECOND
  3. | FIRST
type nonrec unsupported_db_engine_version_fault = {
  1. message : exception_message option;
}

The specified DB engine version isn't supported for Aurora Limitless Database.

type nonrec timezone = {
  1. timezone_name : string_ option;
    (*

    The name of the time zone.

    *)
}

A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

type nonrec t_stamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec sensitive_string = string
type nonrec tenant_database_pending_modified_values = {
  1. tenant_db_name : string_ option;
    (*

    The name of the tenant database.

    *)
  2. master_user_password : sensitive_string option;
    (*

    The master password for the tenant database.

    *)
}

A response element in the ModifyTenantDatabase operation that describes changes that will be applied. Specific changes are identified by subelements.

type nonrec master_user_secret = {
  1. kms_key_id : string_ option;
    (*

    The Amazon Web Services KMS key identifier that is used to encrypt the secret.

    *)
  2. secret_status : string_ option;
    (*

    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.

    *)
  3. secret_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the secret.

    *)
}

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.

type nonrec tag = {
  1. value : string_ option;
    (*

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

    *)
  2. key : string_ option;
    (*

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

    *)
}

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

type nonrec tag_list = tag list
type nonrec tenant_database = {
  1. tag_list : tag_list option;
  2. master_user_secret : master_user_secret option;
  3. pending_modified_values : tenant_database_pending_modified_values option;
    (*

    Information about pending changes for a tenant database.

    *)
  4. deletion_protection : boolean_ option;
    (*

    Specifies whether deletion protection is enabled for the DB instance.

    *)
  5. nchar_character_set_name : string_ option;
    (*

    The NCHAR character set name of the tenant database.

    *)
  6. character_set_name : string_ option;
    (*

    The character set of the tenant database.

    *)
  7. tenant_database_ar_n : string_ option;
    (*

    The Amazon Resource Name (ARN) for the tenant database.

    *)
  8. tenant_database_resource_id : string_ option;
    (*

    The Amazon Web Services Region-unique, immutable identifier for the tenant database.

    *)
  9. dbi_resource_id : string_ option;
    (*

    The Amazon Web Services Region-unique, immutable identifier for the DB instance.

    *)
  10. master_username : string_ option;
    (*

    The master username of the tenant database.

    *)
  11. status : string_ option;
    (*

    The status of the tenant database.

    *)
  12. tenant_db_name : string_ option;
    (*

    The database name of the tenant database.

    *)
  13. db_instance_identifier : string_ option;
    (*

    The ID of the DB instance that contains the tenant database.

    *)
  14. tenant_database_create_time : t_stamp option;
    (*

    The creation time of the tenant database.

    *)
}

A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases action.

type nonrec tenant_databases_list = tenant_database list
type nonrec tenant_databases_message = {
  1. tenant_databases : tenant_databases_list option;
    (*

    An array of the tenant databases requested by the DescribeTenantDatabases operation.

    *)
  2. marker : string_ option;
    (*

    An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
}
type nonrec tenant_database_quota_exceeded_fault = {
  1. message : exception_message option;
}

You attempted to create more tenant databases than are permitted in your Amazon Web Services account.

type nonrec tenant_database_not_found_fault = {
  1. message : exception_message option;
}

The specified tenant database wasn't found in the DB instance.

type nonrec tenant_database_already_exists_fault = {
  1. message : exception_message option;
}

You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.

type nonrec target_type =
  1. | TRACKED_CLUSTER
  2. | RDS_SERVERLESS_ENDPOINT
  3. | RDS_INSTANCE
type nonrec target_storage_type = string
type nonrec target_state =
  1. | Unused
  2. | Unavailable
  3. | Available
  4. | Registering
type nonrec target_role =
  1. | UNKNOWN
  2. | READ_ONLY
  3. | READ_WRITE
type nonrec target_health_reason =
  1. | PROMOTED
  2. | INVALID_REPLICATION_STATE
  3. | PENDING_PROXY_CAPACITY
  4. | AUTH_FAILURE
  5. | CONNECTION_FAILED
  6. | UNREACHABLE
type nonrec target_health = {
  1. description : string_ option;
    (*

    A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

    *)
  2. reason : target_health_reason option;
    (*

    The reason for the current health State of the RDS Proxy target.

    *)
  3. state : target_state option;
    (*

    The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

    registering > unavailable > available > unavailable > available

    *)
}

Information about the connection health of an RDS Proxy target.

type nonrec db_proxy_target = {
  1. target_health : target_health option;
    (*

    Information about the connection health of the RDS Proxy target.

    *)
  2. role : target_role option;
    (*

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

    *)
  3. type_ : target_type option;
    (*

    Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

    *)
  4. port : integer option;
    (*

    The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

    *)
  5. rds_resource_id : string_ option;
    (*

    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.

    *)
  6. tracked_cluster_id : string_ option;
    (*

    The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

    *)
  7. endpoint : string_ option;
    (*

    The writer endpoint for the RDS DB instance or Aurora DB cluster.

    *)
  8. target_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

    *)
}

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.

type nonrec target_list = db_proxy_target list
type nonrec string_list = string_ list
type nonrec operator_sensitive_string = string
type nonrec connection_pool_configuration_info = {
  1. init_query : operator_sensitive_string option;
    (*

    One or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with SET statements to make sure that each connection has identical settings. The query added here must be valid. For including multiple variables in a single SET statement, use a comma separator. This is an optional field.

    For example: SET variable1=value1, variable2=value2

    Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.

    *)
  2. session_pinning_filters : string_list option;
    (*

    Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

    *)
  3. connection_borrow_timeout : integer option;
    (*

    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.

    *)
  4. max_idle_connections_percent : integer option;
    (*

    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.

    *)
  5. max_connections_percent : integer option;
    (*

    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.

    *)
}

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

type nonrec db_proxy_target_group = {
  1. updated_date : t_stamp option;
    (*

    The date and time when the target group was last updated.

    *)
  2. created_date : t_stamp option;
    (*

    The date and time when the target group was first created.

    *)
  3. connection_pool_config : connection_pool_configuration_info option;
    (*

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

    *)
  4. status : string_ option;
    (*

    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.

    *)
  5. is_default : boolean_ option;
    (*

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

    *)
  6. target_group_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) representing the target group.

    *)
  7. target_group_name : string_ option;
    (*

    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.

    *)
  8. db_proxy_name : string_ option;
    (*

    The identifier for the RDS proxy associated with this target group.

    *)
}

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.

type nonrec target_group_list = db_proxy_target_group list
type nonrec target_engine_version = string
type nonrec target_db_parameter_group_name = string
type nonrec target_db_instance_class = string
type nonrec target_db_cluster_parameter_group_name = string
type nonrec target_connection_network_type =
  1. | IPV6
  2. | IPV4
type nonrec tag_specification = {
  1. tags : tag_list option;
  2. resource_type : string_ option;
    (*

    The type of resource to tag on creation.

    Valid Values:

    • auto-backup - The DB instance's automated backup.
    • cluster-auto-backup - The DB cluster's automated backup.
    *)
}

The tags to apply to resources when creating or modifying a DB instance or DB cluster. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

type nonrec tag_specification_list = tag_specification list
type nonrec tag_list_message = {
  1. tag_list : tag_list option;
    (*

    List of tags returned by the ListTagsForResource operation.

    *)
}
type nonrec switchover_timeout = int
type nonrec endpoint = {
  1. hosted_zone_id : string_ option;
    (*

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    *)
  2. port : integer option;
    (*

    Specifies the port that the database engine is listening on.

    *)
  3. address : string_ option;
    (*

    Specifies the DNS address of the DB instance.

    *)
}

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.

type nonrec db_security_group_membership = {
  1. status : string_ option;
    (*

    The status of the DB security group.

    *)
  2. db_security_group_name : string_ option;
    (*

    The name of the DB security group.

    *)
}

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

  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceToPointInTime
type nonrec db_security_group_membership_list = db_security_group_membership list
type nonrec db_parameter_group_status = {
  1. parameter_apply_status : string_ option;
    (*

    The status of parameter updates. Valid values are:

    • applying: The parameter group change is being applied to the database.
    • failed-to-apply: The parameter group is in an invalid state.
    • in-sync: The parameter group change is synchronized with the database.
    • pending-database-upgrade: The parameter group change will be applied after the DB instance is upgraded.
    • pending-reboot: The parameter group change will be applied after the DB instance reboots.
    *)
  2. db_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group.

    *)
}

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
type nonrec db_parameter_group_status_list = db_parameter_group_status list
type nonrec availability_zone = {
  1. name : string_ option;
    (*

    The name of the Availability Zone.

    *)
}

Contains Availability Zone information.

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

type nonrec outpost = {
  1. arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Outpost.

    *)
}

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.

type nonrec subnet = {
  1. subnet_status : string_ option;
    (*

    The status of the subnet.

    *)
  2. subnet_outpost : outpost option;
    (*

    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.

    *)
  3. subnet_availability_zone : availability_zone option;
  4. subnet_identifier : string_ option;
    (*

    The identifier of the subnet.

    *)
}

This data type is used as a response element for the DescribeDBSubnetGroups operation.

type nonrec subnet_list = subnet list
type nonrec db_subnet_group = {
  1. supported_network_types : string_list option;
    (*

    The network type of the DB subnet group.

    Valid values:

    • IPV4
    • DUAL

    A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    *)
  2. db_subnet_group_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB subnet group.

    *)
  3. subnets : subnet_list option;
    (*

    Contains a list of Subnet elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.

    *)
  4. subnet_group_status : string_ option;
    (*

    Provides the status of the DB subnet group.

    *)
  5. vpc_id : string_ option;
    (*

    Provides the VpcId of the DB subnet group.

    *)
  6. db_subnet_group_description : string_ option;
    (*

    Provides the description of the DB subnet group.

    *)
  7. db_subnet_group_name : string_ option;
    (*

    The name of the DB subnet group.

    *)
}

Contains the details of an Amazon RDS DB subnet group.

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

type nonrec log_type_list = string_ list
type nonrec pending_cloudwatch_logs_exports = {
  1. log_types_to_disable : log_type_list option;
    (*

    Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

    *)
  2. log_types_to_enable : log_type_list option;
    (*

    Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

    *)
}

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.

type nonrec processor_feature = {
  1. value : string_ option;
    (*

    The value of a processor feature.

    *)
  2. name : string_ option;
    (*

    The name of the processor feature. Valid names are coreCount and threadsPerCore.

    *)
}

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 or SQL Server DB instance.
  • Your Oracle or SQL Server 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 for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.

type nonrec processor_feature_list = processor_feature list
type nonrec automation_mode =
  1. | ALL_PAUSED
  2. | FULL
type nonrec additional_storage_volume = {
  1. storage_type : string_ option;
    (*

    The storage type for the additional storage volume.

    Valid Values: GP3 | IO2

    *)
  2. storage_throughput : integer_optional option;
    (*

    The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD (gp3) storage type.

    *)
  3. max_allocated_storage : integer_optional option;
    (*

    The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.

    *)
  4. iop_s : integer_optional option;
    (*

    The number of I/O operations per second (IOPS) provisioned for the additional storage volume.

    *)
  5. allocated_storage : integer_optional option;
    (*

    The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).

    *)
  6. volume_name : string_;
    (*

    The name of the additional storage volume.

    Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4

    *)
}

Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.

type nonrec additional_storage_volumes_list = additional_storage_volume list
type nonrec pending_modified_values = {
  1. additional_storage_volumes : additional_storage_volumes_list option;
    (*

    The additional storage volume modifications that are pending for the DB instance.

    *)
  2. engine : string_ option;
    (*

    The database engine of the DB instance.

    *)
  3. dedicated_log_volume : boolean_optional option;
    (*

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

    *)
  4. iam_database_authentication_enabled : boolean_optional option;
    (*

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

    *)
  5. multi_tenant : boolean_optional option;
    (*

    Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

    *)
  6. resume_full_automation_mode_time : t_stamp option;
    (*

    The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

    *)
  7. automation_mode : automation_mode option;
    (*

    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.

    *)
  8. processor_features : processor_feature_list option;
    (*

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

    *)
  9. pending_cloudwatch_logs_exports : pending_cloudwatch_logs_exports option;
  10. db_subnet_group_name : string_ option;
    (*

    The DB subnet group for the DB instance.

    *)
  11. ca_certificate_identifier : string_ option;
    (*

    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.

    *)
  12. storage_type : string_ option;
    (*

    The storage type of the DB instance.

    *)
  13. db_instance_identifier : string_ option;
    (*

    The database identifier for the DB instance.

    *)
  14. storage_throughput : integer_optional option;
    (*

    The storage throughput of the DB instance.

    *)
  15. iops : integer_optional option;
    (*

    The Provisioned IOPS value for the DB instance.

    *)
  16. license_model : string_ option;
    (*

    The license model for the DB instance.

    Valid values: license-included | bring-your-own-license | general-public-license | bring-your-own-media

    *)
  17. engine_version : string_ option;
    (*

    The database engine version.

    *)
  18. multi_a_z : boolean_optional option;
    (*

    Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.

    *)
  19. backup_retention_period : integer_optional option;
    (*

    The number of days for which automated backups are retained.

    *)
  20. port : integer_optional option;
    (*

    The port for the DB instance.

    *)
  21. master_user_password : sensitive_string option;
    (*

    The master credentials for the DB instance.

    *)
  22. allocated_storage : integer_optional option;
    (*

    The allocated storage size for the DB instance specified in gibibytes (GiB).

    *)
  23. db_instance_class : string_ option;
    (*

    The name of the compute and memory capacity class for the DB instance.

    *)
}

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.

type nonrec read_replica_db_instance_identifier_list = string_ list
type nonrec read_replica_db_cluster_identifier_list = string_ list
type nonrec replica_mode =
  1. | MOUNTED
  2. | OPEN_READ_ONLY
type nonrec option_group_membership = {
  1. status : string_ option;
    (*

    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.

    *)
  2. option_group_name : string_ option;
    (*

    The name of the option group that the instance belongs to.

    *)
}

Provides information on the option groups the DB instance is a member of.

type nonrec option_group_membership_list = option_group_membership list
type nonrec db_instance_status_info = {
  1. message : string_ option;
    (*

    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.

    *)
  2. status : string_ option;
    (*

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

    *)
  3. normal : boolean_ option;
    (*

    Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).

    *)
  4. status_type : string_ option;
    (*

    This value is currently "read replication."

    *)
}

Provides a list of status information for a DB instance.

type nonrec db_instance_status_info_list = db_instance_status_info list
type nonrec storage_encryption_type =
  1. | SSE
  2. | CMK
  3. | UNENCRYPTED
type nonrec domain_membership = {
  1. dns_ips : string_list option;
    (*

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

    *)
  2. auth_secret_arn : string_ option;
    (*

    The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

    *)
  3. o_u : string_ option;
    (*

    The Active Directory organizational unit for the DB instance or cluster.

    *)
  4. iam_role_name : string_ option;
    (*

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

    *)
  5. fqd_n : string_ option;
    (*

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

    *)
  6. status : string_ option;
    (*

    The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

    *)
  7. domain : string_ option;
    (*

    The identifier of the Active Directory Domain.

    *)
}

An Active Directory Domain membership record associated with the DB instance or cluster.

type nonrec domain_membership_list = domain_membership list
type nonrec database_insights_mode =
  1. | ADVANCED
  2. | STANDARD
type nonrec db_instance_role = {
  1. status : string_ option;
    (*

    Information about 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.
    *)
  2. feature_name : string_ option;
    (*

    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.

    *)
  3. role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

    *)
}

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

type nonrec db_instance_roles = db_instance_role list
type nonrec activity_stream_status =
  1. | Stopping
  2. | Started
  3. | Starting
  4. | Stopped
type nonrec activity_stream_mode =
  1. | Async
  2. | Sync
type nonrec db_instance_automated_backups_replication = {
  1. db_instance_automated_backups_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replicated automated backups.

    *)
}

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

type nonrec db_instance_automated_backups_replication_list = db_instance_automated_backups_replication list
type nonrec activity_stream_policy_status =
  1. | Unlocking_policy
  2. | Locking_policy
  3. | Unlocked
  4. | Locked
type nonrec certificate_details = {
  1. valid_till : t_stamp option;
    (*

    The expiration date of the DB instance’s server certificate.

    *)
  2. ca_identifier : string_ option;
    (*

    The CA identifier of the CA certificate used for the DB instance's server certificate.

    *)
}

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.

type nonrec additional_storage_volume_output = {
  1. storage_type : string_ option;
    (*

    The storage type for the additional storage volume.

    Valid Values: GP3 | IO2

    *)
  2. storage_throughput : integer_optional option;
    (*

    The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).

    *)
  3. max_allocated_storage : integer_optional option;
    (*

    The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.

    *)
  4. iop_s : integer_optional option;
    (*

    The number of I/O operations per second (IOPS) provisioned for the additional storage volume.

    *)
  5. allocated_storage : integer option;
    (*

    The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).

    *)
  6. storage_volume_status : string_ option;
    (*

    The status of the additional storage volume.

    Valid Values: ACTIVE | CREATING | DELETING | MODIFYING | NOT-IN-USE | STORAGE-OPTIMIZATION | VOLUME-FULL

    *)
  7. volume_name : string_ option;
    (*

    The name of the additional storage volume.

    *)
}

Contains information about an additional storage volume for a DB instance.

type nonrec additional_storage_volumes_output_list = additional_storage_volume_output list
type nonrec db_instance = {
  1. storage_volume_status : string_ option;
    (*

    The detailed status information for storage volumes associated with the DB instance. This information helps identify which specific volume is causing the instance to be in a storage-full state.

    *)
  2. additional_storage_volumes : additional_storage_volumes_output_list option;
    (*

    The additional storage volumes associated with the DB instance. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.

    *)
  3. engine_lifecycle_support : string_ option;
    (*

    The lifecycle type for the DB instance.

    For more information, see CreateDBInstance.

    *)
  4. is_storage_config_upgrade_available : boolean_optional option;
    (*

    Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

    *)
  5. dedicated_log_volume : boolean_ option;
    (*

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

    *)
  6. multi_tenant : boolean_optional option;
    (*

    Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

    *)
  7. percent_progress : string_ option;
    (*

    The progress of the storage optimization operation as a percentage.

    *)
  8. read_replica_source_db_cluster_identifier : string_ option;
    (*

    The identifier of the source DB cluster if this DB instance is a read replica.

    *)
  9. master_user_secret : master_user_secret option;
    (*

    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.

    *)
  10. db_system_id : string_ option;
    (*

    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.

    *)
  11. certificate_details : certificate_details option;
    (*

    The details of the DB instance's server certificate.

    *)
  12. activity_stream_policy_status : activity_stream_policy_status option;
    (*

    The status of the policy state of the activity stream.

    *)
  13. custom_iam_instance_profile : string_ option;
    (*

    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.

    *)
  14. automatic_restart_time : t_stamp option;
    (*

    The time when a stopped DB instance is restarted automatically.

    *)
  15. backup_target : string_ option;
    (*

    The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

    *)
  16. db_instance_automated_backups_replications : db_instance_automated_backups_replication_list option;
    (*

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

    *)
  17. aws_backup_recovery_point_arn : string_ option;
    (*

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

    *)
  18. activity_stream_engine_native_audit_fields_included : boolean_optional option;
    (*

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

    *)
  19. activity_stream_mode : activity_stream_mode option;
    (*

    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.

    *)
  20. activity_stream_kinesis_stream_name : string_ option;
    (*

    The name of the Amazon Kinesis data stream used for the database activity stream.

    *)
  21. activity_stream_kms_key_id : string_ option;
    (*

    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.

    *)
  22. activity_stream_status : activity_stream_status option;
    (*

    The status of the database activity stream.

    *)
  23. network_type : string_ option;
    (*

    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

    *)
  24. customer_owned_ip_enabled : boolean_optional option;
    (*

    Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

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

    *)
  25. resume_full_automation_mode_time : t_stamp option;
    (*

    The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

    *)
  26. automation_mode : automation_mode option;
    (*

    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.

    *)
  27. tag_list : tag_list option;
  28. max_allocated_storage : integer_optional option;
    (*

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

    *)
  29. listener_endpoint : endpoint option;
    (*

    The listener connection endpoint for SQL Server Always On.

    *)
  30. associated_roles : db_instance_roles option;
    (*

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

    *)
  31. deletion_protection : boolean_ option;
    (*

    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.

    *)
  32. processor_features : processor_feature_list option;
    (*

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

    *)
  33. enabled_cloudwatch_logs_exports : log_type_list option;
    (*

    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.

    *)
  34. performance_insights_retention_period : integer_optional option;
    (*

    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

    *)
  35. performance_insights_kms_key_id : string_ option;
    (*

    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.

    *)
  36. performance_insights_enabled : boolean_optional option;
    (*

    Indicates whether Performance Insights is enabled for the DB instance.

    *)
  37. database_insights_mode : database_insights_mode option;
    (*

    The mode of Database Insights that is enabled for the instance.

    *)
  38. iam_database_authentication_enabled : boolean_ option;
    (*

    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.

    *)
  39. timezone : string_ option;
    (*

    The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.

    *)
  40. db_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB instance.

    *)
  41. promotion_tier : integer_optional option;
    (*

    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.

    *)
  42. monitoring_role_arn : string_ option;
    (*

    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    *)
  43. enhanced_monitoring_resource_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

    *)
  44. monitoring_interval : integer_optional option;
    (*

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

    *)
  45. copy_tags_to_snapshot : boolean_ option;
    (*

    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.

    *)
  46. domain_memberships : domain_membership_list option;
    (*

    The Active Directory Domain membership records associated with the DB instance.

    *)
  47. ca_certificate_identifier : string_ option;
    (*

    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.

    *)
  48. dbi_resource_id : string_ option;
    (*

    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.

    *)
  49. kms_key_id : string_ option;
    (*

    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.

    *)
  50. storage_encrypted : boolean_ option;
    (*

    Indicates whether the DB instance is encrypted.

    *)
  51. db_cluster_identifier : string_ option;
    (*

    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.

    *)
  52. db_instance_port : integer option;
    (*

    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.

    *)
  53. tde_credential_arn : string_ option;
    (*

    The ARN from the key store with which the instance is associated for TDE encryption.

    *)
  54. storage_encryption_type : storage_encryption_type option;
    (*

    The type of encryption used to protect data at rest in the DB instance. Possible values:

    • none - The DB instance is not encrypted.
    • sse-rds - The DB instance is encrypted using an Amazon Web Services owned KMS key.
    • sse-kms - The DB instance is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
    *)
  55. storage_type : string_ option;
    (*

    The storage type associated with the DB instance.

    *)
  56. status_infos : db_instance_status_info_list option;
    (*

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

    *)
  57. publicly_accessible : boolean_ option;
    (*

    Indicates whether the DB instance is publicly accessible.

    When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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.

    *)
  58. secondary_availability_zone : string_ option;
    (*

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    *)
  59. nchar_character_set_name : string_ option;
    (*

    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.

    *)
  60. character_set_name : string_ option;
    (*

    If present, specifies the name of the character set that this instance is associated with.

    *)
  61. option_group_memberships : option_group_membership_list option;
    (*

    The list of option group memberships for this DB instance.

    *)
  62. storage_throughput : integer_optional option;
    (*

    The storage throughput for the DB instance.

    This setting applies only to the gp3 storage type.

    *)
  63. iops : integer_optional option;
    (*

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

    *)
  64. license_model : string_ option;
    (*

    The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

    *)
  65. replica_mode : replica_mode option;
    (*

    The open mode of a Db2 or an Oracle read replica. The default is open-read-only. For more information, see Working with replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide.

    This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle.

    *)
  66. read_replica_db_cluster_identifiers : read_replica_db_cluster_identifier_list option;
    (*

    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.

    Currently, each RDS DB instance can have only one Aurora read replica.

    *)
  67. read_replica_db_instance_identifiers : read_replica_db_instance_identifier_list option;
    (*

    The identifiers of the read replicas associated with this DB instance.

    *)
  68. read_replica_source_db_instance_identifier : string_ option;
    (*

    The identifier of the source DB instance if this DB instance is a read replica.

    *)
  69. auto_minor_version_upgrade : boolean_ option;
    (*

    Indicates whether minor version patches are applied automatically.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  70. engine_version : string_ option;
    (*

    The version of the database engine.

    *)
  71. multi_a_z : boolean_ option;
    (*

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

    *)
  72. latest_restorable_time : t_stamp option;
    (*

    The latest time to which a database in this DB instance can be restored with point-in-time restore.

    *)
  73. pending_modified_values : pending_modified_values option;
    (*

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

    *)
  74. upgrade_rollout_order : upgrade_rollout_order option;
    (*

    This data type represents the order in which the instances are upgraded.

    • [first] - Typically used for development or testing environments.
    • [second] - Default order for resources not specifically configured.
    • [last] - Usually reserved for production environments.
    *)
  75. preferred_maintenance_window : string_ option;
    (*

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    *)
  76. db_subnet_group : db_subnet_group option;
    (*

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

    *)
  77. availability_zone : string_ option;
    (*

    The name of the Availability Zone where the DB instance is located.

    *)
  78. db_parameter_groups : db_parameter_group_status_list option;
    (*

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

    *)
  79. vpc_security_groups : vpc_security_group_membership_list option;
    (*

    The list of Amazon EC2 VPC security groups that the DB instance belongs to.

    *)
  80. db_security_groups : db_security_group_membership_list option;
    (*

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

    *)
  81. backup_retention_period : integer option;
    (*

    The number of days for which automatic DB snapshots are retained.

    *)
  82. preferred_backup_window : string_ option;
    (*

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  83. instance_create_time : t_stamp option;
    (*

    The date and time when the DB instance was created.

    *)
  84. allocated_storage : integer option;
    (*

    The amount of storage in gibibytes (GiB) allocated for the DB instance.

    *)
  85. endpoint : endpoint option;
    (*

    The connection endpoint for the DB instance.

    The endpoint might not be shown for instances with the status of creating.

    *)
  86. db_name : string_ option;
    (*

    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.

    *)
  87. master_username : string_ option;
    (*

    The master username for the DB instance.

    *)
  88. db_instance_status : string_ option;
    (*

    The current state of this database.

    For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

    *)
  89. engine : string_ option;
    (*

    The database engine used for this DB instance.

    *)
  90. db_instance_class : string_ option;
    (*

    The name of the compute and memory capacity class of the DB instance.

    *)
  91. db_instance_identifier : string_ option;
    (*

    The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

    *)
}

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.

type nonrec switchover_read_replica_result = {
  1. db_instance : db_instance option;
}
type nonrec switchover_read_replica_message = {
  1. db_instance_identifier : string_;
    (*

    The DB instance identifier of the current standby database. This value is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing Oracle read replica DB instance.
    *)
}
type nonrec invalid_db_instance_state_fault = {
  1. message : exception_message option;
}

The DB instance isn't in a valid state.

type nonrec db_instance_not_found_fault = {
  1. message : exception_message option;
}

DBInstanceIdentifier doesn't refer to an existing DB instance.

type nonrec global_cluster_identifier = string
type nonrec readers_arn_list = string_ list
type nonrec global_cluster_member_synchronization_status =
  1. | PENDING_RESYNC
  2. | CONNECTED
type nonrec global_cluster_member = {
  1. synchronization_status : global_cluster_member_synchronization_status option;
    (*

    The status of synchronization of each Aurora DB cluster in the global cluster.

    *)
  2. global_write_forwarding_status : write_forwarding_status option;
    (*

    The status of write forwarding for a secondary cluster in the global cluster.

    *)
  3. is_writer : boolean_ option;
    (*

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

    *)
  4. readers : readers_arn_list option;
    (*

    The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.

    *)
  5. db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

    *)
}

A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).

type nonrec global_cluster_member_list = global_cluster_member list
type nonrec failover_status =
  1. | CANCELLING
  2. | FAILING_OVER
  3. | PENDING
type nonrec failover_state = {
  1. is_data_loss_allowed : boolean_ option;
    (*

    Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

    *)
  2. to_db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

    *)
  3. from_db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

    *)
  4. status : failover_status option;
    (*

    The current status of the global cluster. Possible values are as follows:

    • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
    • failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.
    • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
    • switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.
    *)
}

Contains the state of scheduled or in-process operations on a global cluster (Aurora global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Aurora global database.

type nonrec global_cluster = {
  1. tag_list : tag_list option;
  2. failover_state : failover_state option;
    (*

    A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

    *)
  3. endpoint : string_ option;
    (*

    The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.

    *)
  4. global_cluster_members : global_cluster_member_list option;
    (*

    The list of primary and secondary clusters within the global database cluster.

    *)
  5. deletion_protection : boolean_optional option;
    (*

    The deletion protection setting for the new global database cluster.

    *)
  6. storage_encryption_type : storage_encryption_type option;
    (*

    The type of encryption used to protect data at rest in the global database cluster. Possible values:

    • none - The global database cluster is not encrypted.
    • sse-rds - The global database cluster is encrypted using an Amazon Web Services owned KMS key.
    • sse-kms - The global database cluster is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
    *)
  7. storage_encrypted : boolean_optional option;
    (*

    The storage encryption setting for the global database cluster.

    *)
  8. database_name : string_ option;
    (*

    The default database name within the new global database cluster.

    *)
  9. engine_lifecycle_support : string_ option;
    (*

    The lifecycle type for the global cluster.

    For more information, see CreateGlobalCluster.

    *)
  10. engine_version : string_ option;
    (*

    Indicates the database engine version.

    *)
  11. engine : string_ option;
    (*

    The Aurora database engine used by the global database cluster.

    *)
  12. status : string_ option;
    (*

    Specifies the current state of this global database cluster.

    *)
  13. global_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the global database cluster.

    *)
  14. global_cluster_resource_id : string_ option;
    (*

    The Amazon Web Services partition-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.

    *)
  15. global_cluster_identifier : global_cluster_identifier option;
    (*

    Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

    *)
}

A data type representing an Aurora global database.

type nonrec switchover_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec db_cluster_identifier = string
type nonrec switchover_global_cluster_message = {
  1. target_db_cluster_identifier : db_cluster_identifier;
    (*

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

    *)
  2. global_cluster_identifier : global_cluster_identifier;
    (*

    The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing global database cluster (Aurora global database).
    *)
}
type nonrec invalid_global_cluster_state_fault = {
  1. message : exception_message option;
}

The global cluster is in an invalid state and can't perform the requested operation.

type nonrec invalid_db_cluster_state_fault = {
  1. message : exception_message option;
}

The requested operation can't be performed while the cluster is in this state.

type nonrec global_cluster_not_found_fault = {
  1. message : exception_message option;
}

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

type nonrec db_cluster_not_found_fault = {
  1. message : exception_message option;
}

DBClusterIdentifier doesn't refer to an existing DB cluster.

type nonrec switchover_detail_status = string
type nonrec database_arn = string
type nonrec switchover_detail = {
  1. status : switchover_detail_status option;
    (*

    The switchover status of a resource in a blue/green deployment.

    Values:

    • PROVISIONING - The resource is being prepared to switch over.
    • AVAILABLE - The resource is ready to switch over.
    • SWITCHOVER_IN_PROGRESS - The resource is being switched over.
    • SWITCHOVER_COMPLETED - The resource has been switched over.
    • SWITCHOVER_FAILED - The resource attempted to switch over but failed.
    • MISSING_SOURCE - The source resource has been deleted.
    • MISSING_TARGET - The target resource has been deleted.
    *)
  2. target_member : database_arn option;
    (*

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

    *)
  3. source_member : database_arn option;
    (*

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

    *)
}

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

type nonrec switchover_detail_list = switchover_detail list
type nonrec blue_green_deployment_identifier = string
type nonrec blue_green_deployment_name = string
type nonrec blue_green_deployment_task_name = string
type nonrec blue_green_deployment_task_status = string
type nonrec blue_green_deployment_task = {
  1. status : blue_green_deployment_task_status option;
    (*

    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.
    *)
  2. name : blue_green_deployment_task_name option;
    (*

    The name of the blue/green deployment task.

    *)
}

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.

type nonrec blue_green_deployment_task_list = blue_green_deployment_task list
type nonrec blue_green_deployment_status = string
type nonrec blue_green_deployment_status_details = string
type nonrec blue_green_deployment = {
  1. tag_list : tag_list option;
  2. delete_time : t_stamp option;
    (*

    The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

    *)
  3. create_time : t_stamp option;
    (*

    The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

    *)
  4. status_details : blue_green_deployment_status_details option;
    (*

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

    *)
  5. status : blue_green_deployment_status option;
    (*

    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.
    *)
  6. tasks : blue_green_deployment_task_list option;
    (*

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

    *)
  7. switchover_details : switchover_detail_list option;
    (*

    The details about each source and target resource in the blue/green deployment.

    *)
  8. target : database_arn option;
    (*

    The target database for the blue/green deployment.

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

    *)
  9. source : database_arn option;
    (*

    The source database for the blue/green deployment.

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

    *)
  10. blue_green_deployment_name : blue_green_deployment_name option;
    (*

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

    *)
  11. blue_green_deployment_identifier : blue_green_deployment_identifier option;
    (*

    The unique identifier of the blue/green deployment.

    *)
}

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.

type nonrec switchover_blue_green_deployment_response = {
  1. blue_green_deployment : blue_green_deployment option;
}
type nonrec switchover_blue_green_deployment_request = {
  1. switchover_timeout : switchover_timeout option;
    (*

    The amount of time, in seconds, for the switchover to complete.

    Default: 300

    If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.

    *)
  2. blue_green_deployment_identifier : blue_green_deployment_identifier;
    (*

    The resource ID of the blue/green deployment.

    Constraints:

    • Must match an existing blue/green deployment resource ID.
    *)
}
type nonrec invalid_blue_green_deployment_state_fault = {
  1. message : exception_message option;
}

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.

type nonrec blue_green_deployment_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec supported_timezones_list = timezone list
type nonrec lifecycle_support_name =
  1. | OPEN_SOURCE_RDS_EXTENDED_SUPPORT
  2. | OPEN_SOURCE_RDS_STANDARD_SUPPORT
type nonrec supported_engine_lifecycle = {
  1. lifecycle_support_end_date : t_stamp;
    (*

    The end date for the type of support returned by LifecycleSupportName.

    *)
  2. lifecycle_support_start_date : t_stamp;
    (*

    The start date for the type of support returned by LifecycleSupportName.

    *)
  3. lifecycle_support_name : lifecycle_support_name;
    (*

    The type of lifecycle support that the engine version is in.

    This parameter returns the following values:

    • open-source-rds-standard-support - Indicates RDS standard support or Aurora standard support.
    • open-source-rds-extended-support - Indicates Amazon RDS Extended Support.

    For Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL, this parameter returns both open-source-rds-standard-support and open-source-rds-extended-support.

    For Amazon RDS for MariaDB, this parameter only returns the value open-source-rds-standard-support.

    For information about Amazon RDS Extended Support, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide and Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide.

    *)
}

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

You can use the information that this data type returns to plan for upgrades.

This data type only returns information for the open source engines Amazon RDS for MariaDB, Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL.

type nonrec supported_engine_lifecycle_list = supported_engine_lifecycle list
type nonrec character_set = {
  1. character_set_description : string_ option;
    (*

    The description of the character set.

    *)
  2. character_set_name : string_ option;
    (*

    The name of the character set.

    *)
}

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

type nonrec supported_character_sets_list = character_set list
type nonrec subscription_not_found_fault = {
  1. message : exception_message option;
}

The subscription name does not exist.

type nonrec subscription_category_not_found_fault = {
  1. message : exception_message option;
}

The supplied category does not exist.

type nonrec subscription_already_exist_fault = {
  1. message : exception_message option;
}

The supplied subscription name already exists.

type nonrec subnet_identifier_list = string_ list
type nonrec subnet_already_in_use = {
  1. message : exception_message option;
}

The DB subnet is already in use in the Availability Zone.

type nonrec string255 = string
type nonrec storage_type_not_supported_fault = {
  1. message : exception_message option;
}

The specified StorageType can't be associated with the DB instance.

type nonrec storage_type_not_available_fault = {
  1. message : exception_message option;
}

The aurora-iopt1 storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago.

type nonrec storage_quota_exceeded_fault = {
  1. message : exception_message option;
}

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

type nonrec stop_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec stop_db_instance_message = {
  1. db_snapshot_identifier : string_ option;
    (*

    The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

    *)
  2. db_instance_identifier : string_;
    (*

    The user-supplied instance identifier.

    *)
}
type nonrec restore_window = {
  1. latest_time : t_stamp option;
    (*

    The latest time you can restore an instance to.

    *)
  2. earliest_time : t_stamp option;
    (*

    The earliest time you can restore an instance to.

    *)
}

Earliest and latest time an instance can be restored to:

type nonrec db_instance_automated_backup = {
  1. additional_storage_volumes : additional_storage_volumes_list option;
    (*

    The additional storage volumes associated with the automated backup.

    Valid Values: GP3 | IO2

    *)
  2. dedicated_log_volume : boolean_optional option;
    (*

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

    *)
  3. tag_list : tag_list option;
  4. aws_backup_recovery_point_arn : string_ option;
    (*

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

    *)
  5. multi_tenant : boolean_optional option;
    (*

    Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

    *)
  6. backup_target : string_ option;
    (*

    The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

    *)
  7. db_instance_automated_backups_replications : db_instance_automated_backups_replication_list option;
    (*

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

    *)
  8. db_instance_automated_backups_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the replicated automated backups.

    *)
  9. preferred_backup_window : string_ option;
    (*

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  10. backup_retention_period : integer_optional option;
    (*

    The retention period for the automated backups.

    *)
  11. iam_database_authentication_enabled : boolean_ option;
    (*

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

    *)
  12. timezone : string_ option;
    (*

    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.

    *)
  13. kms_key_id : string_ option;
    (*

    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.

    *)
  14. storage_type : string_ option;
    (*

    The storage type associated with the automated backup.

    *)
  15. storage_encryption_type : storage_encryption_type option;
    (*

    The type of encryption used to protect data at rest in the automated backup. Possible values:

    • none - The automated backup is not encrypted.
    • sse-rds - The automated backup is encrypted using an Amazon Web Services owned KMS key.
    • sse-kms - The automated backup is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
    *)
  16. encrypted : boolean_ option;
    (*

    Indicates whether the automated backup is encrypted.

    *)
  17. tde_credential_arn : string_ option;
    (*

    The ARN from the key store with which the automated backup is associated for TDE encryption.

    *)
  18. option_group_name : string_ option;
    (*

    The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

    *)
  19. storage_throughput : integer_optional option;
    (*

    The storage throughput for the automated backup.

    *)
  20. iops : integer_optional option;
    (*

    The IOPS (I/O operations per second) value for the automated backup.

    *)
  21. license_model : string_ option;
    (*

    The license model information for the automated backup.

    *)
  22. engine_version : string_ option;
    (*

    The version of the database engine for the automated backup.

    *)
  23. engine : string_ option;
    (*

    The name of the database engine for this automated backup.

    *)
  24. master_username : string_ option;
    (*

    The master user name of an automated backup.

    *)
  25. instance_create_time : t_stamp option;
    (*

    The date and time when the DB instance was created.

    *)
  26. vpc_id : string_ option;
    (*

    The VPC ID associated with the DB instance.

    *)
  27. availability_zone : string_ option;
    (*

    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.

    *)
  28. port : integer option;
    (*

    The port number that the automated backup used for connections.

    Default: Inherits from the source DB instance

    Valid Values: 1150-65535

    *)
  29. status : string_ option;
    (*

    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.
    *)
  30. allocated_storage : integer option;
    (*

    The allocated storage size for the automated backup in gibibytes (GiB).

    *)
  31. restore_window : restore_window option;
    (*

    The earliest and latest time a DB instance can be restored to.

    *)
  32. db_instance_identifier : string_ option;
    (*

    The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    *)
  33. region : string_ option;
    (*

    The Amazon Web Services Region associated with the automated backup.

    *)
  34. dbi_resource_id : string_ option;
    (*

    The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    *)
  35. db_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the automated backups.

    *)
}

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.

type nonrec stop_db_instance_automated_backups_replication_result = {
  1. db_instance_automated_backup : db_instance_automated_backup option;
}
type nonrec stop_db_instance_automated_backups_replication_message = {
  1. source_db_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automate backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

    *)
}
type nonrec snapshot_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec db_snapshot_already_exists_fault = {
  1. message : exception_message option;
}

DBSnapshotIdentifier is already used by an existing snapshot.

type nonrec availability_zones = string_ list
type nonrec db_cluster_option_group_status = {
  1. status : string_ option;
    (*

    Specifies the status of the DB cluster option group.

    *)
  2. db_cluster_option_group_name : string_ option;
    (*

    Specifies the name of the DB cluster option group.

    *)
}

Contains status information for a DB cluster option group.

type nonrec db_cluster_option_group_memberships = db_cluster_option_group_status list
type nonrec read_replica_identifier_list = string_ list
type nonrec db_cluster_status_info = {
  1. message : string_ option;
    (*

    Reserved for future use.

    *)
  2. status : string_ option;
    (*

    Reserved for future use.

    *)
  3. normal : boolean_ option;
    (*

    Reserved for future use.

    *)
  4. status_type : string_ option;
    (*

    Reserved for future use.

    *)
}

Reserved for future use.

type nonrec db_cluster_status_info_list = db_cluster_status_info list
type nonrec db_cluster_member = {
  1. promotion_tier : integer_optional option;
    (*

    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.

    *)
  2. db_cluster_parameter_group_status : string_ option;
    (*

    Specifies the status of the DB cluster parameter group for this member of the DB cluster.

    *)
  3. is_cluster_writer : boolean_ option;
    (*

    Indicates whether the cluster member is the primary DB instance for the DB cluster.

    *)
  4. db_instance_identifier : string_ option;
    (*

    Specifies the instance identifier for this member of the DB cluster.

    *)
}

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

type nonrec db_cluster_member_list = db_cluster_member list
type nonrec db_cluster_role = {
  1. feature_name : string_ option;
    (*

    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.

    *)
  2. status : string_ option;
    (*

    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.
    *)
  3. role_arn : string_ option;
    (*

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

    *)
}

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

type nonrec db_cluster_roles = db_cluster_role list
type nonrec long_optional = Smaws_Lib.CoreTypes.Int64.t
type nonrec rds_custom_cluster_configuration = {
  1. replica_mode : replica_mode option;
    (*

    Reserved for future use.

    *)
  2. transit_gateway_multicast_domain_id : string_ option;
    (*

    Reserved for future use.

    *)
  3. interconnect_subnet_id : string_ option;
    (*

    Reserved for future use.

    *)
}

Reserved for future use.

type nonrec cluster_pending_modified_values = {
  1. certificate_details : certificate_details option;
  2. iops : integer_optional option;
    (*

    The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    *)
  3. rds_custom_cluster_configuration : rds_custom_cluster_configuration option;
    (*

    Reserved for future use.

    *)
  4. allocated_storage : integer_optional option;
    (*

    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.

    *)
  5. storage_type : string_ option;
    (*

    The storage type for the DB cluster.

    *)
  6. backup_retention_period : integer_optional option;
    (*

    The number of days for which automatic DB snapshots are retained.

    *)
  7. engine_version : string_ option;
    (*

    The database engine version.

    *)
  8. iam_database_authentication_enabled : boolean_optional option;
    (*

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

    *)
  9. master_user_password : sensitive_string option;
    (*

    The master credentials for the DB cluster.

    *)
  10. db_cluster_identifier : string_ option;
    (*

    The DBClusterIdentifier value for the DB cluster.

    *)
  11. pending_cloudwatch_logs_exports : pending_cloudwatch_logs_exports option;
}

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.

type nonrec scaling_configuration_info = {
  1. seconds_before_timeout : integer_optional option;
    (*

    The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

    *)
  2. timeout_action : string_ option;
    (*

    The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is 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.

    *)
  3. seconds_until_auto_pause : integer_optional option;
    (*

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

    *)
  4. auto_pause : boolean_optional option;
    (*

    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.

    *)
  5. max_capacity : integer_optional option;
    (*

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

    *)
  6. min_capacity : integer_optional option;
    (*

    The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

    *)
}

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.

type nonrec double_optional = float
type nonrec serverless_v2_scaling_configuration_info = {
  1. seconds_until_auto_pause : integer_optional option;
    (*

    The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again.

    This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.

    *)
  2. max_capacity : double_optional option;
    (*

    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 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.

    *)
  3. min_capacity : double_optional option;
    (*

    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. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.

    *)
}

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.

type nonrec local_write_forwarding_status =
  1. | REQUESTED
  2. | DISABLING
  3. | ENABLING
  4. | DISABLED
  5. | ENABLED
type nonrec limitless_database_status =
  1. | ERROR
  2. | MODIFYING_MAX_CAPACITY
  3. | DISABLING
  4. | ENABLING
  5. | DISABLED
  6. | ENABLED
  7. | NOT_IN_USE
  8. | ACTIVE
type nonrec limitless_database = {
  1. min_required_ac_u : double_optional option;
    (*

    The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).

    *)
  2. status : limitless_database_status option;
    (*

    The status of Aurora Limitless Database.

    *)
}

Contains details for Aurora Limitless Database.

type nonrec cluster_scalability_type =
  1. | LIMITLESS
  2. | STANDARD
type nonrec db_cluster = {
  1. internet_access_gateway_enabled : boolean_optional option;
    (*

    Indicates whether the DB cluster has internet-based connectivity enabled through an internet access gateway.

    This setting is applicable only for Aurora PostgreSQL clusters created through express configuration.

    *)
  2. vpc_networking_enabled : boolean_optional option;
    (*

    Indicates whether the DB cluster uses VPC-based networking.

    This setting is applicable only for Aurora PostgreSQL clusters created through express configuration.

    *)
  3. engine_lifecycle_support : string_ option;
    (*

    The lifecycle type for the DB cluster.

    For more information, see CreateDBCluster.

    *)
  4. certificate_details : certificate_details option;
  5. cluster_scalability_type : cluster_scalability_type option;
    (*

    The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.

    *)
  6. limitless_database : limitless_database option;
    (*

    The details for Aurora Limitless Database.

    *)
  7. aws_backup_recovery_point_arn : string_ option;
    (*

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

    *)
  8. local_write_forwarding_status : local_write_forwarding_status option;
    (*

    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

    *)
  9. master_user_secret : master_user_secret option;
    (*

    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.

    *)
  10. db_system_id : string_ option;
    (*

    Reserved for future use.

    *)
  11. performance_insights_retention_period : integer_optional option;
    (*

    The number of days to retain Performance Insights data.

    This setting is only for Aurora DB clusters and 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

    *)
  12. performance_insights_kms_key_id : string_ option;
    (*

    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 Aurora DB clusters and Multi-AZ DB clusters.

    *)
  13. performance_insights_enabled : boolean_optional option;
    (*

    Indicates whether Performance Insights is enabled for the DB cluster.

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

    *)
  14. database_insights_mode : database_insights_mode option;
    (*

    The mode of Database Insights that is enabled for the DB cluster.

    *)
  15. monitoring_role_arn : string_ option;
    (*

    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

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

    *)
  16. monitoring_interval : integer_optional option;
    (*

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

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

    *)
  17. serverless_v2_platform_version : string_ option;
    (*

    The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.

    *)
  18. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration_info option;
  19. automatic_restart_time : t_stamp option;
    (*

    The time when a stopped DB cluster is restarted automatically.

    *)
  20. network_type : string_ option;
    (*

    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

    *)
  21. global_write_forwarding_requested : boolean_optional option;
    (*

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

    *)
  22. global_write_forwarding_status : write_forwarding_status option;
    (*

    The status of write forwarding for a secondary cluster in an Aurora global database.

    *)
  23. global_cluster_identifier : global_cluster_identifier option;
    (*

    Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

    *)
  24. tag_list : tag_list option;
  25. domain_memberships : domain_membership_list option;
    (*

    The Active Directory Domain membership records associated with the DB cluster.

    *)
  26. cross_account_clone : boolean_optional option;
    (*

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

    *)
  27. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  28. activity_stream_kinesis_stream_name : string_ option;
    (*

    The name of the Amazon Kinesis data stream used for the database activity stream.

    *)
  29. activity_stream_kms_key_id : string_ option;
    (*

    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.

    *)
  30. activity_stream_status : activity_stream_status option;
    (*

    The status of the database activity stream.

    *)
  31. activity_stream_mode : activity_stream_mode option;
    (*

    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.

    *)
  32. http_endpoint_enabled : boolean_optional option;
    (*

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

    When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

    For more information, see Using RDS Data API in the Amazon Aurora User Guide.

    *)
  33. deletion_protection : boolean_optional option;
    (*

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

    *)
  34. auto_minor_version_upgrade : boolean_ option;
    (*

    Indicates whether minor version patches are applied automatically.

    This setting is for Aurora DB clusters and Multi-AZ DB clusters.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  35. publicly_accessible : boolean_optional option;
    (*

    Indicates whether the DB cluster is publicly accessible.

    When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. 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.

    *)
  36. io_optimized_next_allowed_modification_time : t_stamp option;
    (*

    The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

    This setting is only for Aurora DB clusters.

    *)
  37. storage_throughput : integer_optional option;
    (*

    The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

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

    *)
  38. iops : integer_optional option;
    (*

    The Provisioned IOPS (I/O operations per second) value.

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

    *)
  39. storage_type : string_ option;
    (*

    The storage type associated with the DB cluster.

    *)
  40. db_cluster_instance_class : string_ option;
    (*

    The name of the compute and memory capacity class of the DB instance.

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

    *)
  41. rds_custom_cluster_configuration : rds_custom_cluster_configuration option;
    (*

    Reserved for future use.

    *)
  42. scaling_configuration_info : scaling_configuration_info option;
  43. engine_mode : string_ option;
    (*

    The DB engine mode of the DB cluster, either provisioned or serverless.

    For more information, see CreateDBCluster.

    *)
  44. pending_modified_values : cluster_pending_modified_values option;
    (*

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

    *)
  45. capacity : integer_optional option;
    (*

    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.

    *)
  46. enabled_cloudwatch_logs_exports : log_type_list option;
    (*

    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.

    *)
  47. backtrack_consumed_change_records : long_optional option;
    (*

    The number of change records stored for Backtrack.

    *)
  48. backtrack_window : long_optional option;
    (*

    The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

    *)
  49. earliest_backtrack_time : t_stamp option;
    (*

    The earliest time to which a DB cluster can be backtracked.

    *)
  50. cluster_create_time : t_stamp option;
    (*

    The time when the DB cluster was created, in Universal Coordinated Time (UTC).

    *)
  51. clone_group_id : string_ option;
    (*

    The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.

    If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.

    For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.

    *)
  52. iam_database_authentication_enabled : boolean_optional option;
    (*

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

    *)
  53. associated_roles : db_cluster_roles option;
    (*

    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.

    *)
  54. db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB cluster.

    *)
  55. db_cluster_resource_id : string_ option;
    (*

    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.

    *)
  56. kms_key_id : string_ option;
    (*

    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.

    *)
  57. storage_encryption_type : storage_encryption_type option;
    (*

    The type of encryption used to protect data at rest in the DB cluster. Possible values:

    • none - The DB cluster is not encrypted.
    • sse-rds - The DB cluster is encrypted using an Amazon Web Services owned KMS key.
    • sse-kms - The DB cluster is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
    *)
  58. storage_encrypted : boolean_ option;
    (*

    Indicates whether the DB cluster is encrypted.

    *)
  59. hosted_zone_id : string_ option;
    (*

    The ID that Amazon Route 53 assigns when you create a hosted zone.

    *)
  60. vpc_security_groups : vpc_security_group_membership_list option;
    (*

    The list of VPC security groups that the DB cluster belongs to.

    *)
  61. db_cluster_members : db_cluster_member_list option;
    (*

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

    *)
  62. status_infos : db_cluster_status_info_list option;
    (*

    Reserved for future use.

    *)
  63. read_replica_identifiers : read_replica_identifier_list option;
    (*

    Contains one or more identifiers of the read replicas associated with this DB cluster.

    *)
  64. replication_source_identifier : string_ option;
    (*

    The identifier of the source DB cluster if this DB cluster is a read replica.

    *)
  65. upgrade_rollout_order : upgrade_rollout_order option;
    (*

    This data type represents the order in which the clusters are upgraded.

    • [first] - Typically used for development or testing environments.
    • [second] - Default order for resources not specifically configured.
    • [last] - Usually reserved for production environments.
    *)
  66. preferred_maintenance_window : string_ option;
    (*

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    *)
  67. preferred_backup_window : string_ option;
    (*

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  68. db_cluster_option_group_memberships : db_cluster_option_group_memberships option;
    (*

    The list of option group memberships for this DB cluster.

    *)
  69. master_username : string_ option;
    (*

    The master username for the DB cluster.

    *)
  70. port : integer_optional option;
    (*

    The port that the database engine is listening on.

    *)
  71. latest_restorable_time : t_stamp option;
    (*

    The latest time to which a database can be restored with point-in-time restore.

    *)
  72. engine_version : string_ option;
    (*

    The version of the database engine.

    *)
  73. engine : string_ option;
    (*

    The database engine used for this DB cluster.

    *)
  74. multi_a_z : boolean_optional option;
    (*

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

    *)
  75. custom_endpoints : string_list option;
    (*

    The custom endpoints associated with the DB cluster.

    *)
  76. reader_endpoint : string_ option;
    (*

    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.

    *)
  77. endpoint : string_ option;
    (*

    The connection endpoint for the primary instance of the DB cluster.

    *)
  78. earliest_restorable_time : t_stamp option;
    (*

    The earliest time to which a database can be restored with point-in-time restore.

    *)
  79. percent_progress : string_ option;
    (*

    The progress of the operation as a percentage.

    *)
  80. status : string_ option;
    (*

    The current state of this DB cluster.

    *)
  81. db_subnet_group : string_ option;
    (*

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

    *)
  82. db_cluster_parameter_group : string_ option;
    (*

    The name of the DB cluster parameter group for the DB cluster.

    *)
  83. db_cluster_identifier : string_ option;
    (*

    The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

    *)
  84. database_name : string_ option;
    (*

    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.

    *)
  85. character_set_name : string_ option;
    (*

    If present, specifies the name of the character set that this cluster is associated with.

    *)
  86. backup_retention_period : integer_optional option;
    (*

    The number of days for which automatic DB snapshots are retained.

    *)
  87. availability_zones : availability_zones option;
    (*

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

    *)
  88. allocated_storage : integer_optional option;
    (*

    AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage can vary because Aurora DB cluster storage size adjusts as needed.

    *)
}

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.

type nonrec stop_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec stop_db_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

    The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

    *)
}
type nonrec invalid_db_shard_group_state_fault = {
  1. message : exception_message option;
}

The DB shard group must be in the available state.

type nonrec stop_activity_stream_response = {
  1. status : activity_stream_status option;
    (*

    The status of the database activity stream.

    *)
  2. kinesis_stream_name : string_ option;
    (*

    The name of the Amazon Kinesis data stream used for the database activity stream.

    *)
  3. kms_key_id : string_ option;
    (*

    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.

    *)
}
type nonrec stop_activity_stream_request = {
  1. apply_immediately : boolean_optional option;
    (*

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

    *)
  2. resource_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

    *)
}
type nonrec resource_not_found_fault = {
  1. message : exception_message option;
}

The specified resource ID was not found.

type nonrec start_export_task_message = {
  1. export_only : string_list option;
    (*

    The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

    Valid Values:

    • database - Export all the data from a specified database.
    • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
    • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
    • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
    *)
  2. s3_prefix : string_ option;
    (*

    The Amazon S3 bucket prefix to use as the file name and path of the exported data.

    *)
  3. kms_key_id : string_;
    (*

    The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

    • kms:CreateGrant
    • kms:DescribeKey
    *)
  4. iam_role_arn : string_;
    (*

    The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.

    In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:

    • s3:PutObject*
    • s3:GetObject*
    • s3:ListBucket
    • s3:DeleteObject*
    • s3:GetBucketLocation

    In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:

    • arn:aws:s3:::{i your-s3-bucket} 
    • arn:aws:s3:::{i your-s3-bucket}/*
    *)
  5. s3_bucket_name : string_;
    (*

    The name of the Amazon S3 bucket to export the snapshot or cluster data to.

    *)
  6. source_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

    *)
  7. export_task_identifier : string_;
    (*

    A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.

    *)
}
type nonrec kms_key_not_accessible_fault = {
  1. message : exception_message option;
}

An error occurred accessing an Amazon Web Services KMS key.

type nonrec invalid_s3_bucket_fault = {
  1. message : exception_message option;
}

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.

type nonrec invalid_export_source_state_fault = {
  1. message : exception_message option;
}

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

type nonrec invalid_export_only_fault = {
  1. message : exception_message option;
}

The export is invalid for exporting to an Amazon S3 bucket.

type nonrec iam_role_not_found_fault = {
  1. message : exception_message option;
}

The IAM role is missing for exporting to an Amazon S3 bucket.

type nonrec iam_role_missing_permissions_fault = {
  1. message : exception_message option;
}

The IAM role requires additional permissions to export to an Amazon S3 bucket.

type nonrec export_task_already_exists_fault = {
  1. message : exception_message option;
}

You can't start an export task that's already running.

type nonrec db_snapshot_not_found_fault = {
  1. message : exception_message option;
}

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

type nonrec db_cluster_snapshot_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec export_source_type =
  1. | CLUSTER
  2. | SNAPSHOT
type nonrec export_task = {
  1. source_type : export_source_type option;
    (*

    The type of source for the export.

    *)
  2. warning_message : string_ option;
    (*

    A warning about the snapshot or cluster export task.

    *)
  3. failure_cause : string_ option;
    (*

    The reason the export failed, if it failed.

    *)
  4. total_extracted_data_in_g_b : integer option;
    (*

    The total amount of data exported, in gigabytes.

    *)
  5. percent_progress : integer option;
    (*

    The progress of the snapshot or cluster export task as a percentage.

    *)
  6. status : string_ option;
    (*

    The progress status of the export task. The status can be one of the following:

    • CANCELED
    • CANCELING
    • COMPLETE
    • FAILED
    • IN_PROGRESS
    • STARTING
    *)
  7. kms_key_id : string_ option;
    (*

    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.

    *)
  8. iam_role_arn : string_ option;
    (*

    The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

    *)
  9. s3_prefix : string_ option;
    (*

    The Amazon S3 bucket prefix that is the file name and path of the exported data.

    *)
  10. s3_bucket : string_ option;
    (*

    The Amazon S3 bucket where the snapshot or cluster is exported to.

    *)
  11. task_end_time : t_stamp option;
    (*

    The time when the snapshot or cluster export task ended.

    *)
  12. task_start_time : t_stamp option;
    (*

    The time when the snapshot or cluster export task started.

    *)
  13. snapshot_time : t_stamp option;
    (*

    The time when the snapshot was created.

    *)
  14. export_only : string_list option;
    (*

    The data exported from the snapshot or cluster.

    Valid Values:

    • database - Export all the data from a specified database.
    • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
    • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
    • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
    *)
  15. source_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

    *)
  16. export_task_identifier : string_ option;
    (*

    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.

    *)
}

Contains the details of a snapshot or cluster export to Amazon S3.

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

type nonrec start_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec start_db_instance_message = {
  1. db_instance_identifier : string_;
    (*

    The user-supplied instance identifier.

    *)
}
type nonrec start_db_instance_automated_backups_replication_result = {
  1. db_instance_automated_backup : db_instance_automated_backup option;
}
type nonrec start_db_instance_automated_backups_replication_message = {
  1. tags : tag_list option;
    (*

    A list of tags to associate with the replicated automated backups.

    *)
  2. pre_signed_url : sensitive_string option;
    (*

    In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.

    This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

    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.

    If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

    *)
  3. kms_key_id : string_ option;
    (*

    The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

    *)
  4. backup_retention_period : integer_optional option;
    (*

    The retention period for the replicated automated backups.

    *)
  5. source_db_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

    *)
}
type nonrec invalid_db_instance_automated_backup_state_fault = {
  1. message : exception_message option;
}

The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.

type nonrec db_instance_automated_backup_quota_exceeded_fault = {
  1. message : exception_message option;
}

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.

type nonrec invalid_vpc_network_state_fault = {
  1. message : exception_message option;
}

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

type nonrec invalid_subnet = {
  1. message : exception_message option;
}

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

type nonrec insufficient_db_instance_capacity_fault = {
  1. message : exception_message option;
}

The specified DB instance class isn't available in the specified Availability Zone.

type nonrec db_subnet_group_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec db_subnet_group_does_not_cover_enough_a_zs = {
  1. message : exception_message option;
}

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

type nonrec authorization_not_found_fault = {
  1. message : exception_message option;
}

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.

type nonrec start_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec start_db_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

    The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.

    *)
}
type nonrec start_activity_stream_response = {
  1. apply_immediately : boolean_ option;
    (*

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

    *)
  2. engine_native_audit_fields_included : boolean_optional option;
    (*

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

    *)
  3. mode : activity_stream_mode option;
    (*

    The mode of the database activity stream.

    *)
  4. status : activity_stream_status option;
    (*

    The status of the database activity stream.

    *)
  5. kinesis_stream_name : string_ option;
    (*

    The name of the Amazon Kinesis data stream to be used for the database activity stream.

    *)
  6. kms_key_id : string_ option;
    (*

    The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

    *)
}
type nonrec start_activity_stream_request = {
  1. engine_native_audit_fields_included : boolean_optional option;
    (*

    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.

    *)
  2. apply_immediately : boolean_optional option;
    (*

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

    *)
  3. kms_key_id : string_;
    (*

    The Amazon Web Services KMS key identifier 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.

    *)
  4. mode : activity_stream_mode;
    (*

    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.

    *)
  5. resource_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

    *)
}
type nonrec source_type =
  1. | Zero_etl
  2. | Db_shard_group
  3. | Blue_green_deployment
  4. | Db_proxy
  5. | Custom_engine_version
  6. | Db_cluster_snapshot
  7. | Db_cluster
  8. | Db_snapshot
  9. | Db_security_group
  10. | Db_parameter_group
  11. | Db_instance
type nonrec source_region = {
  1. supports_db_instance_automated_backups_replication : boolean_ option;
    (*

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

    *)
  2. status : string_ option;
    (*

    The status of the source Amazon Web Services Region.

    *)
  3. endpoint : string_ option;
    (*

    The endpoint for the source Amazon Web Services Region endpoint.

    *)
  4. region_name : string_ option;
    (*

    The name of the source Amazon Web Services Region.

    *)
}

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

type nonrec source_region_list = source_region list
type nonrec source_region_message = {
  1. source_regions : source_region_list option;
    (*

    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.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec source_not_found_fault = {
  1. message : exception_message option;
}

The requested source could not be found.

type nonrec source_ids_list = string_ list
type nonrec source_database_not_supported_fault = {
  1. message : exception_message option;
}

The source DB instance isn't supported for a blue/green deployment.

type nonrec source_cluster_not_supported_fault = {
  1. message : exception_message option;
}

The source DB cluster isn't supported for a blue/green deployment.

type nonrec source_arn = string
type nonrec shared_snapshot_quota_exceeded_fault = {
  1. message : exception_message option;
}

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

type nonrec serverless_v2_scaling_configuration = {
  1. seconds_until_auto_pause : integer_optional option;
    (*

    Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it.

    Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.

    *)
  2. max_capacity : double_optional option;
    (*

    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 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.

    *)
  3. min_capacity : double_optional option;
    (*

    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. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.

    *)
}

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.

type nonrec serverless_v2_features_support = {
  1. max_capacity : double_optional option;
    (*

    Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be 256 or 128.

    *)
  2. min_capacity : double_optional option;
    (*

    If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2.

    *)
}

Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions and platform versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.

type nonrec serverless_v2_platform_version_info = {
  1. is_default : boolean_ option;
    (*

    Indicates whether this platform version is the default version for the engine. The default platform version is the version used for new DB clusters.

    *)
  2. status : string_ option;
    (*

    The status of the serverless platform. Valid statuses are the following:

    • enabled - The platform version is in use.
    • disabled - The platform version is not in use.
    *)
  3. serverless_v2_features_support : serverless_v2_features_support option;
    (*

    Specifies any Aurora Serverless v2 properties or limits that differ between Aurora Serverless v2 platform versions. You can retrieve the platform version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.

    *)
  4. engine : string_ option;
    (*

    The name of the database engine.

    *)
  5. serverless_v2_platform_version_description : string_ option;
    (*

    The description of the serverless platform.

    *)
  6. serverless_v2_platform_version : string_ option;
    (*

    The version number of the serverless platform.

    *)
}

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

type nonrec serverless_v2_platform_version_list = serverless_v2_platform_version_info list
type nonrec serverless_v2_platform_versions_message = {
  1. serverless_v2_platform_versions : serverless_v2_platform_version_list option;
    (*

    A list of ServerlessV2PlatformVersionInfo elements.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec scaling_configuration = {
  1. seconds_before_timeout : integer_optional option;
    (*

    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.

    *)
  2. timeout_action : string_ option;
    (*

    The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

    ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

    RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

    If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.

    For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

    *)
  3. seconds_until_auto_pause : integer_optional option;
    (*

    The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

    Specify a value between 300 and 86,400 seconds.

    *)
  4. auto_pause : boolean_optional option;
    (*

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

    If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

    *)
  5. max_capacity : integer_optional option;
    (*

    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.

    *)
  6. min_capacity : integer_optional option;
    (*

    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.

    *)
}

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.

type nonrec scalar_reference_details = {
  1. value : double option;
    (*

    The value of a scalar reference.

    *)
}

The metric reference details when the reference is a scalar.

type nonrec sns_topic_arn_not_found_fault = {
  1. message : exception_message option;
}

The SNS topic ARN does not exist.

type nonrec sns_no_authorization_fault = {
  1. message : exception_message option;
}

You do not have permission to publish to the SNS topic ARN.

type nonrec sns_invalid_topic_fault = {
  1. message : exception_message option;
}

SNS has responded that there is a problem with the SNS topic specified.

type nonrec ec2_security_group = {
  1. ec2_security_group_owner_id : string_ option;
    (*

    Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

    *)
  2. ec2_security_group_id : string_ option;
    (*

    Specifies the id of the EC2 security group.

    *)
  3. ec2_security_group_name : string_ option;
    (*

    Specifies the name of the EC2 security group.

    *)
  4. status : string_ option;
    (*

    Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

    *)
}

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

  • AuthorizeDBSecurityGroupIngress
  • DescribeDBSecurityGroups
  • RevokeDBSecurityGroupIngress
type nonrec ec2_security_group_list = ec2_security_group list
type nonrec ip_range = {
  1. cidri_p : string_ option;
    (*

    The IP range.

    *)
  2. status : string_ option;
    (*

    The status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

    *)
}

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

type nonrec ip_range_list = ip_range list
type nonrec db_security_group = {
  1. db_security_group_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB security group.

    *)
  2. ip_ranges : ip_range_list option;
    (*

    Contains a list of IPRange elements.

    *)
  3. ec2_security_groups : ec2_security_group_list option;
    (*

    Contains a list of EC2SecurityGroup elements.

    *)
  4. vpc_id : string_ option;
    (*

    Provides the VpcId of the DB security group.

    *)
  5. db_security_group_description : string_ option;
    (*

    Provides the description of the DB security group.

    *)
  6. db_security_group_name : string_ option;
    (*

    Specifies the name of the DB security group.

    *)
  7. owner_id : string_ option;
    (*

    Provides the Amazon Web Services ID of the owner of a specific DB security group.

    *)
}

Contains the details for an Amazon RDS DB security group.

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

type nonrec revoke_db_security_group_ingress_result = {
  1. db_security_group : db_security_group option;
}
type nonrec revoke_db_security_group_ingress_message = {
  1. ec2_security_group_owner_id : string_ option;
    (*

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

    *)
  2. ec2_security_group_id : string_ option;
    (*

    The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    *)
  3. ec2_security_group_name : string_ option;
    (*

    The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    *)
  4. cidri_p : string_ option;
    (*

    The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.

    *)
  5. db_security_group_name : string_;
    (*

    The name of the DB security group to revoke ingress from.

    *)
}
type nonrec invalid_db_security_group_state_fault = {
  1. message : exception_message option;
}

The state of the DB security group doesn't allow deletion.

type nonrec db_security_group_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec restore_db_instance_to_point_in_time_result = {
  1. db_instance : db_instance option;
}
type nonrec restore_db_instance_to_point_in_time_message = {
  1. master_user_secret_kms_key_id : string_ option;
    (*

    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.

    *)
  2. manage_master_user_password : boolean_optional option;
    (*

    Specifies whether to manage the master user password with Amazon Web Services Secrets Manager in the restored DB instance.

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

    Constraints:

    • Applies to RDS for Oracle only.
    *)
  3. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB instance.

    Valid Values:

    • auto-backup - The DB instance's automated backup.
    *)
  4. additional_storage_volumes : additional_storage_volumes_list option;
    (*

    A list of additional storage volumes to restore to the DB instance. You can restore up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.

    *)
  5. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this DB instance.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

    You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.

    This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  6. ca_certificate_identifier : string_ option;
    (*

    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.

    *)
  7. dedicated_log_volume : boolean_optional option;
    (*

    Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

    *)
  8. preferred_backup_window : string_ option;
    (*

    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.
    *)
  9. backup_retention_period : integer_optional option;
    (*

    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.

    Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

    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.
    *)
  10. allocated_storage : integer_optional option;
    (*

    The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

    This setting isn't valid for RDS for SQL Server.

    Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

    *)
  11. custom_iam_instance_profile : string_ option;
    (*

    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.

    *)
  12. backup_target : string_ option;
    (*

    The location for storing automated backups and manual snapshots for the restored DB instance.

    Valid Values:

    • local (Dedicated Local Zone)
    • 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.

    *)
  13. source_db_instance_automated_backups_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

    This setting doesn't apply to RDS Custom.

    *)
  14. network_type : string_ option;
    (*

    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
    *)
  15. enable_customer_owned_ip : boolean_optional option;
    (*

    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.

    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.

    *)
  16. max_allocated_storage : integer_optional option;
    (*

    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.

    *)
  17. source_dbi_resource_id : string_ option;
    (*

    The resource ID of the source DB instance from which to restore.

    *)
  18. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  19. db_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group to associate with this DB instance.

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

    This setting doesn't apply to RDS Custom.

    Constraints:

    • If supplied, must match the name of an existing DB parameter group.
    • 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.
    *)
  20. use_default_processor_features : boolean_optional option;
    (*

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

    This setting doesn't apply to RDS Custom.

    *)
  21. processor_features : processor_feature_list option;
    (*

    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.

    *)
  22. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    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.

    *)
  23. enable_iam_database_authentication : boolean_optional option;
    (*

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

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

    *)
  24. domain_dns_ips : string_list option;
    (*

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

    Constraints:

    • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    Example: 123.124.125.126,234.235.236.237

    *)
  25. domain_auth_secret_arn : string_ option;
    (*

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

    Constraints:

    • Can't be longer than 64 characters.

    Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

    *)
  26. domain_ou : string_ option;
    (*

    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

    *)
  27. domain_fqdn : string_ option;
    (*

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

    Constraints:

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    *)
  28. domain_iam_role_name : string_ option;
    (*

    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.

    *)
  29. domain : string_ option;
    (*

    The Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

    This setting doesn't apply to RDS Custom.

    For more information, see Kerberos Authentication in the Amazon RDS User Guide.

    *)
  30. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    *)
  31. tde_credential_password : sensitive_string option;
    (*

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

    This setting doesn't apply to RDS Custom.

    *)
  32. tde_credential_arn : string_ option;
    (*

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

    This setting doesn't apply to RDS Custom.

    *)
  33. storage_type : string_ option;
    (*

    The storage type to associate with the DB instance.

    Valid Values: gp2 | gp3 | io1 | io2 | standard

    Default: io1, if the Iops parameter is specified. Otherwise, gp3.

    Constraints:

    • If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
    *)
  34. tags : tag_list option;
  35. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  36. option_group_name : string_ option;
    (*

    The name of the option group to use for the restored DB instance.

    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.

    *)
  37. storage_throughput : integer_optional option;
    (*

    The storage throughput value for the DB instance.

    This setting doesn't apply to RDS Custom or Amazon Aurora.

    *)
  38. iops : integer_optional option;
    (*

    The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

    This setting doesn't apply to SQL Server.

    Constraints:

    • Must be an integer greater than 1000.
    *)
  39. engine : string_ option;
    (*

    The database engine to use for the new instance.

    This setting doesn't apply to RDS Custom.

    Valid Values:

    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web

    Default: The same as source

    Constraints:

    • Must be compatible with the engine of the source.
    *)
  40. db_name : string_ option;
    (*

    The database name for the restored DB instance.

    This parameter doesn't apply to the following DB instances:

    • RDS Custom
    • RDS for Db2
    • RDS for MariaDB
    • RDS for MySQL
    *)
  41. license_model : string_ option;
    (*

    The license model information for the restored DB instance.

    License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide.

    This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

    Valid Values:

    • RDS for Db2 - bring-your-own-license | marketplace-license
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included | bring-your-own-media
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license | license-included
    • RDS for PostgreSQL - postgresql-license

    Default: Same as the source.

    *)
  42. auto_minor_version_upgrade : boolean_optional option;
    (*

    Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

    This setting doesn't apply to RDS Custom.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  43. publicly_accessible : boolean_optional option;
    (*

    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.

    For more information, see CreateDBInstance.

    *)
  44. multi_a_z : boolean_optional option;
    (*

    Secifies whether the DB instance is a Multi-AZ deployment.

    This setting doesn't apply to RDS Custom.

    Constraints:

    • You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
    *)
  45. db_subnet_group_name : string_ option;
    (*

    The DB subnet group name to use for the new instance.

    Constraints:

    • If supplied, must match the name of an existing DB subnet group.

    Example: mydbsubnetgroup

    *)
  46. availability_zone : string_ option;
    (*

    The Availability Zone (AZ) where the DB instance will be created.

    Default: A random, system-chosen Availability Zone.

    Constraints:

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

    Example: us-east-1a

    *)
  47. port : integer_optional option;
    (*

    The port number on which the database accepts connections.

    Default: The same port as the original DB instance.

    Constraints:

    • The value must be 1150-65535.
    *)
  48. db_instance_class : string_ option;
    (*

    The compute and memory capacity of the Amazon RDS 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.

    Default: The same DB instance class as the original DB instance.

    *)
  49. use_latest_restorable_time : boolean_ option;
    (*

    Specifies 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.
    *)
  50. restore_time : t_stamp option;
    (*

    The date and time to restore from.

    Constraints:

    • Must be a time in Universal Coordinated Time (UTC) format.
    • Must be before the latest restorable time for the DB instance.
    • Can't be specified if the UseLatestRestorableTime parameter is enabled.

    Example: 2009-09-07T23:45:00Z

    *)
  51. target_db_instance_identifier : string_;
    (*

    The name of the new DB instance to create.

    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.
    *)
  52. source_db_instance_identifier : string_ option;
    (*

    The identifier of the source DB instance from which to restore.

    Constraints:

    • Must match the identifier of an existing DB instance.
    *)
}
type nonrec provisioned_iops_not_available_in_az_fault = {
  1. message : exception_message option;
}

Provisioned IOPS not available in the specified Availability Zone.

type nonrec point_in_time_restore_not_enabled_fault = {
  1. message : exception_message option;
}

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

type nonrec option_group_not_found_fault = {
  1. message : exception_message option;
}

The specified option group could not be found.

type nonrec network_type_not_supported = {
  1. message : exception_message option;
}

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

type nonrec invalid_restore_fault = {
  1. message : exception_message option;
}

Cannot restore from VPC backup to non-VPC DB instance.

type nonrec instance_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec domain_not_found_fault = {
  1. message : exception_message option;
}

Domain doesn't refer to an existing Active Directory domain.

type nonrec db_parameter_group_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec db_instance_automated_backup_not_found_fault = {
  1. message : exception_message option;
}

No automated backup for this DB instance was found.

type nonrec db_instance_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec certificate_not_found_fault = {
  1. message : exception_message option;
}

CertificateIdentifier doesn't refer to an existing certificate.

type nonrec backup_policy_not_found_fault = {
  1. message : exception_message option;
}
type nonrec restore_db_instance_from_s3_result = {
  1. db_instance : db_instance option;
}
type nonrec db_security_group_name_list = string_ list
type nonrec restore_db_instance_from_s3_message = {
  1. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB instance.

    Valid Values:

    • auto-backup - The DB instance's automated backup.
    *)
  2. additional_storage_volumes : additional_storage_volumes_list option;
    (*

    A list of additional storage volumes to modify or delete for the DB instance. You can modify or delete up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.

    *)
  3. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this DB instance.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

    You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide.

    This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  4. ca_certificate_identifier : string_ option;
    (*

    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.

    *)
  5. dedicated_log_volume : boolean_optional option;
    (*

    Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

    *)
  6. master_user_secret_kms_key_id : string_ option;
    (*

    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.

    *)
  7. manage_master_user_password : boolean_optional option;
    (*

    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.
    *)
  8. network_type : string_ option;
    (*

    The network type of the DB instance.

    Valid Values:

    • IPV4
    • DUAL

    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.

    *)
  9. max_allocated_storage : integer_optional option;
    (*

    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.

    *)
  10. deletion_protection : boolean_optional option;
    (*

    Specifies whether to enable deletion protection for the DB instance. 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.

    *)
  11. use_default_processor_features : boolean_optional option;
    (*

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

    *)
  12. processor_features : processor_feature_list option;
    (*

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

    *)
  13. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    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.

    *)
  14. performance_insights_retention_period : integer_optional option;
    (*

    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.

    *)
  15. performance_insights_kms_key_id : string_ option;
    (*

    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.

    *)
  16. enable_performance_insights : boolean_optional option;
    (*

    Specifies whether to enable Performance Insights for the DB instance.

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

    *)
  17. database_insights_mode : database_insights_mode option;
    (*

    Specifies the mode of Database Insights to enable for the DB instance.

    Aurora DB instances inherit this value from the DB cluster, so you can't change this value.

    *)
  18. s3_ingestion_role_arn : string_;
    (*

    An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.

    *)
  19. s3_prefix : string_ option;
    (*

    The prefix of your Amazon S3 bucket.

    *)
  20. s3_bucket_name : string_;
    (*

    The name of your Amazon S3 bucket that contains your database backup file.

    *)
  21. source_engine_version : string_;
    (*

    The version of the database that the backup files were created from.

    MySQL versions 5.6 and 5.7 are supported.

    Example: 5.6.40

    *)
  22. source_engine : string_;
    (*

    The name of the engine of your source database.

    Valid Values: mysql

    *)
  23. enable_iam_database_authentication : boolean_optional option;
    (*

    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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    *)
  24. monitoring_role_arn : string_ option;
    (*

    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.

    *)
  25. monitoring_interval : integer_optional option;
    (*

    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

    *)
  26. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  27. kms_key_id : string_ option;
    (*

    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.

    If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

    *)
  28. storage_encrypted : boolean_optional option;
    (*

    Specifies whether the new DB instance is encrypted or not.

    *)
  29. storage_type : string_ option;
    (*

    Specifies the storage type to be associated with the DB instance.

    Valid Values: gp2 | gp3 | io1 | io2 | standard

    If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise gp2

    *)
  30. tags : tag_list option;
    (*

    A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    *)
  31. publicly_accessible : boolean_optional option;
    (*

    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.

    For more information, see CreateDBInstance.

    *)
  32. option_group_name : string_ option;
    (*

    The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

    *)
  33. storage_throughput : integer_optional option;
    (*

    Specifies the storage throughput value for the DB instance.

    This setting doesn't apply to RDS Custom or Amazon Aurora.

    *)
  34. iops : integer_optional option;
    (*

    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.

    *)
  35. license_model : string_ option;
    (*

    The license model for this DB instance. Use general-public-license.

    *)
  36. auto_minor_version_upgrade : boolean_optional option;
    (*

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

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  37. engine_version : string_ option;
    (*

    The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

    *)
  38. multi_a_z : boolean_optional option;
    (*

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

    *)
  39. port : integer_optional option;
    (*

    The port number on which the database accepts connections.

    Type: Integer

    Valid Values: 1150-65535

    Default: 3306

    *)
  40. preferred_backup_window : string_ option;
    (*

    The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup 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.
    *)
  41. backup_retention_period : integer_optional option;
    (*

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

    *)
  42. db_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group to associate with this DB instance.

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

    *)
  43. preferred_maintenance_window : string_ option;
    (*

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

    Constraints:

    • Must be in the format ddd:hh24:mi-ddd:hh24:mi.
    • Valid Days: 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.
    *)
  44. db_subnet_group_name : string_ option;
    (*

    A DB subnet group to associate with this DB instance.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mydbsubnetgroup

    *)
  45. availability_zone : string_ option;
    (*

    The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

    Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

    Example: us-east-1d

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

    *)
  46. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    *)
  47. db_security_groups : db_security_group_name_list option;
    (*

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

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

    *)
  48. master_user_password : sensitive_string option;
    (*

    The password for the master user.

    Constraints:

    • Can't be specified if ManageMasterUserPassword is turned on.
    • Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.

    Length Constraints:

    • RDS for Db2 - Must contain from 8 to 128 characters.
    • 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.
    *)
  49. master_username : string_ option;
    (*

    The name for the master user.

    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.
    *)
  50. engine : string_;
    (*

    The name of the database engine to be used for this instance.

    Valid Values: mysql

    *)
  51. db_instance_class : string_;
    (*

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

    Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

    *)
  52. allocated_storage : integer_optional option;
    (*

    The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

    This setting isn't valid for RDS for SQL Server.

    Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

    *)
  53. db_instance_identifier : string_;
    (*

    The DB instance identifier. 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

    *)
  54. db_name : string_ option;
    (*

    The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

    *)
}
type nonrec restore_db_instance_from_db_snapshot_result = {
  1. db_instance : db_instance option;
}
type nonrec restore_db_instance_from_db_snapshot_message = {
  1. master_user_secret_kms_key_id : string_ option;
    (*

    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.

    *)
  2. manage_master_user_password : boolean_optional option;
    (*

    Specifies whether to manage the master user password with Amazon Web Services Secrets Manager in the restored DB instance.

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

    Constraints:

    • Applies to RDS for Oracle only.
    *)
  3. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB instance.

    Valid Values:

    • auto-backup - The DB instance's automated backup.
    *)
  4. additional_storage_volumes : additional_storage_volumes_list option;
    (*

    A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.

    *)
  5. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this DB instance.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

    You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.

    This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  6. ca_certificate_identifier : string_ option;
    (*

    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.

    *)
  7. dedicated_log_volume : boolean_optional option;
    (*

    Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

    *)
  8. preferred_backup_window : string_ option;
    (*

    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.
    *)
  9. backup_retention_period : integer_optional option;
    (*

    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.

    Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

    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.
    *)
  10. db_cluster_snapshot_identifier : string_ option;
    (*

    The identifier for the Multi-AZ DB cluster snapshot to restore from.

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

    Constraints:

    • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
    • Can't be specified when DBSnapshotIdentifier is specified.
    • Must be specified when DBSnapshotIdentifier isn't specified.
    • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
    • Can't be the identifier of an Aurora DB cluster snapshot.
    *)
  11. allocated_storage : integer_optional option;
    (*

    The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

    This setting isn't valid for RDS for SQL Server.

    Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

    *)
  12. custom_iam_instance_profile : string_ option;
    (*

    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.

    *)
  13. backup_target : string_ option;
    (*

    Specifies where automated backups and manual snapshots are stored for the restored DB instance.

    Possible values are local (Dedicated Local Zone), outposts (Amazon Web Services Outposts), and region (Amazon Web Services Region). The default is region.

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

    *)
  14. network_type : string_ option;
    (*

    The network type of the DB instance.

    Valid Values:

    • IPV4
    • DUAL

    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.

    *)
  15. enable_customer_owned_ip : boolean_optional option;
    (*

    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.

    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.

    *)
  16. deletion_protection : boolean_optional option;
    (*

    Specifies whether to enable deletion protection for the DB instance. 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.

    *)
  17. db_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group to associate with this DB instance.

    If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.

    This setting doesn't apply to RDS Custom.

    Constraints:

    • If supplied, must match the name of an existing DB parameter group.
    • 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.
    *)
  18. use_default_processor_features : boolean_optional option;
    (*

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

    This setting doesn't apply to RDS Custom.

    *)
  19. processor_features : processor_feature_list option;
    (*

    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.

    *)
  20. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. 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.

    *)
  21. enable_iam_database_authentication : boolean_optional option;
    (*

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

    *)
  22. domain_iam_role_name : string_ option;
    (*

    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.

    *)
  23. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  24. domain_dns_ips : string_list option;
    (*

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

    Constraints:

    • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    Example: 123.124.125.126,234.235.236.237

    *)
  25. domain_auth_secret_arn : string_ option;
    (*

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

    Constraints:

    • Can't be longer than 64 characters.

    Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

    *)
  26. domain_ou : string_ option;
    (*

    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

    *)
  27. domain_fqdn : string_ option;
    (*

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

    Constraints:

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    *)
  28. domain : string_ option;
    (*

    The Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only Db2, 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.

    *)
  29. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    *)
  30. tde_credential_password : sensitive_string option;
    (*

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

    This setting doesn't apply to RDS Custom.

    *)
  31. tde_credential_arn : string_ option;
    (*

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

    This setting doesn't apply to RDS Custom.

    *)
  32. storage_type : string_ option;
    (*

    Specifies the storage type to be associated with the DB instance.

    Valid Values: gp2 | gp3 | io1 | io2 | standard

    If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified, otherwise gp3

    *)
  33. tags : tag_list option;
  34. option_group_name : string_ option;
    (*

    The name of the option group to be used for the restored DB instance.

    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.

    *)
  35. storage_throughput : integer_optional option;
    (*

    Specifies the storage throughput value for the DB instance.

    This setting doesn't apply to RDS Custom or Amazon Aurora.

    *)
  36. iops : integer_optional option;
    (*

    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.

    *)
  37. engine : string_ option;
    (*

    The database engine to use for the new instance.

    This setting doesn't apply to RDS Custom.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

    Valid Values:

    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    *)
  38. db_name : string_ option;
    (*

    The name of the database for the restored DB instance.

    This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances.

    *)
  39. license_model : string_ option;
    (*

    License model information for the restored DB instance.

    License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide.

    This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

    Valid Values:

    • RDS for Db2 - bring-your-own-license | marketplace-license
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included | bring-your-own-media
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license | license-included
    • RDS for PostgreSQL - postgresql-license

    Default: Same as the source.

    *)
  40. auto_minor_version_upgrade : boolean_optional option;
    (*

    Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.

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

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  41. publicly_accessible : boolean_optional option;
    (*

    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.

    For more information, see CreateDBInstance.

    *)
  42. multi_a_z : boolean_optional option;
    (*

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

    *)
  43. db_subnet_group_name : string_ option;
    (*

    The name of the DB subnet group to use for the new instance.

    Constraints:

    • If supplied, must match the name of an existing DB subnet group.

    Example: mydbsubnetgroup

    *)
  44. availability_zone : string_ option;
    (*

    The Availability Zone (AZ) where the DB instance will be created.

    Default: A random, system-chosen Availability Zone.

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

    Example: us-east-1a

    *)
  45. port : integer_optional option;
    (*

    The port number on which the database accepts connections.

    Default: The same port as the original DB instance

    Constraints: Value must be 1150-65535

    *)
  46. db_instance_class : string_ option;
    (*

    The compute and memory capacity of the Amazon RDS 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.

    Default: The same DBInstanceClass as the original DB instance.

    *)
  47. db_snapshot_identifier : string_ option;
    (*

    The identifier for the DB snapshot to restore from.

    Constraints:

    • Must match the identifier of an existing DB snapshot.
    • Can't be specified when DBClusterSnapshotIdentifier is specified.
    • Must be specified when DBClusterSnapshotIdentifier isn't specified.
    • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
    *)
  48. db_instance_identifier : string_;
    (*

    The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

    Constraints:

    • Must contain from 1 to 63 numbers, letters, or hyphens.
    • First character must be a letter.
    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-snapshot-id

    *)
}
type nonrec invalid_db_snapshot_state_fault = {
  1. message : exception_message option;
}

The state of the DB snapshot doesn't allow deletion.

type nonrec restore_db_cluster_to_point_in_time_result = {
  1. db_cluster : db_cluster option;
}
type nonrec restore_db_cluster_to_point_in_time_message = {
  1. enable_internet_access_gateway : boolean_optional option;
    (*

    Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC.

    This parameter must be used together with EnableVPCNetworking set to false. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication.

    Valid for Cluster Type: Aurora PostgreSQL clusters

    *)
  2. enable_vpc_networking : boolean_optional option;
    (*

    Specifies whether to enable VPC networking for the restored DB cluster. Set this parameter to false to create a cluster without the VPC network interface (ENI).

    This parameter must be used together with EnableInternetAccessGateway. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication.

    Valid for Cluster Type: Aurora PostgreSQL clusters

    *)
  3. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB cluster.

    Valid Values:

    • cluster-auto-backup - The DB cluster's automated backup.
    *)
  4. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this DB cluster.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

    You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

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

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  5. preferred_backup_window : string_ option;
    (*

    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.
    *)
  6. backup_retention_period : integer_optional option;
    (*

    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: Uses existing setting

    Constraints:

    • Must be a value from 1 to 35.
    *)
  7. performance_insights_retention_period : integer_optional option;
    (*

    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

    If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

    *)
  8. performance_insights_kms_key_id : string_ option;
    (*

    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.

    *)
  9. enable_performance_insights : boolean_optional option;
    (*

    Specifies whether to turn on Performance Insights for the DB cluster.

    *)
  10. monitoring_role_arn : string_ option;
    (*

    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.

    If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

    *)
  11. monitoring_interval : integer_optional option;
    (*

    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 Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

    Default: 0

    *)
  12. rds_custom_cluster_configuration : rds_custom_cluster_configuration option;
    (*

    Reserved for future use.

    *)
  13. engine_mode : string_ option;
    (*

    The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine mode serverless.

    Valid for: Aurora DB clusters only

    *)
  14. scaling_configuration : scaling_configuration option;
    (*

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    Valid for: Aurora DB clusters only

    *)
  15. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
  16. source_db_cluster_resource_id : string_ option;
    (*

    The resource ID of the source DB cluster from which to restore.

    *)
  17. network_type : string_ option;
    (*

    The network type of the DB cluster.

    Valid Values:

    • IPV4
    • DUAL

    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: Aurora DB clusters only

    *)
  18. iops : integer_optional option;
    (*

    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

    *)
  19. publicly_accessible : boolean_optional option;
    (*

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

    *)
  20. storage_type : string_ option;
    (*

    Specifies the storage type to be associated with the DB cluster.

    When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

    Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

    Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

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

    *)
  21. db_cluster_instance_class : string_ option;
    (*

    The compute and memory capacity of the 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: Multi-AZ DB clusters only

    *)
  22. domain_iam_role_name : string_ option;
    (*

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

    Valid for: Aurora DB clusters only

    *)
  23. domain : string_ option;
    (*

    The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

    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: Aurora DB clusters only

    *)
  24. copy_tags_to_snapshot : boolean_optional option;
    (*

    Specifies 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

    *)
  25. deletion_protection : boolean_optional option;
    (*

    Specifies whether to enable deletion protection for the DB cluster. 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

    *)
  26. db_cluster_parameter_group_name : string_ option;
    (*

    The name of the custom DB cluster parameter group to associate with this DB cluster.

    If the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified engine is used.

    Constraints:

    • If supplied, must match the name of an existing DB cluster parameter group.
    • 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.

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

    *)
  27. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    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, slowquery, and iam-db-auth-error.

    RDS for PostgreSQL

    Possible values are postgresql, upgrade, and iam-db-auth-error.

    Aurora MySQL

    Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

    Aurora PostgreSQL

    Possible value are instance, postgresql, and iam-db-auth-error.

    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

    *)
  28. backtrack_window : long_optional option;
    (*

    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

    *)
  29. enable_iam_database_authentication : boolean_optional option;
    (*

    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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.

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

    *)
  30. kms_key_id : string_ option;
    (*

    The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from 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.

    You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

    If you don't specify a value for the KmsKeyId parameter, then the following occurs:

    • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
    • If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

    If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

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

    *)
  31. tags : tag_list option;
  32. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of VPC security groups that the new DB cluster belongs to.

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

    *)
  33. option_group_name : string_ option;
    (*

    The name of the option group for the new DB cluster.

    DB clusters are associated with a default option group that can't be modified.

    *)
  34. db_subnet_group_name : string_ option;
    (*

    The DB subnet group name to use for the new DB cluster.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mydbsubnetgroup

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

    *)
  35. port : integer_optional option;
    (*

    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

    *)
  36. use_latest_restorable_time : boolean_ option;
    (*

    Specifies 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

    *)
  37. restore_to_time : t_stamp option;
    (*

    The date and time to restore the DB cluster to.

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    Constraints:

    • Must be before the latest restorable time for the DB instance
    • Must be specified if UseLatestRestorableTime parameter isn't provided
    • Can't be specified if the UseLatestRestorableTime parameter is enabled
    • Can't be specified if the RestoreType parameter is copy-on-write

    Example: 2015-03-07T23:45:00Z

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

    *)
  38. source_db_cluster_identifier : string_ option;
    (*

    The identifier of the source DB cluster from which to restore.

    Constraints:

    • Must match the identifier of an existing DBCluster.

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

    *)
  39. restore_type : string_ option;
    (*

    The type of restore to be performed. You can specify one of the following values:

    • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
    • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

    If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

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

    *)
  40. db_cluster_identifier : string_;
    (*

    The name of the new DB cluster to be created.

    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

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

    *)
}
type nonrec invalid_db_cluster_snapshot_state_fault = {
  1. message : exception_message option;
}

The supplied value isn't a valid DB cluster snapshot state.

type nonrec insufficient_storage_cluster_capacity_fault = {
  1. message : exception_message option;
}

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.

type nonrec insufficient_db_cluster_capacity_fault = {
  1. message : exception_message option;
}

The DB cluster doesn't have enough capacity for the current operation.

type nonrec db_cluster_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec db_cluster_parameter_group_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec db_cluster_automated_backup_not_found_fault = {
  1. message : exception_message option;
}

No automated backup for this DB cluster was found.

type nonrec db_cluster_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec restore_db_cluster_from_snapshot_result = {
  1. db_cluster : db_cluster option;
}
type nonrec restore_db_cluster_from_snapshot_message = {
  1. enable_internet_access_gateway : boolean_optional option;
    (*

    Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC.

    This parameter must be used together with EnableVPCNetworking set to false. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication.

    Valid for Cluster Type: Aurora PostgreSQL clusters

    *)
  2. enable_vpc_networking : boolean_optional option;
    (*

    Specifies whether to enable VPC networking for the restored DB cluster. Set this parameter to false to create a cluster without the VPC network interface (ENI).

    This parameter must be used together with EnableInternetAccessGateway. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication.

    Valid for Cluster Type: Aurora PostgreSQL clusters

    *)
  3. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB cluster.

    Valid Values:

    • cluster-auto-backup - The DB cluster's automated backup.
    *)
  4. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this DB cluster.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

    You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

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

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  5. preferred_backup_window : string_ option;
    (*

    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.
    *)
  6. backup_retention_period : integer_optional option;
    (*

    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: Uses existing setting

    Constraints:

    • Must be a value from 1 to 35.
    *)
  7. performance_insights_retention_period : integer_optional option;
    (*

    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

    If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

    *)
  8. performance_insights_kms_key_id : string_ option;
    (*

    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.

    *)
  9. enable_performance_insights : boolean_optional option;
    (*

    Specifies whether to turn on Performance Insights for the DB cluster.

    *)
  10. monitoring_role_arn : string_ option;
    (*

    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.

    If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

    *)
  11. monitoring_interval : integer_optional option;
    (*

    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 Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

    Default: 0

    *)
  12. rds_custom_cluster_configuration : rds_custom_cluster_configuration option;
    (*

    Reserved for future use.

    *)
  13. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
  14. network_type : string_ option;
    (*

    The network type of the DB cluster.

    Valid Values:

    • IPV4
    • DUAL

    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: Aurora DB clusters only

    *)
  15. publicly_accessible : boolean_optional option;
    (*

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

    *)
  16. iops : integer_optional option;
    (*

    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

    *)
  17. storage_type : string_ option;
    (*

    Specifies the storage type to be associated with the DB cluster.

    When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

    Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

    Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

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

    *)
  18. db_cluster_instance_class : string_ option;
    (*

    The compute and memory capacity of the 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: Multi-AZ DB clusters only

    *)
  19. domain_iam_role_name : string_ option;
    (*

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

    Valid for: Aurora DB clusters only

    *)
  20. domain : string_ option;
    (*

    The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. 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.

    Valid for: Aurora DB clusters only

    *)
  21. copy_tags_to_snapshot : boolean_optional option;
    (*

    Specifies 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

    *)
  22. deletion_protection : boolean_optional option;
    (*

    Specifies whether to enable deletion protection for the DB cluster. 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

    *)
  23. db_cluster_parameter_group_name : string_ option;
    (*

    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

    Constraints:

    • If supplied, must match the name of an existing default DB cluster parameter group.
    • 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.

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

    *)
  24. scaling_configuration : scaling_configuration option;
    (*

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    Valid for: Aurora DB clusters only

    *)
  25. engine_mode : string_ option;
    (*

    The DB engine mode of the DB cluster, either provisioned or serverless.

    For more information, see CreateDBCluster.

    Valid for: Aurora DB clusters only

    *)
  26. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    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, slowquery, and iam-db-auth-error.

    RDS for PostgreSQL

    Possible values are postgresql, upgrade, and iam-db-auth-error.

    Aurora MySQL

    Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

    Aurora PostgreSQL

    Possible value are instance, postgresql, and iam-db-auth-error.

    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

    *)
  27. backtrack_window : long_optional option;
    (*

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    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

    *)
  28. enable_iam_database_authentication : boolean_optional option;
    (*

    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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.

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

    *)
  29. kms_key_id : string_ option;
    (*

    The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

    When you don't specify a value for the KmsKeyId parameter, then the following occurs:

    • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
    • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

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

    *)
  30. tags : tag_list option;
    (*

    The tags to be assigned to the restored DB cluster.

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

    *)
  31. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of VPC security groups that the new DB cluster will belong to.

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

    *)
  32. option_group_name : string_ option;
    (*

    The name of the option group to use for the restored DB cluster.

    DB clusters are associated with a default option group that can't be modified.

    *)
  33. database_name : string_ option;
    (*

    The database name for the restored DB cluster.

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

    *)
  34. db_subnet_group_name : string_ option;
    (*

    The name of the DB subnet group to use for the new DB cluster.

    Constraints: If supplied, must match the name of an existing DB subnet group.

    Example: mydbsubnetgroup

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

    *)
  35. port : integer_optional option;
    (*

    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

    *)
  36. engine_version : string_ option;
    (*

    The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.

    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"

    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.

    MySQL

    See Amazon RDS for MySQL in the Amazon RDS User Guide.

    PostgreSQL

    See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

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

    *)
  37. engine : string_;
    (*

    The database engine to use for the new DB cluster.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

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

    *)
  38. snapshot_identifier : string_;
    (*

    The identifier for the DB snapshot or DB cluster snapshot to restore from.

    You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

    Constraints:

    • Must match the identifier of an existing Snapshot.

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

    *)
  39. db_cluster_identifier : string_;
    (*

    The name of the DB cluster to create from the DB snapshot or 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-snapshot-id

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

    *)
  40. availability_zones : availability_zones option;
    (*

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

    Valid for: Aurora DB clusters only

    *)
}
type nonrec restore_db_cluster_from_s3_result = {
  1. db_cluster : db_cluster option;
}
type nonrec restore_db_cluster_from_s3_message = {
  1. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB cluster.

    Valid Values:

    • cluster-auto-backup - The DB cluster's automated backup.
    *)
  2. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this DB cluster.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

    You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

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

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  3. master_user_secret_kms_key_id : string_ option;
    (*

    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.

    *)
  4. manage_master_user_password : boolean_optional option;
    (*

    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.

    Constraints:

    • Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
    *)
  5. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
  6. network_type : string_ option;
    (*

    The network type of the DB cluster.

    Valid Values:

    • IPV4
    • DUAL

    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.

    *)
  7. storage_type : string_ option;
    (*

    Specifies the storage type to be associated with the DB cluster.

    Valid Values: aurora, aurora-iopt1

    Default: aurora

    Valid for: Aurora DB clusters only

    *)
  8. domain_iam_role_name : string_ option;
    (*

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    *)
  9. domain : string_ option;
    (*

    Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

    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.

    *)
  10. copy_tags_to_snapshot : boolean_optional option;
    (*

    Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    *)
  11. deletion_protection : boolean_optional option;
    (*

    Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

    *)
  12. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    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, instance, slowquery, and iam-db-auth-error.

    Aurora PostgreSQL

    Possible value are instance, postgresql, and iam-db-auth-error.

    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.

    *)
  13. backtrack_window : long_optional option;
    (*

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    *)
  14. s3_ingestion_role_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

    *)
  15. s3_prefix : string_ option;
    (*

    The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

    *)
  16. s3_bucket_name : string_;
    (*

    The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

    *)
  17. source_engine_version : string_;
    (*

    The version of the database that the backup files were created from.

    MySQL versions 5.7 and 8.0 are supported.

    Example: 5.7.40, 8.0.28

    *)
  18. source_engine : string_;
    (*

    The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

    Valid Values: mysql

    *)
  19. enable_iam_database_authentication : boolean_optional option;
    (*

    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.

    *)
  20. kms_key_id : string_ option;
    (*

    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.

    If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

    *)
  21. storage_encrypted : boolean_optional option;
    (*

    Specifies whether the restored DB cluster is encrypted.

    *)
  22. tags : tag_list option;
  23. preferred_maintenance_window : string_ option;
    (*

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    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 Maintenance Window in the Amazon Aurora User Guide.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

    *)
  24. preferred_backup_window : string_ option;
    (*

    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.

    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.
    *)
  25. option_group_name : string_ option;
    (*

    A value that indicates that the restored DB cluster should be associated with the specified option group.

    Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

    *)
  26. master_user_password : sensitive_string option;
    (*

    The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

    Constraints:

    • Must contain from 8 to 41 characters.
    • Can't be specified if ManageMasterUserPassword is turned on.
    *)
  27. master_username : string_;
    (*

    The name of the master user for the restored DB cluster.

    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.
    *)
  28. port : integer_optional option;
    (*

    The port number on which the instances in the restored DB cluster accept connections.

    Default: 3306

    *)
  29. engine_version : string_ option;
    (*

    The version number of the database engine to use.

    To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

    Aurora MySQL

    Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0

    *)
  30. engine : string_;
    (*

    The name of the database engine to be used for this DB cluster.

    Valid Values: aurora-mysql (for Aurora MySQL)

    *)
  31. db_subnet_group_name : string_ option;
    (*

    A DB subnet group to associate with the restored DB cluster.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mydbsubnetgroup

    *)
  32. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of EC2 VPC security groups to associate with the restored DB cluster.

    *)
  33. db_cluster_parameter_group_name : string_ option;
    (*

    The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.
    *)
  34. db_cluster_identifier : string_;
    (*

    The name of the DB cluster to create from the source data in the Amazon S3 bucket. 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-cluster1

    *)
  35. database_name : string_ option;
    (*

    The database name for the restored DB cluster.

    *)
  36. character_set_name : string_ option;
    (*

    A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

    *)
  37. backup_retention_period : integer_optional option;
    (*

    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
    *)
  38. availability_zones : availability_zones option;
    (*

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

    *)
}
type nonrec invalid_db_subnet_group_state_fault = {
  1. message : exception_message option;
}

The DB subnet group cannot be deleted because it's in use.

type nonrec pending_maintenance_action = {
  1. description : string_ option;
    (*

    A description providing more detail about the maintenance action.

    *)
  2. current_apply_date : t_stamp option;
    (*

    The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

    *)
  3. opt_in_status : string_ option;
    (*

    Indicates the type of opt-in request that has been received for the resource.

    *)
  4. forced_apply_date : t_stamp option;
    (*

    The date when the maintenance action is automatically applied.

    On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.

    *)
  5. auto_applied_after_date : t_stamp option;
    (*

    The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.

    *)
  6. action : string_ option;
    (*

    The type of pending maintenance action that is available for the resource.

    For more information about maintenance actions, see Maintaining a DB instance.

    Valid Values:

    • ca-certificate-rotation
    • db-upgrade
    • hardware-maintenance
    • os-upgrade
    • serverless-platform-version-update
    • system-update

    For more information about these actions, see Maintenance actions for Amazon Aurora or Maintenance actions for Amazon RDS.

    *)
}

Provides information about a pending maintenance action for a resource.

type nonrec pending_maintenance_action_details = pending_maintenance_action list
type nonrec resource_pending_maintenance_actions = {
  1. pending_maintenance_action_details : pending_maintenance_action_details option;
    (*

    A list that provides details about the pending maintenance actions for the resource.

    *)
  2. resource_identifier : string_ option;
    (*

    The ARN of the resource that has pending maintenance actions.

    *)
}

Describes the pending maintenance actions for a resource.

type nonrec potentially_sensitive_parameter_value = string
type nonrec apply_method =
  1. | Pending_reboot
  2. | Immediate
type nonrec parameter = {
  1. supported_engine_modes : engine_mode_list option;
    (*

    The valid DB engine modes.

    *)
  2. apply_method : apply_method option;
    (*

    Indicates when to apply parameter updates.

    *)
  3. minimum_engine_version : string_ option;
    (*

    The earliest engine version to which the parameter can apply.

    *)
  4. is_modifiable : boolean_ option;
    (*

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

    *)
  5. allowed_values : string_ option;
    (*

    Specifies the valid range of values for the parameter.

    *)
  6. data_type : string_ option;
    (*

    Specifies the valid data type for the parameter.

    *)
  7. apply_type : string_ option;
    (*

    Specifies the engine specific parameters type.

    *)
  8. source : string_ option;
    (*

    The source of the parameter value.

    *)
  9. description : string_ option;
    (*

    Provides a description of the parameter.

    *)
  10. parameter_value : potentially_sensitive_parameter_value option;
    (*

    The value of the parameter.

    *)
  11. parameter_name : string_ option;
    (*

    The name of the parameter.

    *)
}

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.

type nonrec parameters_list = parameter list
type nonrec reset_db_parameter_group_message = {
  1. parameters : parameters_list option;
    (*

    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

    *)
  2. reset_all_parameters : boolean_ option;
    (*

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

    *)
  3. db_parameter_group_name : string_;
    (*

    The name of the DB parameter group.

    Constraints:

    • Must match the name of an existing DBParameterGroup.
    *)
}
type nonrec invalid_db_parameter_group_state_fault = {
  1. message : exception_message option;
}

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.

type nonrec db_parameter_group_name_message = {
  1. db_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group.

    *)
}

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

type nonrec reset_db_cluster_parameter_group_message = {
  1. parameters : parameters_list option;
    (*

    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.

    *)
  2. reset_all_parameters : boolean_ option;
    (*

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

    *)
  3. db_cluster_parameter_group_name : string_;
    (*

    The name of the DB cluster parameter group to reset.

    *)
}
type nonrec db_cluster_parameter_group_name_message = {
  1. db_cluster_parameter_group_name : string_ option;
    (*

    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

    This value is stored as a lowercase string.

    *)
}
type nonrec reserved_db_instances_offering_not_found_fault = {
  1. message : exception_message option;
}

Specified offering does not exist.

type nonrec recurring_charge = {
  1. recurring_charge_frequency : string_ option;
    (*

    The frequency of the recurring charge.

    *)
  2. recurring_charge_amount : double option;
    (*

    The amount of the recurring charge.

    *)
}

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

type nonrec recurring_charge_list = recurring_charge list
type nonrec reserved_db_instances_offering = {
  1. recurring_charges : recurring_charge_list option;
    (*

    The recurring price charged to run this reserved DB instance.

    *)
  2. multi_a_z : boolean_ option;
    (*

    Indicates whether the offering applies to Multi-AZ deployments.

    *)
  3. offering_type : string_ option;
    (*

    The offering type.

    *)
  4. product_description : string_ option;
    (*

    The database engine used by the offering.

    *)
  5. currency_code : string_ option;
    (*

    The currency code for the reserved DB instance offering.

    *)
  6. usage_price : double option;
    (*

    The hourly price charged for this offering.

    *)
  7. fixed_price : double option;
    (*

    The fixed price charged for this offering.

    *)
  8. duration : integer option;
    (*

    The duration of the offering in seconds.

    *)
  9. db_instance_class : string_ option;
    (*

    The DB instance class for the reserved DB instance.

    *)
  10. reserved_db_instances_offering_id : string_ option;
    (*

    The offering identifier.

    *)
}

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

type nonrec reserved_db_instances_offering_list = reserved_db_instances_offering list
type nonrec reserved_db_instances_offering_message = {
  1. reserved_db_instances_offerings : reserved_db_instances_offering_list option;
    (*

    A list of reserved DB instance offerings.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec reserved_db_instance_quota_exceeded_fault = {
  1. message : exception_message option;
}

Request would exceed the user's DB Instance quota.

type nonrec reserved_db_instance_not_found_fault = {
  1. message : exception_message option;
}

The specified reserved DB Instance not found.

type nonrec reserved_db_instance = {
  1. lease_id : string_ option;
    (*

    The unique identifier for the lease associated with the reserved DB instance.

    Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

    *)
  2. reserved_db_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the reserved DB instance.

    *)
  3. recurring_charges : recurring_charge_list option;
    (*

    The recurring price charged to run this reserved DB instance.

    *)
  4. state : string_ option;
    (*

    The state of the reserved DB instance.

    *)
  5. multi_a_z : boolean_ option;
    (*

    Indicates whether the reservation applies to Multi-AZ deployments.

    *)
  6. offering_type : string_ option;
    (*

    The offering type of this reserved DB instance.

    *)
  7. product_description : string_ option;
    (*

    The description of the reserved DB instance.

    *)
  8. db_instance_count : integer option;
    (*

    The number of reserved DB instances.

    *)
  9. currency_code : string_ option;
    (*

    The currency code for the reserved DB instance.

    *)
  10. usage_price : double option;
    (*

    The hourly price charged for this reserved DB instance.

    *)
  11. fixed_price : double option;
    (*

    The fixed price charged for this reserved DB instance.

    *)
  12. duration : integer option;
    (*

    The duration of the reservation in seconds.

    *)
  13. start_time : t_stamp option;
    (*

    The time the reservation started.

    *)
  14. db_instance_class : string_ option;
    (*

    The DB instance class for the reserved DB instance.

    *)
  15. reserved_db_instances_offering_id : string_ option;
    (*

    The offering identifier.

    *)
  16. reserved_db_instance_id : string_ option;
    (*

    The unique identifier for the reservation.

    *)
}

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

type nonrec reserved_db_instance_list = reserved_db_instance list
type nonrec reserved_db_instance_message = {
  1. reserved_db_instances : reserved_db_instance_list option;
    (*

    A list of reserved DB instances.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec reserved_db_instance_already_exists_fault = {
  1. message : exception_message option;
}

User already has a reservation with the given identifier.

type nonrec key_list = string_ list
type nonrec remove_tags_from_resource_message = {
  1. tag_keys : key_list;
    (*

    The tag key (name) of the tag to be removed.

    *)
  2. resource_name : string_;
    (*

    The Amazon RDS resource that the tags are removed from. 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.

    *)
}
type nonrec invalid_db_cluster_endpoint_state_fault = {
  1. message : exception_message option;
}

The requested operation can't be performed on the endpoint while the endpoint is in this state.

type nonrec integration_not_found_fault = {
  1. message : exception_message option;
}

The specified integration could not be found.

type nonrec db_snapshot_tenant_database_not_found_fault = {
  1. message : exception_message option;
}

The specified snapshot tenant database wasn't found.

type nonrec db_shard_group_not_found_fault = {
  1. message : exception_message option;
}

The specified DB shard group name wasn't found.

type nonrec db_proxy_target_group_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec db_proxy_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec db_proxy_endpoint_not_found_fault = {
  1. message : exception_message option;
}

The DB proxy endpoint doesn't exist.

type nonrec event_categories_list = string_ list
type nonrec event_subscription = {
  1. event_subscription_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the event subscription.

    *)
  2. enabled : boolean_ option;
    (*

    Specifies whether the subscription is enabled. True indicates the subscription is enabled.

    *)
  3. event_categories_list : event_categories_list option;
    (*

    A list of event categories for the RDS event notification subscription.

    *)
  4. source_ids_list : source_ids_list option;
    (*

    A list of source IDs for the RDS event notification subscription.

    *)
  5. source_type : string_ option;
    (*

    The source type for the RDS event notification subscription.

    *)
  6. subscription_creation_time : string_ option;
    (*

    The time the RDS event notification subscription was created.

    *)
  7. status : string_ option;
    (*

    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.

    *)
  8. sns_topic_arn : string_ option;
    (*

    The topic ARN of the RDS event notification subscription.

    *)
  9. cust_subscription_id : string_ option;
    (*

    The RDS event notification subscription Id.

    *)
  10. customer_aws_id : string_ option;
    (*

    The Amazon Web Services customer account associated with the RDS event notification subscription.

    *)
}

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

type nonrec remove_source_identifier_from_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec remove_source_identifier_from_subscription_message = {
  1. source_identifier : string_;
    (*

    The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

    *)
  2. subscription_name : string_;
    (*

    The name of the RDS event notification subscription you want to remove a source identifier from.

    *)
}
type nonrec remove_role_from_db_instance_message = {
  1. feature_name : string_;
    (*

    The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.

    *)
  2. role_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, arn:aws:iam::123456789012:role/AccessRole.

    *)
  3. db_instance_identifier : string_;
    (*

    The name of the DB instance to disassociate the IAM role from.

    *)
}
type nonrec db_instance_role_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec remove_role_from_db_cluster_message = {
  1. feature_name : string_ option;
    (*

    The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.

    *)
  2. role_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

    *)
  3. db_cluster_identifier : string_;
    (*

    The name of the DB cluster to disassociate the IAM role from.

    *)
}
type nonrec db_cluster_role_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec remove_from_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec remove_from_global_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

    The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

    *)
  2. global_cluster_identifier : global_cluster_identifier;
    (*

    The cluster identifier to detach from the Aurora global database cluster.

    *)
}
type nonrec register_db_proxy_targets_response = {
  1. db_proxy_targets : target_list option;
    (*

    One or more DBProxyTarget objects that are created when you register targets with a target group.

    *)
}
type nonrec db_proxy_name = string
type nonrec db_proxy_target_group_name = string
type nonrec register_db_proxy_targets_request = {
  1. db_cluster_identifiers : string_list option;
    (*

    One or more DB cluster identifiers.

    *)
  2. db_instance_identifiers : string_list option;
    (*

    One or more DB instance identifiers.

    *)
  3. target_group_name : db_proxy_target_group_name option;
    (*

    The identifier of the DBProxyTargetGroup.

    *)
  4. db_proxy_name : db_proxy_name;
    (*

    The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

    *)
}
type nonrec invalid_db_proxy_state_fault = {
  1. message : exception_message option;
}

The requested operation can't be performed while the proxy is in this state.

type nonrec insufficient_available_i_ps_in_subnet_fault = {
  1. message : exception_message option;
}

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.

type nonrec db_proxy_target_already_registered_fault = {
  1. message : exception_message option;
}

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

type nonrec reference_details = {
  1. scalar_reference_details : scalar_reference_details option;
    (*

    The metric reference details when the reference is a scalar.

    *)
}

The reference details of a metric.

The recommended status to update for the specified recommendation action ID.

A single parameter to use with the RecommendedAction API operation to apply the action.

type nonrec metric_reference = {
  1. reference_details : reference_details option;
    (*

    The details of a performance issue.

    *)
  2. name : string_ option;
    (*

    The name of the metric reference.

    *)
}

The reference (threshold) for a metric.

type nonrec metric_reference_list = metric_reference list
type nonrec performance_insights_metric_dimension_group = {
  1. limit : integer option;
    (*

    The maximum number of items to fetch for this dimension group.

    *)
  2. group : string_ option;
    (*

    The available dimension groups for Performance Insights metric type.

    *)
  3. dimensions : string_list option;
    (*

    A list of specific dimensions from a dimension group. If this list isn't included, then all of the dimensions in the group were requested, or are present in the response.

    *)
}

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions:

  • db.sql.id - The hash of a running SQL statement, generated by Performance Insights.
  • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.
  • db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.
  • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

type nonrec performance_insights_metric_query = {
  1. metric : string_ option;
    (*

    The name of a Performance Insights metric to be measured.

    Valid Values:

    • db.load.avg - A scaled representation of the number of active sessions for the database engine.
    • db.sampledload.avg - The raw number of active sessions for the database engine.
    • The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

    *)
  2. group_by : performance_insights_metric_dimension_group option;
    (*

    A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

    *)
}

A single Performance Insights metric query to process. You must provide the metric to the query. If other parameters aren't specified, Performance Insights returns all data points for the specified metric. Optionally, you can request the data points to be aggregated by dimension group (GroupBy) and return only those data points that match your criteria (Filter).

Constraints:

  • Must be a valid Performance Insights query.
type nonrec metric_query = {
  1. performance_insights_metric_query : performance_insights_metric_query option;
    (*

    The Performance Insights query that you can use to retrieve Performance Insights metric data points.

    *)
}

The query to retrieve metric data points.

type nonrec metric = {
  1. metric_query : metric_query option;
    (*

    The query to retrieve metric data points.

    *)
  2. statistics_details : string_ option;
    (*

    The details of different statistics for a metric. The description might contain markdown.

    *)
  3. references : metric_reference_list option;
    (*

    A list of metric references (thresholds).

    *)
  4. name : string_ option;
    (*

    The name of a metric.

    *)
}

The representation of a metric.

type nonrec metric_list = metric list
type nonrec performance_issue_details = {
  1. analysis : string_ option;
    (*

    The analysis of the performance issue. The information might contain markdown.

    *)
  2. metrics : metric_list option;
    (*

    The metrics that are relevant to the performance issue.

    *)
  3. end_time : t_stamp option;
    (*

    The time when the performance issue stopped.

    *)
  4. start_time : t_stamp option;
    (*

    The time when the performance issue started.

    *)
}

Details of the performance issue.

type nonrec issue_details = {
  1. performance_issue_details : performance_issue_details option;
    (*

    A detailed description of the issue when the recommendation category is performance.

    *)
}

The details of an issue with your DB instances, DB clusters, and DB parameter groups.

type nonrec context_attribute = {
  1. value : string_ option;
    (*

    The value of ContextAttribute.

    *)
  2. key : string_ option;
    (*

    The key of ContextAttribute.

    *)
}

The additional attributes of RecommendedAction data type.

type nonrec context_attribute_list = context_attribute list

The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.

type nonrec db_shard_group_identifier = string
type nonrec reboot_db_shard_group_message = {
  1. db_shard_group_identifier : db_shard_group_identifier;
    (*

    The name of the DB shard group to reboot.

    *)
}
type nonrec db_shard_group = {
  1. tag_list : tag_list option;
  2. db_shard_group_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB shard group.

    *)
  3. endpoint : string_ option;
    (*

    The connection endpoint for the DB shard group.

    *)
  4. publicly_accessible : boolean_optional option;
    (*

    Indicates whether the DB shard group is publicly accessible.

    When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.

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

    For more information, see CreateDBShardGroup.

    This setting is only for Aurora Limitless Database.

    *)
  5. status : string_ option;
    (*

    The status of the DB shard group.

    *)
  6. compute_redundancy : integer_optional option;
    (*

    Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

    • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
    • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
    • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
    *)
  7. min_ac_u : double_optional option;
    (*

    The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

    *)
  8. max_ac_u : double_optional option;
    (*

    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

    *)
  9. db_cluster_identifier : string_ option;
    (*

    The name of the primary DB cluster for the DB shard group.

    *)
  10. db_shard_group_identifier : db_shard_group_identifier option;
    (*

    The name of the DB shard group.

    *)
  11. db_shard_group_resource_id : string_ option;
    (*

    The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

    *)
}

Contains the details for an Amazon RDS DB shard group.

type nonrec reboot_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec reboot_db_instance_message = {
  1. force_failover : boolean_optional option;
    (*

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

    *)
  2. db_instance_identifier : string_;
    (*

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.
    *)
}
type nonrec reboot_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec reboot_db_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

    The DB cluster identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBCluster.
    *)
}
type nonrec purchase_reserved_db_instances_offering_result = {
  1. reserved_db_instance : reserved_db_instance option;
}
type nonrec purchase_reserved_db_instances_offering_message = {
  1. tags : tag_list option;
  2. db_instance_count : integer_optional option;
    (*

    The number of instances to reserve.

    Default: 1

    *)
  3. reserved_db_instance_id : string_ option;
    (*

    Customer-specified identifier to track this reservation.

    Example: myreservationID

    *)
  4. reserved_db_instances_offering_id : string_;
    (*

    The ID of the Reserved DB instance offering to purchase.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    *)
}
type nonrec promote_read_replica_result = {
  1. db_instance : db_instance option;
}
type nonrec promote_read_replica_message = {
  1. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB instance.

    Valid Values:

    • auto-backup - The DB instance's automated backup.
    *)
  2. preferred_backup_window : string_ option;
    (*

    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.
    *)
  3. backup_retention_period : integer_optional option;
    (*

    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.
    *)
  4. db_instance_identifier : string_;
    (*

    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

    *)
}
type nonrec promote_read_replica_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec promote_read_replica_db_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

    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

    *)
}
type nonrec potentially_sensitive_option_setting_value = string
type nonrec pending_maintenance_actions = resource_pending_maintenance_actions list
type nonrec pending_maintenance_actions_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. pending_maintenance_actions : pending_maintenance_actions option;
    (*

    A list of the pending maintenance actions for the resource.

    *)
}

Data returned from the DescribePendingMaintenanceActions action.

type nonrec availability_zone_list = availability_zone list
type nonrec activity_stream_mode_list = string_ list
type nonrec available_additional_storage_volumes_option = {
  1. max_storage_throughput : integer_optional option;
    (*

    The maximum storage throughput that the additional storage volume supports, in mebibytes per second (MiBps).

    *)
  2. min_storage_throughput : integer_optional option;
    (*

    The minimum storage throughput that the additional storage volume supports, in mebibytes per second (MiBps).

    *)
  3. max_iops_per_gib : double_optional option;
    (*

    The maximum ratio of I/O operations per second (IOPS) to gibibytes (GiB) of storage for the additional storage volume.

    *)
  4. min_iops_per_gib : double_optional option;
    (*

    The minimum ratio of I/O operations per second (IOPS) to gibibytes (GiB) of storage for the additional storage volume.

    *)
  5. max_iops : integer_optional option;
    (*

    The maximum number of I/O operations per second (IOPS) that the additional storage volume supports.

    *)
  6. min_iops : integer_optional option;
    (*

    The minimum number of I/O operations per second (IOPS) that the additional storage volume supports.

    *)
  7. max_storage_size : integer_optional option;
    (*

    The maximum amount of storage that you can allocate for the additional storage volume, in gibibytes (GiB).

    *)
  8. min_storage_size : integer_optional option;
    (*

    The minimum amount of storage that you can allocate for the additional storage volume, in gibibytes (GiB).

    *)
  9. storage_type : string_ option;
    (*

    The storage type for the additional storage volume.

    Valid Values: GP3 | IO2

    *)
  10. supports_iops : boolean_ option;
    (*

    Indicates whether the additional storage volume supports provisioned IOPS.

    *)
  11. supports_storage_throughput : boolean_ option;
    (*

    Indicates whether the additional storage volume supports configurable storage throughput.

    *)
  12. supports_storage_autoscaling : boolean_ option;
    (*

    Indicates whether the additional storage volume supports storage autoscaling.

    *)
}

Contains the available options for additional storage volumes for a DB instance class.

type nonrec available_additional_storage_volumes_option_list = available_additional_storage_volumes_option list
type nonrec orderable_db_instance_option = {
  1. available_additional_storage_volumes_options : available_additional_storage_volumes_option_list option;
    (*

    The available options for additional storage volumes for the DB instance class.

    *)
  2. supports_http_endpoint : boolean_ option;
    (*

    Indicates whether a DB instance supports HTTP endpoints.

    *)
  3. supports_additional_storage_volumes : boolean_optional option;
    (*

    Indicates whether the DB instance class supports additional storage volumes.

    *)
  4. supports_dedicated_log_volume : boolean_ option;
    (*

    Indicates whether a DB instance supports using a dedicated log volume (DLV).

    *)
  5. supports_clusters : boolean_ option;
    (*

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

    *)
  6. supported_network_types : string_list option;
    (*

    The network types supported by the DB instance (IPV4 or DUAL).

    A DB instance 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.

    *)
  7. supports_global_databases : boolean_ option;
    (*

    Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

    *)
  8. supported_activity_stream_modes : activity_stream_mode_list option;
    (*

    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.

    *)
  9. outpost_capable : boolean_ option;
    (*

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

    *)
  10. supports_kerberos_authentication : boolean_optional option;
    (*

    Indicates whether a DB instance supports Kerberos Authentication.

    *)
  11. supports_storage_autoscaling : boolean_optional option;
    (*

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

    *)
  12. supported_engine_modes : engine_mode_list option;
    (*

    A list of the supported DB engine modes.

    *)
  13. available_processor_features : available_processor_feature_list option;
    (*

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

    *)
  14. max_storage_throughput_per_iops : double_optional option;
    (*

    Maximum storage throughput to provisioned IOPS ratio for a DB instance.

    *)
  15. min_storage_throughput_per_iops : double_optional option;
    (*

    Minimum storage throughput to provisioned IOPS ratio for a DB instance.

    *)
  16. max_storage_throughput_per_db_instance : integer_optional option;
    (*

    Maximum storage throughput for a DB instance.

    *)
  17. min_storage_throughput_per_db_instance : integer_optional option;
    (*

    Minimum storage throughput for a DB instance.

    *)
  18. max_iops_per_gib : double_optional option;
    (*

    Maximum provisioned IOPS per GiB for a DB instance.

    *)
  19. min_iops_per_gib : double_optional option;
    (*

    Minimum provisioned IOPS per GiB for a DB instance.

    *)
  20. max_iops_per_db_instance : integer_optional option;
    (*

    Maximum total provisioned IOPS for a DB instance.

    *)
  21. min_iops_per_db_instance : integer_optional option;
    (*

    Minimum total provisioned IOPS for a DB instance.

    *)
  22. max_storage_size : integer_optional option;
    (*

    Maximum storage size for a DB instance.

    *)
  23. min_storage_size : integer_optional option;
    (*

    Minimum storage size for a DB instance.

    *)
  24. supports_performance_insights : boolean_ option;
    (*

    Indicates whether a DB instance supports Performance Insights.

    *)
  25. supports_iam_database_authentication : boolean_ option;
    (*

    Indicates whether a DB instance supports IAM database authentication.

    *)
  26. supports_enhanced_monitoring : boolean_ option;
    (*

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

    *)
  27. supports_storage_throughput : boolean_ option;
    (*

    Indicates whether a DB instance supports storage throughput.

    *)
  28. supports_iops : boolean_ option;
    (*

    Indicates whether a DB instance supports provisioned IOPS.

    *)
  29. storage_type : string_ option;
    (*

    The storage type for a DB instance.

    *)
  30. supports_storage_encryption : boolean_ option;
    (*

    Indicates whether a DB instance supports encrypted storage.

    *)
  31. vpc : boolean_ option;
    (*

    Indicates whether a DB instance is in a VPC.

    *)
  32. read_replica_capable : boolean_ option;
    (*

    Indicates whether a DB instance can have a read replica.

    *)
  33. multi_az_capable : boolean_ option;
    (*

    Indicates whether a DB instance is Multi-AZ capable.

    *)
  34. availability_zones : availability_zone_list option;
    (*

    A list of Availability Zones for a DB instance.

    *)
  35. availability_zone_group : string_ option;
    (*

    The Availability Zone group for a DB instance.

    *)
  36. license_model : string_ option;
    (*

    The license model for a DB instance.

    *)
  37. db_instance_class : string_ option;
    (*

    The DB instance class for a DB instance.

    *)
  38. engine_version : string_ option;
    (*

    The engine version of a DB instance.

    *)
  39. engine : string_ option;
    (*

    The engine type of a DB instance.

    *)
}

Contains a list of available options for a DB instance.

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

type nonrec orderable_db_instance_options_list = orderable_db_instance_option list
type nonrec orderable_db_instance_options_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. orderable_db_instance_options : orderable_db_instance_options_list option;
    (*

    An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

    *)
}

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

type nonrec option_setting = {
  1. is_collection : boolean_ option;
    (*

    Indicates whether the option setting is part of a collection.

    *)
  2. is_modifiable : boolean_ option;
    (*

    Indicates whether the option setting can be modified from the default.

    *)
  3. allowed_values : string_ option;
    (*

    The allowed values of the option setting.

    *)
  4. data_type : string_ option;
    (*

    The data type of the option setting.

    *)
  5. apply_type : string_ option;
    (*

    The DB engine specific parameter type.

    *)
  6. description : string_ option;
    (*

    The description of the option setting.

    *)
  7. default_value : string_ option;
    (*

    The default value of the option setting.

    *)
  8. value : potentially_sensitive_option_setting_value option;
    (*

    The current value of the option setting.

    *)
  9. name : string_ option;
    (*

    The name of the option that has settings that you can set.

    *)
}

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.

type nonrec option_setting_configuration_list = option_setting list
type nonrec option_ = {
  1. vpc_security_group_memberships : vpc_security_group_membership_list option;
    (*

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

    *)
  2. db_security_group_memberships : db_security_group_membership_list option;
    (*

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

    *)
  3. option_settings : option_setting_configuration_list option;
    (*

    The option settings for this option.

    *)
  4. option_version : string_ option;
    (*

    The version of the option.

    *)
  5. port : integer_optional option;
    (*

    If required, the port configured for this option to use.

    *)
  6. permanent : boolean_ option;
    (*

    Indicates whether this option is permanent.

    *)
  7. persistent : boolean_ option;
    (*

    Indicates whether this option is persistent.

    *)
  8. option_description : string_ option;
    (*

    The description of the option.

    *)
  9. option_name : string_ option;
    (*

    The name of the option.

    *)
}

The details of an option.

type nonrec options_list = option_ list
type nonrec options_depended_on = string_ list
type nonrec options_conflicts_with = string_ list
type nonrec option_version = {
  1. is_default : boolean_ option;
    (*

    Indicates whether the version is the default version of the option.

    *)
  2. version : string_ option;
    (*

    The version of the option.

    *)
}

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

type nonrec option_settings_list = option_setting list
type nonrec option_names_list = string_ list
type nonrec option_group = {
  1. copy_timestamp : t_stamp option;
    (*

    Indicates when the option group was copied.

    *)
  2. source_account_id : string_ option;
    (*

    Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

    *)
  3. source_option_group : string_ option;
    (*

    Specifies the name of the option group from which this option group is copied.

    *)
  4. option_group_arn : string_ option;
    (*

    Specifies the Amazon Resource Name (ARN) for the option group.

    *)
  5. vpc_id : string_ option;
    (*

    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.

    *)
  6. allows_vpc_and_non_vpc_instance_memberships : boolean_ option;
    (*

    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.

    *)
  7. options : options_list option;
    (*

    Indicates what options are available in the option group.

    *)
  8. major_engine_version : string_ option;
    (*

    Indicates the major engine version associated with this option group.

    *)
  9. engine_name : string_ option;
    (*

    Indicates the name of the engine that this option group can be applied to.

    *)
  10. option_group_description : string_ option;
    (*

    Provides a description of the option group.

    *)
  11. option_group_name : string_ option;
    (*

    Specifies the name of the option group.

    *)
}
type nonrec option_groups_list = option_group list
type nonrec option_groups = {
  1. marker : string_ 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.

    *)
  2. option_groups_list : option_groups_list option;
    (*

    List of option groups.

    *)
}

List of option groups.

type nonrec option_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

The quota of 20 option groups was exceeded for this Amazon Web Services account.

type nonrec minimum_engine_version_per_allowed_value = {
  1. minimum_engine_version : string_ option;
    (*

    The minimum DB engine version required for the allowed value.

    *)
  2. allowed_value : string_ option;
    (*

    The allowed value for an option setting.

    *)
}

The minimum DB engine version required for each corresponding allowed value for an option setting.

type nonrec minimum_engine_version_per_allowed_value_list = minimum_engine_version_per_allowed_value list
type nonrec option_group_option_setting = {
  1. minimum_engine_version_per_allowed_value : minimum_engine_version_per_allowed_value_list option;
    (*

    The minimum DB engine version required for the corresponding allowed value for this option setting.

    *)
  2. is_required : boolean_ option;
    (*

    Indicates whether a value must be specified for this option setting of the option group option.

    *)
  3. is_modifiable : boolean_ option;
    (*

    Indicates whether this option group option can be changed from the default value.

    *)
  4. allowed_values : string_ option;
    (*

    Indicates the acceptable values for the option group option.

    *)
  5. apply_type : string_ option;
    (*

    The DB engine specific parameter type for the option group option.

    *)
  6. default_value : string_ option;
    (*

    The default value for the option group option.

    *)
  7. setting_description : string_ option;
    (*

    The description of the option group option.

    *)
  8. setting_name : string_ option;
    (*

    The name of the option group 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.

type nonrec option_group_option_settings_list = option_group_option_setting list
type nonrec option_group_option_versions_list = option_version list
type nonrec option_group_option = {
  1. copyable_cross_account : boolean_optional option;
    (*

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

    *)
  2. option_group_option_versions : option_group_option_versions_list option;
    (*

    The versions that are available for the option.

    *)
  3. option_group_option_settings : option_group_option_settings_list option;
    (*

    The option settings that are available (and the default value) for each option in an option group.

    *)
  4. supports_option_version_downgrade : boolean_optional option;
    (*

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

    *)
  5. vpc_only : boolean_ option;
    (*

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

    *)
  6. requires_auto_minor_engine_version_upgrade : boolean_ option;
    (*

    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.

    *)
  7. permanent : boolean_ option;
    (*

    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.

    *)
  8. persistent : boolean_ option;
    (*

    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.

    *)
  9. options_conflicts_with : options_conflicts_with option;
    (*

    The options that conflict with this option.

    *)
  10. options_depended_on : options_depended_on option;
    (*

    The options that are prerequisites for this option.

    *)
  11. default_port : integer_optional option;
    (*

    If the option requires a port, specifies the default port for the option.

    *)
  12. port_required : boolean_ option;
    (*

    Indicates whether the option requires a port.

    *)
  13. minimum_required_minor_engine_version : string_ option;
    (*

    The minimum required engine version for the option to be applied.

    *)
  14. major_engine_version : string_ option;
    (*

    Indicates the major engine version that the option is available for.

    *)
  15. engine_name : string_ option;
    (*

    The name of the engine that this option can be applied to.

    *)
  16. description : string_ option;
    (*

    The description of the option.

    *)
  17. name : string_ option;
    (*

    The name of the option.

    *)
}

Available option.

type nonrec option_group_options_list = option_group_option list
type nonrec option_group_options_message = {
  1. marker : string_ 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.

    *)
  2. option_group_options : option_group_options_list option;
}
type nonrec option_group_already_exists_fault = {
  1. message : exception_message option;
}

The option group you are trying to create already exists.

type nonrec option_configuration = {
  1. option_settings : option_settings_list option;
    (*

    The option settings to include in an option group.

    *)
  2. vpc_security_group_memberships : vpc_security_group_id_list option;
    (*

    A list of VPC security group names used for this option.

    *)
  3. db_security_group_memberships : db_security_group_name_list option;
    (*

    A list of DB security groups used for this option.

    *)
  4. option_version : string_ option;
    (*

    The version for the option.

    *)
  5. port : integer_optional option;
    (*

    The optional port for the option.

    *)
  6. option_name : string_;
    (*

    The configuration of options to include in a group.

    *)
}

A list of all available options for an option group.

type nonrec option_configuration_list = option_configuration list
type nonrec modify_tenant_database_result = {
  1. tenant_database : tenant_database option;
}
type nonrec modify_tenant_database_message = {
  1. master_user_secret_kms_key_id : string_ option;
    (*

    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 tenant database doesn't manage the master user password in Amazon Web Services Secrets Manager.

      If the tenant database 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're turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.

      If you're 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 self-managed KMS key.

    The Amazon Web Services KMS key identifier is any of the following:

    • Key ARN
    • Key ID
    • Alias ARN
    • 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.

    A default KMS key exists for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

    *)
  2. rotate_master_user_password : boolean_optional option;
    (*

    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 instance. 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.
    *)
  3. manage_master_user_password : boolean_optional option;
    (*

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

    If the tenant database 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 tenant database 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.
    *)
  4. new_tenant_db_name : string_ option;
    (*

    The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.

    Constraints:

    • Can't be the string null or any other reserved word.
    • Can't be longer than 8 characters.
    *)
  5. master_user_password : sensitive_string option;
    (*

    The new password for the master user of the specified tenant database in your DB instance.

    Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

    Constraints:

    • Can include any printable ASCII character except /, " (double quote), @, & (ampersand), and ' (single quote).

    Length constraints:

    • Must contain between 8 and 30 characters.
    *)
  6. tenant_db_name : string_;
    (*

    The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.

    Constraints:

    • Must match the identifier of an existing tenant database.
    *)
  7. db_instance_identifier : string_;
    (*

    The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing DB instance.
    *)
}
type nonrec modify_option_group_result = {
  1. option_group : option_group option;
}
type nonrec modify_option_group_message = {
  1. apply_immediately : boolean_ option;
    (*

    Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

    *)
  2. options_to_remove : option_names_list option;
    (*

    Options in this list are removed from the option group.

    *)
  3. options_to_include : option_configuration_list option;
    (*

    Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

    *)
  4. option_group_name : string_;
    (*

    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

    *)
}
type nonrec invalid_option_group_state_fault = {
  1. message : exception_message option;
}

The option group isn't in the available state.

type nonrec integration_identifier = string
type nonrec integration_name = string
type nonrec data_filter = string
type nonrec integration_description = string
type nonrec modify_integration_message = {
  1. description : integration_description option;
    (*

    A new description for the integration.

    *)
  2. data_filter : data_filter option;
    (*

    A new data filter for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift.

    *)
  3. integration_name : integration_name option;
    (*

    A new name for the integration.

    *)
  4. integration_identifier : integration_identifier;
    (*

    The unique identifier of the integration to modify.

    *)
}
type nonrec invalid_integration_state_fault = {
  1. message : exception_message option;
}

The integration is in an invalid state and can't perform the requested operation.

type nonrec integration_conflict_operation_fault = {
  1. message : exception_message option;
}

A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.

type nonrec integration_arn = string
type nonrec encryption_context_map = (string_ * string_) list
type nonrec integration_status =
  1. | NEEDS_ATTENTION
  2. | SYNCING
  3. | DELETING
  4. | FAILED
  5. | MODIFYING
  6. | ACTIVE
  7. | CREATING
type nonrec integration_error = {
  1. error_message : string_ option;
    (*

    A message explaining the error.

    *)
  2. error_code : string_;
    (*

    The error code associated with the integration.

    *)
}

An error associated with a zero-ETL integration with Amazon Redshift.

type nonrec integration_error_list = integration_error list
type nonrec integration = {
  1. errors : integration_error_list option;
    (*

    Any errors associated with the integration.

    *)
  2. create_time : t_stamp option;
    (*

    The time when the integration was created, in Universal Coordinated Time (UTC).

    *)
  3. description : integration_description option;
    (*

    A description of the integration.

    *)
  4. data_filter : data_filter option;
    (*

    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.

    *)
  5. tags : tag_list option;
  6. status : integration_status option;
    (*

    The current status of the integration.

    *)
  7. additional_encryption_context : encryption_context_map option;
    (*

    The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

    *)
  8. kms_key_id : string_ option;
    (*

    The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.

    *)
  9. integration_arn : integration_arn option;
    (*

    The ARN of the integration.

    *)
  10. integration_name : integration_name option;
    (*

    The name of the integration.

    *)
  11. target_arn : arn option;
    (*

    The ARN of the Redshift data warehouse used as the target for replication.

    *)
  12. source_arn : source_arn option;
    (*

    The Amazon Resource Name (ARN) of the database used as the source for replication.

    *)
}

A zero-ETL integration with Amazon Redshift.

type nonrec modify_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec modify_global_cluster_message = {
  1. allow_major_version_upgrade : boolean_optional option;
    (*

    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.

    *)
  2. engine_version : string_ option;
    (*

    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]'

    *)
  3. deletion_protection : boolean_optional option;
    (*

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

    *)
  4. new_global_cluster_identifier : global_cluster_identifier option;
    (*

    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

    *)
  5. global_cluster_identifier : global_cluster_identifier;
    (*

    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.
    *)
}
type nonrec global_cluster_already_exists_fault = {
  1. message : exception_message option;
}

The GlobalClusterIdentifier already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.

type nonrec modify_event_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec modify_event_subscription_message = {
  1. enabled : boolean_optional option;
    (*

    Specifies whether to activate the subscription.

    *)
  2. event_categories : event_categories_list option;
    (*

    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.

    *)
  3. source_type : string_ option;
    (*

    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 | zero-etl | custom-engine-version | blue-green-deployment

    *)
  4. sns_topic_arn : string_ option;
    (*

    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.

    *)
  5. subscription_name : string_;
    (*

    The name of the RDS event notification subscription.

    *)
}
type nonrec event_subscription_quota_exceeded_fault = {
  1. message : exception_message option;
}

You have reached the maximum number of event subscriptions.

type nonrec modify_db_subnet_group_result = {
  1. db_subnet_group : db_subnet_group option;
}
type nonrec modify_db_subnet_group_message = {
  1. subnet_ids : subnet_identifier_list;
    (*

    The EC2 subnet IDs for the DB subnet group.

    *)
  2. db_subnet_group_description : string_ option;
    (*

    The description for the DB subnet group.

    *)
  3. db_subnet_group_name : string_;
    (*

    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

    *)
}
type nonrec db_subnet_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec db_snapshot = {
  1. snapshot_availability_zone : string_ option;
    (*

    Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

    *)
  2. additional_storage_volumes : additional_storage_volumes_list option;
    (*

    The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.

    *)
  3. dedicated_log_volume : boolean_ option;
    (*

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

    *)
  4. multi_tenant : boolean_optional option;
    (*

    Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

    *)
  5. db_system_id : string_ option;
    (*

    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.

    *)
  6. snapshot_database_time : t_stamp option;
    (*

    The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

    If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

    *)
  7. original_snapshot_create_time : t_stamp option;
    (*

    Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

    *)
  8. snapshot_target : string_ option;
    (*

    Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

    *)
  9. tag_list : tag_list option;
  10. dbi_resource_id : string_ option;
    (*

    The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    *)
  11. processor_features : processor_feature_list option;
    (*

    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.

    *)
  12. iam_database_authentication_enabled : boolean_ option;
    (*

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

    *)
  13. timezone : string_ option;
    (*

    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.

    *)
  14. db_snapshot_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB snapshot.

    *)
  15. kms_key_id : string_ option;
    (*

    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.

    *)
  16. preferred_backup_window : string_ option;
    (*

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  17. backup_retention_period : integer_optional option;
    (*

    The number of days for which automatic DB snapshots are retained.

    *)
  18. storage_encryption_type : storage_encryption_type option;
    (*

    The type of encryption used to protect data at rest in the DB snapshot. Possible values:

    • none - The DB snapshot is not encrypted.
    • sse-rds - The DB snapshot is encrypted using an Amazon Web Services owned KMS key.
    • sse-kms - The DB snapshot is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
    *)
  19. encrypted : boolean_ option;
    (*

    Indicates whether the DB snapshot is encrypted.

    *)
  20. tde_credential_arn : string_ option;
    (*

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

    *)
  21. storage_type : string_ option;
    (*

    Specifies the storage type associated with DB snapshot.

    *)
  22. source_db_snapshot_identifier : string_ option;
    (*

    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.

    *)
  23. source_region : string_ option;
    (*

    The Amazon Web Services Region that the DB snapshot was created in or copied from.

    *)
  24. percent_progress : integer option;
    (*

    The percentage of the estimated data that has been transferred.

    *)
  25. option_group_name : string_ option;
    (*

    Provides the option group name for the DB snapshot.

    *)
  26. storage_throughput : integer_optional option;
    (*

    Specifies the storage throughput for the DB snapshot.

    *)
  27. iops : integer_optional option;
    (*

    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    *)
  28. snapshot_type : string_ option;
    (*

    Provides the type of the DB snapshot.

    *)
  29. license_model : string_ option;
    (*

    License model information for the restored DB instance.

    *)
  30. engine_version : string_ option;
    (*

    Specifies the version of the database engine.

    *)
  31. master_username : string_ option;
    (*

    Provides the master username for the DB snapshot.

    *)
  32. instance_create_time : t_stamp option;
    (*

    Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

    *)
  33. vpc_id : string_ option;
    (*

    Provides the VPC ID associated with the DB snapshot.

    *)
  34. availability_zone : string_ option;
    (*

    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    *)
  35. port : integer option;
    (*

    Specifies the port that the database engine was listening on at the time of the snapshot.

    *)
  36. status : string_ option;
    (*

    Specifies the status of this DB snapshot.

    *)
  37. allocated_storage : integer option;
    (*

    Specifies the allocated storage size in gibibytes (GiB).

    *)
  38. engine : string_ option;
    (*

    Specifies the name of the database engine.

    *)
  39. snapshot_create_time : t_stamp option;
    (*

    Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

    *)
  40. db_instance_identifier : string_ option;
    (*

    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    *)
  41. db_snapshot_identifier : string_ option;
    (*

    Specifies the identifier for the DB snapshot.

    *)
}

Contains the details of an Amazon RDS DB snapshot.

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

type nonrec modify_db_snapshot_result = {
  1. db_snapshot : db_snapshot option;
}
type nonrec modify_db_snapshot_message = {
  1. option_group_name : string_ option;
    (*

    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.

    *)
  2. engine_version : string_ option;
    (*

    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.

    MariaDB

    For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MariaDB DB snapshot engine version in the Amazon RDS User Guide.

    MySQL

    For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.

    Oracle

    • 21.0.0.0.ru-2025-04.rur-2025-04.r1 (supported for 21.0.0.0.ru-2022-01.rur-2022-01.r1, 21.0.0.0.ru-2022-04.rur-2022-04.r1, 21.0.0.0.ru-2022-07.rur-2022-07.r1, 21.0.0.0.ru-2022-10.rur-2022-10.r1, 21.0.0.0.ru-2023-01.rur-2023-01.r1 and 21.0.0.0.ru-2023-01.rur-2023-01.r2 DB snapshots)
    • 19.0.0.0.ru-2025-04.rur-2025-04.r1 (supported for 19.0.0.0.ru-2019-07.rur-2019-07.r1, 19.0.0.0.ru-2019-10.rur-2019-10.r1 and 0.0.0.ru-2020-01.rur-2020-01.r1 DB snapshots)
    • 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 a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.

    *)
  3. db_snapshot_identifier : string_;
    (*

    The identifier of the DB snapshot to modify.

    *)
}
type nonrec attribute_value_list = string_ list
type nonrec db_snapshot_attribute = {
  1. attribute_values : attribute_value_list option;
    (*

    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.

    *)
  2. attribute_name : string_ option;
    (*

    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.

    *)
}

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.

type nonrec db_snapshot_attribute_list = db_snapshot_attribute list
type nonrec db_snapshot_attributes_result = {
  1. db_snapshot_attributes : db_snapshot_attribute_list option;
    (*

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

    *)
  2. db_snapshot_identifier : string_ option;
    (*

    The identifier of the manual DB snapshot that the attributes apply to.

    *)
}

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.

type nonrec modify_db_snapshot_attribute_result = {
  1. db_snapshot_attributes_result : db_snapshot_attributes_result option;
}
type nonrec modify_db_snapshot_attribute_message = {
  1. values_to_remove : attribute_value_list option;
    (*

    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.

    *)
  2. values_to_add : attribute_value_list option;
    (*

    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.

    *)
  3. attribute_name : string_;
    (*

    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.

    To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.

    *)
  4. db_snapshot_identifier : string_;
    (*

    The identifier for the DB snapshot to modify the attributes for.

    *)
}
type nonrec modify_db_shard_group_message = {
  1. compute_redundancy : integer_optional option;
    (*

    Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

    • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
    • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
    • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
    *)
  2. min_ac_u : double_optional option;
    (*

    The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

    *)
  3. max_ac_u : double_optional option;
    (*

    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

    *)
  4. db_shard_group_identifier : db_shard_group_identifier;
    (*

    The name of the DB shard group to modify.

    *)
}
type nonrec db_shard_group_already_exists_fault = {
  1. message : exception_message option;
}

The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.

type nonrec modify_db_recommendation_message = {
  1. recommended_action_updates : recommended_action_update_list option;
    (*

    The list of recommended action status to update. You can update multiple recommended actions at one time.

    *)
  2. status : string_ option;
    (*

    The recommendation status to update.

    Valid values:

    • active
    • dismissed
    *)
  3. locale : string_ option;
    (*

    The language of the modified recommendation.

    *)
  4. recommendation_id : string_;
    (*

    The identifier of the recommendation to update.

    *)
}

A link to documentation that provides additional information for a recommendation.

type nonrec db_recommendation = {
  1. issue_details : issue_details option;
    (*

    Details of the issue that caused the recommendation.

    *)
  2. additional_info : string_ option;
    (*

    Additional information about the recommendation. The information might contain markdown.

    *)
  3. impact : string_ option;
    (*

    A short description that explains the possible impact of an issue.

    *)
  4. type_recommendation : string_ option;
    (*

    A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.

    *)
  5. type_detection : string_ option;
    (*

    A short description of the recommendation type. The description might contain markdown.

    *)
  6. source : string_ option;
    (*

    The Amazon Web Services service that generated the recommendations.

    *)
  7. category : string_ option;
    (*

    The category of the recommendation.

    Valid values:

    • performance efficiency
    • security
    • reliability
    • cost optimization
    • operational excellence
    • sustainability
    *)
  8. recommended_actions : recommended_action_list option;
    (*

    A list of recommended actions.

    *)
  9. reason : string_ option;
    (*

    The reason why this recommendation was created. The information might contain markdown.

    *)
  10. description : string_ option;
    (*

    A detailed description of the recommendation. The description might contain markdown.

    *)
  11. recommendation : string_ option;
    (*

    A short description of the recommendation to resolve an issue. The description might contain markdown.

    *)
  12. detection : string_ option;
    (*

    A short description of the issue identified for this recommendation. The description might contain markdown.

    *)
  13. updated_time : t_stamp option;
    (*

    The time when the recommendation was last updated.

    *)
  14. created_time : t_stamp option;
    (*

    The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.

    *)
  15. status : string_ option;
    (*

    The current status of the recommendation.

    Valid values:

    • active - The recommendations which are ready for you to apply.
    • pending - The applied or scheduled recommendations which are in progress.
    • resolved - The recommendations which are completed.
    • dismissed - The recommendations that you dismissed.
    *)
  16. resource_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.

    *)
  17. severity : string_ option;
    (*

    The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.

    Valid values:

    • high
    • medium
    • low
    • informational
    *)
  18. type_id : string_ option;
    (*

    A value that indicates the type of recommendation. This value determines how the description is rendered.

    *)
  19. recommendation_id : string_ option;
    (*

    The unique identifier of the recommendation.

    *)
}

The recommendation for your DB instances, DB clusters, and DB parameter groups.

type nonrec db_recommendation_message = {
  1. db_recommendation : db_recommendation option;
}
type nonrec modify_db_proxy_target_group_response = {
  1. db_proxy_target_group : db_proxy_target_group option;
    (*

    The settings of the modified DBProxyTarget.

    *)
}
type nonrec connection_pool_configuration = {
  1. init_query : operator_sensitive_string option;
    (*

    Add an initialization query, or modify the current one. You can specify one or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with SET statements to make sure that each connection has identical settings. Make sure the query added here is valid. This is an optional field, so you can choose to leave it empty. For including multiple variables in a single SET statement, use a comma separator.

    For example: SET variable1=value1, variable2=value2

    Default: no initialization query

    Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.

    *)
  2. session_pinning_filters : string_list option;
    (*

    Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.

    Default: no session pinning filters

    *)
  3. connection_borrow_timeout : integer_optional option;
    (*

    The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

    Default: 120

    Constraints:

    • Must be between 0 and 300.
    *)
  4. max_idle_connections_percent : integer_optional option;
    (*

    A value that 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.
    *)
  5. max_connections_percent : integer_optional option;
    (*

    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.
    *)
}

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

type nonrec modify_db_proxy_target_group_request = {
  1. new_name : string_ option;
    (*

    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.

    You can't rename the default target group.

    *)
  2. connection_pool_config : connection_pool_configuration option;
    (*

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

    *)
  3. db_proxy_name : db_proxy_name;
    (*

    The name of the proxy.

    *)
  4. target_group_name : db_proxy_target_group_name;
    (*

    The name of the target group to modify.

    *)
}
type nonrec db_proxy_status =
  1. | REACTIVATING
  2. | SUSPENDING
  3. | SUSPENDED
  4. | DELETING
  5. | CREATING
  6. | INSUFFICIENT_RESOURCE_LIMITS
  7. | INCOMPATIBLE_NETWORK
  8. | MODIFYING
  9. | AVAILABLE
type nonrec endpoint_network_type =
  1. | DUAL
  2. | IPV6
  3. | IPV4
type nonrec db_proxy = {
  1. target_connection_network_type : target_connection_network_type option;
    (*

    The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

    Valid values:

    • IPV4 - The proxy connects to the database using IPv4 only.
    • IPV6 - The proxy connects to the database using IPv6 only.
    *)
  2. endpoint_network_type : endpoint_network_type option;
    (*

    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

    Valid values:

    • IPV4 - The proxy endpoint supports IPv4 only.
    • IPV6 - The proxy endpoint supports IPv6 only.
    • DUAL - The proxy endpoint supports both IPv4 and IPv6.
    *)
  3. updated_date : t_stamp option;
    (*

    The date and time when the proxy was last updated.

    *)
  4. created_date : t_stamp option;
    (*

    The date and time when the proxy was first created.

    *)
  5. debug_logging : boolean_ option;
    (*

    Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

    *)
  6. idle_client_timeout : integer option;
    (*

    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

    *)
  7. require_tl_s : boolean_ option;
    (*

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

    *)
  8. endpoint : string_ option;
    (*

    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.

    *)
  9. role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

    *)
  10. auth : user_auth_config_info_list option;
    (*

    One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

    *)
  11. default_auth_scheme : string_ option;
    (*

    The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.

    *)
  12. vpc_subnet_ids : string_list option;
    (*

    The EC2 subnet IDs for the proxy.

    *)
  13. vpc_security_group_ids : string_list option;
    (*

    Provides a list of VPC security groups that the proxy belongs to.

    *)
  14. vpc_id : string_ option;
    (*

    Provides the VPC ID of the DB proxy.

    *)
  15. engine_family : string_ option;
    (*

    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.

    *)
  16. status : db_proxy_status option;
    (*

    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.

    *)
  17. db_proxy_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the proxy.

    *)
  18. db_proxy_name : string_ option;
    (*

    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 data structure representing a proxy managed by the RDS Proxy.

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

type nonrec modify_db_proxy_response = {
  1. db_proxy : db_proxy option;
    (*

    The DBProxy object representing the new settings for the proxy.

    *)
}
type nonrec default_auth_scheme =
  1. | NONE
  2. | IAM_AUTH
type nonrec modify_db_proxy_request = {
  1. security_groups : string_list option;
    (*

    The new list of security groups for the DBProxy.

    *)
  2. role_arn : arn option;
    (*

    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

    *)
  3. debug_logging : boolean_optional option;
    (*

    Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

    *)
  4. idle_client_timeout : integer_optional option;
    (*

    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.

    *)
  5. require_tl_s : boolean_optional option;
    (*

    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.

    *)
  6. auth : user_auth_config_list option;
    (*

    The new authentication settings for the DBProxy.

    *)
  7. default_auth_scheme : default_auth_scheme option;
    (*

    The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.

    *)
  8. new_db_proxy_name : db_proxy_name option;
    (*

    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.

    *)
  9. db_proxy_name : db_proxy_name;
    (*

    The identifier for the DBProxy to modify.

    *)
}
type nonrec db_proxy_endpoint_status =
  1. | DELETING
  2. | CREATING
  3. | INSUFFICIENT_RESOURCE_LIMITS
  4. | INCOMPATIBLE_NETWORK
  5. | MODIFYING
  6. | AVAILABLE
type nonrec db_proxy_endpoint_target_role =
  1. | READ_ONLY
  2. | READ_WRITE
type nonrec db_proxy_endpoint = {
  1. endpoint_network_type : endpoint_network_type option;
    (*

    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

    Valid values:

    • IPV4 - The proxy endpoint supports IPv4 only.
    • IPV6 - The proxy endpoint supports IPv6 only.
    • DUAL - The proxy endpoint supports both IPv4 and IPv6.
    *)
  2. is_default : boolean_ option;
    (*

    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.

    *)
  3. target_role : db_proxy_endpoint_target_role option;
    (*

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

    *)
  4. created_date : t_stamp option;
    (*

    The date and time when the DB proxy endpoint was first created.

    *)
  5. endpoint : string_ option;
    (*

    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.

    *)
  6. vpc_subnet_ids : string_list option;
    (*

    The EC2 subnet IDs for the DB proxy endpoint.

    *)
  7. vpc_security_group_ids : string_list option;
    (*

    Provides a list of VPC security groups that the DB proxy endpoint belongs to.

    *)
  8. vpc_id : string_ option;
    (*

    Provides the VPC ID of the DB proxy endpoint.

    *)
  9. status : db_proxy_endpoint_status option;
    (*

    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.

    *)
  10. db_proxy_name : string_ option;
    (*

    The identifier for the DB proxy that is associated with this DB proxy endpoint.

    *)
  11. db_proxy_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB proxy endpoint.

    *)
  12. db_proxy_endpoint_name : string_ option;
    (*

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

type nonrec modify_db_proxy_endpoint_response = {
  1. db_proxy_endpoint : db_proxy_endpoint option;
    (*

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

    *)
}
type nonrec db_proxy_endpoint_name = string
type nonrec modify_db_proxy_endpoint_request = {
  1. vpc_security_group_ids : string_list option;
    (*

    The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.

    *)
  2. new_db_proxy_endpoint_name : db_proxy_endpoint_name option;
    (*

    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.

    *)
  3. db_proxy_endpoint_name : db_proxy_endpoint_name;
    (*

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

    *)
}
type nonrec invalid_db_proxy_endpoint_state_fault = {
  1. message : exception_message option;
}

You can't perform this operation while the DB proxy endpoint is in a particular state.

type nonrec db_proxy_endpoint_already_exists_fault = {
  1. message : exception_message option;
}

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.

type nonrec db_proxy_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec modify_db_parameter_group_message = {
  1. parameters : parameters_list;
    (*

    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.

    You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

    For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.

    *)
  2. db_parameter_group_name : string_;
    (*

    The name of the DB parameter group.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.
    *)
}
type nonrec modify_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec cloudwatch_logs_export_configuration = {
  1. disable_log_types : log_type_list option;
    (*

    The list of log types to disable.

    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
    *)
  2. enable_log_types : log_type_list option;
    (*

    The list of log types to enable.

    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
    *)
}

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.

type nonrec aws_backup_recovery_point_arn = string
type nonrec modify_additional_storage_volume = {
  1. set_for_delete : boolean_optional option;
    (*

    Indicates whether to delete the additional storage volume. The value true schedules the volume for deletion. You can delete an additional storage volume only when it doesn't contain database files or other data.

    *)
  2. storage_type : string_ option;
    (*

    The new storage type for the additional storage volume.

    Valid Values: GP3 | IO2

    *)
  3. storage_throughput : integer_optional option;
    (*

    The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD (gp3) storage type.

    *)
  4. max_allocated_storage : integer_optional option;
    (*

    The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume. You must provide a value greater than or equal to AllocatedStorage.

    *)
  5. iop_s : integer_optional option;
    (*

    The number of I/O operations per second (IOPS) provisioned for the additional storage volume. This setting is only supported for Provisioned IOPS SSD (io1 and io2) storage types.

    *)
  6. allocated_storage : integer_optional option;
    (*

    The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).

    *)
  7. volume_name : string_;
    (*

    The name of the additional storage volume that you want to modify.

    Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4

    *)
}

Contains details about the modification of an additional storage volume.

type nonrec modify_additional_storage_volumes_list = modify_additional_storage_volume list
type nonrec master_user_authentication_type =
  1. | IAM_DB_AUTH
  2. | PASSWORD
type nonrec modify_db_instance_message = {
  1. master_user_authentication_type : master_user_authentication_type option;
    (*

    Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication.

    You can specify one of the following values:

    • password - Use standard database authentication with a password.
    • iam-db-auth - Use IAM database authentication for the master user.

    This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.

    *)
  2. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB instance.

    Valid Values:

    • auto-backup - The DB instance's automated backup.
    *)
  3. additional_storage_volumes : modify_additional_storage_volumes_list option;
    (*

    A list of additional storage volumes to modify or delete for the DB instance. You can create up to 3 additional storage volumes. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.

    *)
  4. engine : string_ option;
    (*

    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.
    *)
  5. dedicated_log_volume : boolean_optional option;
    (*

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

    *)
  6. multi_tenant : boolean_optional option;
    (*

    Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.

    During the conversion, RDS creates an initial tenant database and associates the DB name, master user name, character set, and national character set metadata with this database. The tags associated with the instance also propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the CreateTenantDatabase operation.

    The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert back to the single-tenant configuration. When you specify this parameter, you must also specify ApplyImmediately.

    *)
  7. master_user_secret_kms_key_id : string_ option;
    (*

    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.

    *)
  8. rotate_master_user_password : boolean_optional option;
    (*

    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 instance. 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.
    *)
  9. manage_master_user_password : boolean_optional option;
    (*

    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.
    • Can't specify for RDS for Oracle CDB instances in the multi-tenant configuration. Use ModifyTenantDatabase instead.
    • Can't specify the parameters ManageMasterUserPassword and MultiTenant in the same operation.
    *)
  10. aws_backup_recovery_point_arn : aws_backup_recovery_point_arn option;
    (*

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

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

    *)
  11. network_type : string_ option;
    (*

    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

    *)
  12. enable_customer_owned_ip : boolean_optional option;
    (*

    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.

    *)
  13. resume_full_automation_mode_minutes : integer_optional option;
    (*

    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.
    *)
  14. automation_mode : automation_mode option;
    (*

    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.

    *)
  15. replica_mode : replica_mode option;
    (*

    The open mode of a replica database.

    This parameter is only supported for Db2 DB instances and Oracle DB instances.

    Db2 Standby DB replicas are included in Db2 Advanced Edition (AE), Db2 Community Edition (CE), and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload.

    You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide.

    To create standby DB replicas for RDS for Db2, set this parameter to mounted.

    Oracle 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 read replicas for Amazon RDS for Oracle 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.

    *)
  16. certificate_rotation_restart : boolean_optional option;
    (*

    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.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

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

    *)
  17. max_allocated_storage : integer_optional option;
    (*

    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.

    *)
  18. deletion_protection : boolean_optional option;
    (*

    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 ModifyDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

    *)
  19. use_default_processor_features : boolean_optional option;
    (*

    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.

    *)
  20. processor_features : processor_feature_list option;
    (*

    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.

    *)
  21. cloudwatch_logs_export_configuration : cloudwatch_logs_export_configuration option;
    (*

    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.

    The following values are valid for each DB engine:

    • Aurora MySQL - audit | error | general | slowquery | iam-db-auth-error
    • Aurora PostgreSQL - postgresql | iam-db-auth-error
    • RDS for MySQL - error | general | slowquery | iam-db-auth-error
    • RDS for PostgreSQL - postgresql | upgrade | iam-db-auth-error

    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.

    *)
  22. performance_insights_retention_period : integer_optional option;
    (*

    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.

    *)
  23. performance_insights_kms_key_id : string_ option;
    (*

    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.

    *)
  24. enable_performance_insights : boolean_optional option;
    (*

    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.

    *)
  25. database_insights_mode : database_insights_mode option;
    (*

    Specifies the mode of Database Insights to enable for the DB instance.

    Aurora DB instances inherit this value from the DB cluster, so you can't change this value.

    *)
  26. enable_iam_database_authentication : boolean_optional option;
    (*

    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.

    *)
  27. promotion_tier : integer_optional option;
    (*

    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

    *)
  28. domain_iam_role_name : string_ option;
    (*

    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.

    *)
  29. monitoring_role_arn : string_ option;
    (*

    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.

    *)
  30. publicly_accessible : boolean_optional option;
    (*

    Specifies whether the DB instance is publicly accessible.

    When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't 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.

    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.

    *)
  31. db_port_number : integer_optional option;
    (*

    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 Db2 - 50000
    • 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.
    *)
  32. monitoring_interval : integer_optional option;
    (*

    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

    *)
  33. copy_tags_to_snapshot : boolean_optional option;
    (*

    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.

    *)
  34. disable_domain : boolean_optional option;
    (*

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

    *)
  35. domain_dns_ips : string_list option;
    (*

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

    Constraints:

    • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    Example: 123.124.125.126,234.235.236.237

    *)
  36. domain_auth_secret_arn : string_ option;
    (*

    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

    *)
  37. domain_ou : string_ option;
    (*

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

    Constraints:

    • Must be in the distinguished name format.

    Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    *)
  38. domain_fqdn : string_ option;
    (*

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

    Constraints:

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    *)
  39. domain : string_ option;
    (*

    The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

    For more information, see Kerberos Authentication in the Amazon RDS User Guide.

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

    *)
  40. ca_certificate_identifier : string_ option;
    (*

    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.

    *)
  41. tde_credential_password : sensitive_string option;
    (*

    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.

    *)
  42. tde_credential_arn : string_ option;
    (*

    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.

    *)
  43. storage_type : string_ option;
    (*

    The storage type to associate with the DB instance.

    If you specify io1, io2, or gp3 you must also include a value for the Iops parameter.

    If you choose to migrate your DB instance from using standard storage to gp2 (General Purpose SSD), gp3, or Provisioned IOPS (io1), or from these storage types to 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 | io2 | standard

    Default: io1, if the Iops parameter is specified. Otherwise, gp2.

    *)
  44. new_db_instance_identifier : string_ option;
    (*

    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

    *)
  45. option_group_name : string_ option;
    (*

    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.

    *)
  46. storage_throughput : integer_optional option;
    (*

    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.

    *)
  47. iops : integer_optional option;
    (*

    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 Provisioned IOPS (io1), or from Provisioned IOPS to 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.
    • When you increase the Provisioned IOPS, you must also specify the AllocatedStorage parameter. You can use the current value for AllocatedStorage.

    Default: Uses existing setting

    *)
  48. license_model : string_ option;
    (*

    The license model for the DB instance.

    This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

    Valid Values:

    • RDS for Db2 - bring-your-own-license
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included | bring-your-own-media
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license | license-included
    • RDS for PostgreSQL - postgresql-license
    *)
  49. auto_minor_version_upgrade : boolean_optional option;
    (*

    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.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  50. allow_major_version_upgrade : boolean_ option;
    (*

    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.
    *)
  51. engine_version : string_ option;
    (*

    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.

    Constraints:

    • If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
    *)
  52. multi_a_z : boolean_optional option;
    (*

    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.

    *)
  53. preferred_maintenance_window : string_ option;
    (*

    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.
    *)
  54. preferred_backup_window : string_ option;
    (*

    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.
    *)
  55. backup_retention_period : integer_optional option;
    (*

    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.

    Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

    These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

    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.
    *)
  56. db_parameter_group_name : string_ option;
    (*

    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.
    *)
  57. master_user_password : sensitive_string option;
    (*

    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.

    Amazon RDS API operations never return the password, so this operation provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

    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

    • RDS for Oracle CDBs in the multi-tenant configuration

      Specify the master password in ModifyTenantDatabase instead.

    Default: Uses existing setting

    Constraints:

    • Can't be specified if ManageMasterUserPassword is turned on.
    • Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.

    Length Constraints:

    • RDS for Db2 - Must contain from 8 to 255 characters.
    • 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.
    *)
  58. apply_immediately : boolean_ option;
    (*

    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.

    *)
  59. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

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

    • Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.)
    • RDS Custom

    Constraints:

    • If supplied, must match existing VPC security group IDs.
    *)
  60. db_security_groups : db_security_group_name_list option;
    (*

    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.
    *)
  61. db_subnet_group_name : string_ option;
    (*

    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 setting doesn't apply to RDS Custom DB instances.

    Constraints:

    • If supplied, must match existing DB subnet group.

    Example: mydbsubnetgroup

    *)
  62. db_instance_class : string_ option;
    (*

    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

    Constraints:

    • If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
    *)
  63. allocated_storage : integer_optional option;
    (*

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

    For RDS for Db2, 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.

    Constraints:

    • When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3, io1, or io2 storage type), you must also specify the Iops parameter. You can use the current value for Iops.
    *)
  64. db_instance_identifier : string_;
    (*

    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.
    *)
}
type nonrec db_upgrade_dependency_failure_fault = {
  1. message : exception_message option;
}

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

type nonrec db_cluster_snapshot_attribute = {
  1. attribute_values : attribute_value_list option;
    (*

    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.

    *)
  2. attribute_name : string_ option;
    (*

    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.

    *)
}

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.

type nonrec db_cluster_snapshot_attribute_list = db_cluster_snapshot_attribute list
type nonrec db_cluster_snapshot_attributes_result = {
  1. db_cluster_snapshot_attributes : db_cluster_snapshot_attribute_list option;
    (*

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

    *)
  2. db_cluster_snapshot_identifier : string_ option;
    (*

    The identifier of the manual DB cluster snapshot that the attributes apply to.

    *)
}

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.

type nonrec modify_db_cluster_snapshot_attribute_result = {
  1. db_cluster_snapshot_attributes_result : db_cluster_snapshot_attributes_result option;
}
type nonrec modify_db_cluster_snapshot_attribute_message = {
  1. values_to_remove : attribute_value_list option;
    (*

    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.

    *)
  2. values_to_add : attribute_value_list option;
    (*

    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.

    *)
  3. attribute_name : string_;
    (*

    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.

    To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.

    *)
  4. db_cluster_snapshot_identifier : string_;
    (*

    The identifier for the DB cluster snapshot to modify the attributes for.

    *)
}
type nonrec modify_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec modify_db_cluster_parameter_group_message = {
  1. parameters : parameters_list;
    (*

    A list of parameters in the DB cluster parameter group to modify.

    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 clusters 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 clusters associated with the parameter group.

    *)
  2. db_cluster_parameter_group_name : string_;
    (*

    The name of the DB cluster parameter group to modify.

    *)
}
type nonrec modify_db_cluster_message = {
  1. master_user_authentication_type : master_user_authentication_type option;
    (*

    Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication.

    You can specify one of the following values:

    • password - Use standard database authentication with a password.
    • iam-db-auth - Use IAM database authentication for the master user.

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

    This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.

    *)
  2. ca_certificate_identifier : string_ option;
    (*

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

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

    Valid for Cluster Type: Multi-AZ DB clusters

    *)
  3. enable_limitless_database : boolean_optional option;
    (*

    Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

    Valid for: Aurora DB clusters only

    This setting is no longer used. Instead use the ClusterScalabilityType setting when you create your Aurora Limitless Database DB cluster.

    *)
  4. aws_backup_recovery_point_arn : aws_backup_recovery_point_arn option;
    (*

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

    *)
  5. allow_engine_mode_change : boolean_ option;
    (*

    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.
    *)
  6. engine_mode : string_ option;
    (*

    The DB engine mode of the DB cluster, either provisioned or serverless.

    The DB engine mode can be modified only from serverless to provisioned.

    For more information, see CreateDBCluster.

    Valid for Cluster Type: Aurora DB clusters only

    *)
  7. master_user_secret_kms_key_id : string_ option;
    (*

    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

    *)
  8. enable_local_write_forwarding : boolean_optional option;
    (*

    Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

    Valid for: Aurora DB clusters only

    *)
  9. rotate_master_user_password : boolean_optional option;
    (*

    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.
    *)
  10. manage_master_user_password : boolean_optional option;
    (*

    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

    *)
  11. performance_insights_retention_period : integer_optional option;
    (*

    The number of days to retain Performance Insights data.

    Valid for Cluster Type: Aurora DB clusters and 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

    If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

    *)
  12. performance_insights_kms_key_id : string_ option;
    (*

    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: Aurora DB clusters and Multi-AZ DB clusters

    *)
  13. enable_performance_insights : boolean_optional option;
    (*

    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: Aurora DB clusters and Multi-AZ DB clusters

    *)
  14. database_insights_mode : database_insights_mode option;
    (*

    Specifies the mode of Database Insights to enable for the DB cluster.

    If you change the value from standard to advanced, you must set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.

    If you change the value from advanced to standard, you can set the PerformanceInsightsEnabled parameter to true to collect detailed database counter and per-query metrics.

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

    *)
  15. monitoring_role_arn : string_ option;
    (*

    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

    *)
  16. monitoring_interval : integer_optional option;
    (*

    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

    *)
  17. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
  18. network_type : string_ option;
    (*

    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

    *)
  19. auto_minor_version_upgrade : boolean_optional option;
    (*

    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: Aurora DB clusters and Multi-AZ DB clusters.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  20. iops : integer_optional option;
    (*

    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.
    *)
  21. storage_type : string_ option;
    (*

    The storage type to associate with the DB cluster.

    For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.

    When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

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

    Valid Values:

    • Aurora DB clusters - aurora | aurora-iopt1
    • Multi-AZ DB clusters - io1 | io2 | gp3

    Default:

    • Aurora DB clusters - aurora
    • Multi-AZ DB clusters - io1
    *)
  22. allocated_storage : integer_optional option;
    (*

    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

    *)
  23. db_cluster_instance_class : string_ option;
    (*

    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

    *)
  24. enable_global_write_forwarding : boolean_optional option;
    (*

    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

    *)
  25. copy_tags_to_snapshot : boolean_optional option;
    (*

    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

    *)
  26. enable_http_endpoint : boolean_optional option;
    (*

    Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.

    When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

    For more information, see Using RDS Data API in the Amazon Aurora User Guide.

    This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.

    Valid for Cluster Type: Aurora DB clusters only

    *)
  27. deletion_protection : boolean_optional option;
    (*

    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

    *)
  28. scaling_configuration : scaling_configuration option;
    (*

    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

    *)
  29. domain_iam_role_name : string_ option;
    (*

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

    Valid for Cluster Type: Aurora DB clusters only

    *)
  30. domain : string_ option;
    (*

    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

    *)
  31. db_instance_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group to apply to all instances of the DB cluster.

    When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.

    Valid for Cluster Type: Aurora DB clusters only

    Default: The existing name setting

    Constraints:

    • The DB parameter group must be in the same DB parameter group family as this DB cluster.
    • The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
    *)
  32. allow_major_version_upgrade : boolean_ option;
    (*

    Specifies whether major version upgrades are allowed.

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

    Constraints:

    • You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    *)
  33. engine_version : string_ option;
    (*

    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

    *)
  34. cloudwatch_logs_export_configuration : cloudwatch_logs_export_configuration option;
    (*

    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 | instance | slowquery | iam-db-auth-error
    • Aurora PostgreSQL - instance | postgresql | iam-db-auth-error
    • RDS for MySQL - error | general | slowquery | iam-db-auth-error
    • RDS for PostgreSQL - postgresql | upgrade | iam-db-auth-error

    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.

    *)
  35. backtrack_window : long_optional option;
    (*

    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).
    *)
  36. enable_iam_database_authentication : boolean_optional option;
    (*

    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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.

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

    *)
  37. preferred_maintenance_window : string_ option;
    (*

    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.
    *)
  38. preferred_backup_window : string_ option;
    (*

    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.
    *)
  39. option_group_name : string_ option;
    (*

    The option group to associate the DB cluster with.

    DB clusters are associated with a default option group that can't be modified.

    *)
  40. master_user_password : sensitive_string option;
    (*

    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.
    *)
  41. port : integer_optional option;
    (*

    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.

    *)
  42. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of EC2 VPC security groups to associate with this DB cluster.

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

    *)
  43. db_cluster_parameter_group_name : string_ option;
    (*

    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

    *)
  44. backup_retention_period : integer_optional option;
    (*

    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.
    *)
  45. apply_immediately : boolean_ option;
    (*

    Specifies whether the modifications in this request 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

    *)
  46. new_db_cluster_identifier : string_ option;
    (*

    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

    *)
  47. db_cluster_identifier : string_;
    (*

    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.
    *)
}
type nonrec modify_db_cluster_endpoint_message = {
  1. excluded_members : string_list option;
    (*

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    *)
  2. static_members : string_list option;
    (*

    List of DB instance identifiers that are part of the custom endpoint group.

    *)
  3. endpoint_type : string_ option;
    (*

    The type of the endpoint. One of: READER, WRITER, ANY.

    *)
  4. db_cluster_endpoint_identifier : string_;
    (*

    The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

    *)
}
type nonrec db_cluster_endpoint_not_found_fault = {
  1. message : exception_message option;
}

The specified custom endpoint doesn't exist.

type nonrec db_cluster_endpoint = {
  1. db_cluster_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the endpoint.

    *)
  2. excluded_members : string_list option;
    (*

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    *)
  3. static_members : string_list option;
    (*

    List of DB instance identifiers that are part of the custom endpoint group.

    *)
  4. custom_endpoint_type : string_ option;
    (*

    The type associated with a custom endpoint. One of: READER, WRITER, ANY.

    *)
  5. endpoint_type : string_ option;
    (*

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

    *)
  6. status : string_ option;
    (*

    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.

    *)
  7. endpoint : string_ option;
    (*

    The DNS address of the endpoint.

    *)
  8. db_cluster_endpoint_resource_identifier : string_ option;
    (*

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

    *)
  9. db_cluster_identifier : string_ option;
    (*

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    *)
  10. db_cluster_endpoint_identifier : string_ option;
    (*

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

    *)
}

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.

type nonrec custom_engine_name = string
type nonrec custom_engine_version = string
type nonrec custom_engine_version_status =
  1. | Inactive_except_restore
  2. | Inactive
  3. | Available
type nonrec modify_custom_db_engine_version_message = {
  1. status : custom_engine_version_status option;
    (*

    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.

    *)
  2. description : description option;
    (*

    An optional description of your CEV.

    *)
  3. engine_version : custom_engine_version;
    (*

    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.

    *)
  4. engine : custom_engine_name;
    (*

    The database engine.

    RDS Custom for Oracle supports the following values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    • custom-oracle-se2
    • custom-oracle-se2-cdb

    RDS Custom for SQL Server supports the following values:

    • custom-sqlserver-ee
    • custom-sqlserver-se
    • custom-sqlserver-web
    • custom-sqlserver-dev

    RDS for SQL Server supports the following values:

    • sqlserver-ee (Bring Your Own Media)
    • sqlserver-se (Bring Your Own Media)
    • sqlserver-dev-ee
    *)
}
type nonrec invalid_custom_db_engine_version_state_fault = {
  1. message : exception_message option;
}

You can't delete the CEV.

type nonrec custom_db_engine_version_not_found_fault = {
  1. message : exception_message option;
}

The specified CEV was not found.

type nonrec custom_db_engine_version_manifest = string
type nonrec custom_db_engine_version_am_i = {
  1. status : string_ option;
    (*

    A value that indicates the status of a custom engine version (CEV).

    *)
  2. image_id : string_ option;
    (*

    A value that indicates the ID of the AMI.

    *)
}

A value that indicates the AMI information.

type nonrec feature_name_list = string_ list
type nonrec ca_certificate_identifiers_list = string_ list
type nonrec db_engine_version = {
  1. serverless_v2_features_support : serverless_v2_features_support option;
    (*

    Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.

    *)
  2. supports_integrations : boolean_ option;
    (*

    Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

    *)
  3. supports_local_write_forwarding : boolean_optional option;
    (*

    Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

    Valid for: Aurora DB clusters only

    *)
  4. supported_ca_certificate_identifiers : ca_certificate_identifiers_list option;
    (*

    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.

    *)
  5. supports_certificate_rotation_without_restart : boolean_optional option;
    (*

    Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

    *)
  6. supports_limitless_database : boolean_ option;
    (*

    Indicates whether the DB engine version supports Aurora Limitless Database.

    *)
  7. supports_babelfish : boolean_ option;
    (*

    Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

    *)
  8. tag_list : tag_list option;
  9. supports_global_databases : boolean_ option;
    (*

    Indicates whether you can use Aurora global databases with a specific DB engine version.

    *)
  10. supports_parallel_query : boolean_ option;
    (*

    Indicates whether you can use Aurora parallel query with a specific DB engine version.

    *)
  11. status : string_ option;
    (*

    The status of the DB engine version, either available or deprecated.

    *)
  12. supported_feature_names : feature_name_list option;
    (*

    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.

    *)
  13. supported_engine_modes : engine_mode_list option;
    (*

    A list of the supported DB engine modes.

    *)
  14. supports_read_replica : boolean_ option;
    (*

    Indicates whether the database engine version supports read replicas.

    *)
  15. supports_log_exports_to_cloudwatch_logs : boolean_ option;
    (*

    Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

    *)
  16. exportable_log_types : log_type_list option;
    (*

    The types of logs that the database engine has available for export to CloudWatch Logs.

    *)
  17. supported_timezones : supported_timezones_list option;
    (*

    A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

    *)
  18. valid_upgrade_target : valid_upgrade_target_list option;
    (*

    A list of engine versions that this database engine version can be upgraded to.

    *)
  19. supported_nchar_character_sets : supported_character_sets_list option;
    (*

    A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

    *)
  20. supported_character_sets : supported_character_sets_list option;
    (*

    A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

    *)
  21. create_time : t_stamp option;
    (*

    The creation time of the DB engine version.

    *)
  22. kms_key_id : string_ option;
    (*

    The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

    *)
  23. db_engine_media_type : string_ option;
    (*

    The source of the installation media for this engine version. A value of Customer Provided indicates that the engine version was created from customer-supplied installation media using CreateCustomDBEngineVersion. Applicable to RDS Custom for SQL Server and to RDS for SQL Server engine versions (sqlserver-ee and sqlserver-se with the bring-your-own-media license model, and sqlserver-dev-ee).

    *)
  24. image : custom_db_engine_version_am_i option;
    (*

    The EC2 image

    *)
  25. failure_reason : string_ option;
    (*

    The reason that the custom engine version creation failed with an incompatible-installation-media status. Applicable to RDS for SQL Server engine versions (sqlserver-ee, sqlserver-se, and sqlserver-dev-ee).

    *)
  26. default_character_set : character_set option;
    (*

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

    *)
  27. db_engine_version_description : string_ option;
    (*

    The description of the database engine version.

    *)
  28. db_engine_version_arn : string_ option;
    (*

    The ARN of the custom engine version.

    *)
  29. db_engine_description : string_ option;
    (*

    The description of the database engine.

    *)
  30. db_parameter_group_family : string_ option;
    (*

    The name of the DB parameter group family for the database engine.

    *)
  31. custom_db_engine_version_manifest : custom_db_engine_version_manifest option;
    (*

    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.

    *)
  32. database_installation_files : string_list option;
    (*

    The database installation files (ISO and EXE) that were uploaded to Amazon S3 and used to import the database engine version to Amazon RDS. Returned for RDS for SQL Server engine versions (sqlserver-ee, sqlserver-se, and sqlserver-dev-ee) created from customer-supplied installation media.

    *)
  33. database_installation_files_s3_prefix : string_ option;
    (*

    The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

    *)
  34. database_installation_files_s3_bucket_name : string_ option;
    (*

    The name of the Amazon S3 bucket that contains your database installation files.

    *)
  35. engine_version : string_ option;
    (*

    The version number of the database engine.

    *)
  36. major_engine_version : string_ option;
    (*

    The major engine version of the CEV.

    *)
  37. engine : string_ option;
    (*

    The name of the database engine.

    *)
}

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

type nonrec modify_current_db_cluster_capacity_message = {
  1. timeout_action : string_ option;
    (*

    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.

    *)
  2. seconds_before_timeout : integer_optional option;
    (*

    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.

    *)
  3. capacity : integer_optional option;
    (*

    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.
    *)
  4. db_cluster_identifier : string_;
    (*

    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.
    *)
}
type nonrec invalid_db_cluster_capacity_fault = {
  1. message : exception_message option;
}

Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

type nonrec db_cluster_capacity_info = {
  1. timeout_action : string_ option;
    (*

    The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

    *)
  2. seconds_before_timeout : integer_optional option;
    (*

    The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

    *)
  3. current_capacity : integer_optional option;
    (*

    The current capacity of the DB cluster.

    *)
  4. pending_capacity : integer_optional option;
    (*

    A value that specifies the capacity that the DB cluster scales to next.

    *)
  5. db_cluster_identifier : string_ option;
    (*

    A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    *)
}
type nonrec certificate = {
  1. customer_override_valid_till : t_stamp option;
    (*

    If there is an override for the default certificate identifier, when the override expires.

    *)
  2. customer_override : boolean_optional option;
    (*

    Indicates whether there is an override for the default certificate identifier.

    *)
  3. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the certificate.

    *)
  4. valid_till : t_stamp option;
    (*

    The final date that the certificate continues to be valid.

    *)
  5. valid_from : t_stamp option;
    (*

    The starting date from which the certificate is valid.

    *)
  6. thumbprint : string_ option;
    (*

    The thumbprint of the certificate.

    *)
  7. certificate_type : string_ option;
    (*

    The type of the certificate.

    *)
  8. certificate_identifier : string_ option;
    (*

    The unique key that identifies a certificate.

    *)
}

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.

type nonrec modify_certificates_result = {
  1. certificate : certificate option;
}
type nonrec modify_certificates_message = {
  1. remove_customer_override : boolean_optional option;
    (*

    Specifies whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.

    *)
  2. certificate_identifier : string_ option;
    (*

    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.

    *)
}
type nonrec modify_activity_stream_response = {
  1. policy_status : activity_stream_policy_status option;
    (*

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

    *)
  2. engine_native_audit_fields_included : boolean_optional option;
    (*

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

    *)
  3. mode : activity_stream_mode option;
    (*

    The mode of the database activity stream.

    *)
  4. status : activity_stream_status option;
    (*

    The status of the modification to the database activity stream.

    *)
  5. kinesis_stream_name : string_ option;
    (*

    The name of the Amazon Kinesis data stream to be used for the database activity stream.

    *)
  6. kms_key_id : string_ option;
    (*

    The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

    *)
}
type nonrec audit_policy_state =
  1. | UNLOCKED_POLICY
  2. | LOCKED_POLICY
type nonrec modify_activity_stream_request = {
  1. audit_policy_state : audit_policy_state option;
    (*

    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.

    *)
  2. resource_arn : string_ option;
    (*

    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:db:my-orcl-db.

    *)
}
type nonrec max_records = int
type nonrec max_db_shard_group_limit_reached = {
  1. message : exception_message option;
}

The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.

type nonrec marker = string
type nonrec major_engine_version = string
type nonrec long = Smaws_Lib.CoreTypes.Int64.t
type nonrec filter_value_list = string_ list
type nonrec filter = {
  1. values : filter_value_list;
    (*

    One or more filter values. Filter values are case-sensitive.

    *)
  2. name : string_;
    (*

    The name of the filter. Filter names are case-sensitive.

    *)
}

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.

Currently, wildcards are not supported in filters.

The following actions can be filtered:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions
type nonrec filter_list = filter list
type nonrec list_tags_for_resource_message = {
  1. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  2. resource_name : string_;
    (*

    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.

    *)
}
type nonrec kms_key_id_or_arn = string
type nonrec invalid_resource_state_fault = {
  1. message : exception_message option;
}

The operation can't be performed because another operation is in progress.

type nonrec invalid_export_task_state_fault = {
  1. message : exception_message option;
}

You can't cancel an export task that has completed.

type nonrec invalid_event_subscription_state_fault = {
  1. message : exception_message option;
}

This error can occur if someone else is modifying a subscription. You should retry the action.

type nonrec invalid_db_subnet_state_fault = {
  1. message : exception_message option;
}

The DB subnet isn't in the available state.

type nonrec invalid_db_subnet_group_fault = {
  1. message : exception_message option;
}

The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.

type nonrec invalid_db_cluster_automated_backup_state_fault = {
  1. message : exception_message option;
}

The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.

type nonrec integration_quota_exceeded_fault = {
  1. message : exception_message option;
}

You can't crate any more zero-ETL integrations because the quota has been reached.

type nonrec integration_list = integration list
type nonrec integration_already_exists_fault = {
  1. message : exception_message option;
}

The integration you are trying to create already exists.

type nonrec global_cluster_list = global_cluster list
type nonrec global_clusters_message = {
  1. global_clusters : global_cluster_list option;
    (*

    The list of global clusters returned by this request.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec global_cluster_quota_exceeded_fault = {
  1. message : exception_message option;
}

The number of global database clusters for this account is already at the maximum allowed.

type nonrec failover_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec failover_global_cluster_message = {
  1. switchover : boolean_optional option;
    (*

    Specifies whether to switch over this global database cluster.

    Constraints:

    • Can't be specified together with the AllowDataLoss parameter.
    *)
  2. allow_data_loss : boolean_optional option;
    (*

    Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

    If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.

    Constraints:

    • Can't be specified together with the Switchover parameter.
    *)
  3. target_db_cluster_identifier : db_cluster_identifier;
    (*

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

    *)
  4. global_cluster_identifier : global_cluster_identifier;
    (*

    The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.

    Constraints:

    • Must match the identifier of an existing global database cluster.
    *)
}
type nonrec failover_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec failover_db_cluster_message = {
  1. target_db_instance_identifier : string_ option;
    (*

    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.

    *)
  2. db_cluster_identifier : string_;
    (*

    The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing DB cluster.
    *)
}
type nonrec export_tasks_list = export_task list
type nonrec export_tasks_message = {
  1. export_tasks : export_tasks_list option;
    (*

    Information about an export of a snapshot or cluster to Amazon S3.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec export_task_not_found_fault = {
  1. message : exception_message option;
}

The export task doesn't exist.

type nonrec event = {
  1. source_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the event.

    *)
  2. date : t_stamp option;
    (*

    Specifies the date and time of the event.

    *)
  3. event_categories : event_categories_list option;
    (*

    Specifies the category for the event.

    *)
  4. message : string_ option;
    (*

    Provides the text of this event.

    *)
  5. source_type : source_type option;
    (*

    Specifies the source type for this event.

    *)
  6. source_identifier : string_ option;
    (*

    Provides the identifier for the source of the event.

    *)
}

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

type nonrec event_list = event list
type nonrec events_message = {
  1. events : event_list option;
    (*

    A list of Event instances.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}

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

type nonrec event_subscriptions_list = event_subscription list
type nonrec event_subscriptions_message = {
  1. event_subscriptions_list : event_subscriptions_list option;
    (*

    A list of EventSubscriptions data types.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}

Data returned by the DescribeEventSubscriptions action.

type nonrec event_categories_map = {
  1. event_categories : event_categories_list option;
    (*

    The event categories for the specified source type

    *)
  2. source_type : string_ option;
    (*

    The source type that the returned categories belong to

    *)
}

Contains the results of a successful invocation of the DescribeEventCategories operation.

type nonrec event_categories_map_list = event_categories_map list
type nonrec event_categories_message = {
  1. event_categories_map_list : event_categories_map_list option;
    (*

    A list of EventCategoriesMap data types.

    *)
}

Data returned from the DescribeEventCategories operation.

type nonrec engine_family =
  1. | SQLSERVER
  2. | POSTGRESQL
  3. | MYSQL
type nonrec engine_defaults = {
  1. parameters : parameters_list option;
    (*

    Contains a list of engine default parameters.

    *)
  2. marker : string_ option;
    (*

    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 .

    *)
  3. db_parameter_group_family : string_ option;
    (*

    Specifies the name of the DB parameter group family that the engine default parameters apply to.

    *)
}

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

type nonrec engine = string
type nonrec enable_http_endpoint_response = {
  1. http_endpoint_enabled : boolean_ option;
    (*

    Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.

    *)
  2. resource_arn : string_ option;
    (*

    The ARN of the DB cluster.

    *)
}
type nonrec enable_http_endpoint_request = {
  1. resource_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the DB cluster.

    *)
}
type nonrec ec2_image_properties_not_supported_fault = {
  1. message : exception_message option;
}

The AMI configuration prerequisite has not been met.

type nonrec download_db_log_file_portion_message = {
  1. number_of_lines : integer option;
    (*

    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.
    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. log_file_name : string_;
    (*

    The name of the log file to be downloaded.

    *)
  4. db_instance_identifier : string_;
    (*

    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.
    *)
}
type nonrec download_db_log_file_portion_details = {
  1. additional_data_pending : boolean_ option;
    (*

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

    *)
  2. marker : string_ option;
    (*

    A pagination token that can be used in a later DownloadDBLogFilePortion request.

    *)
  3. log_file_data : sensitive_string option;
    (*

    Entries from the specified log file.

    *)
}

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

type nonrec db_log_file_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec db_instance_not_ready_fault = {
  1. message : exception_message option;
}

An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.

type nonrec disable_http_endpoint_response = {
  1. http_endpoint_enabled : boolean_ option;
    (*

    Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.

    *)
  2. resource_arn : string_ option;
    (*

    The ARN of the DB cluster.

    *)
}
type nonrec disable_http_endpoint_request = {
  1. resource_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the DB cluster.

    *)
}
type nonrec describe_valid_db_instance_modifications_result = {
  1. valid_db_instance_modifications_message : valid_db_instance_modifications_message option;
}
type nonrec describe_valid_db_instance_modifications_message = {
  1. db_instance_identifier : string_;
    (*

    The customer identifier or the ARN of your DB instance.

    *)
}
type nonrec describe_tenant_databases_message = {
  1. max_records : integer_optional option;
    (*

    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.

    *)
  2. marker : string_ option;
    (*

    An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more database tenants to describe.

    Supported filters:

    • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
    • tenant-database-resource-id - Tenant database resource identifiers.
    • dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.
    *)
  4. tenant_db_name : string_ option;
    (*

    The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.

    *)
  5. db_instance_identifier : string_ option;
    (*

    The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive.

    *)
}
type nonrec describe_source_regions_message = {
  1. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. max_records : integer_optional option;
    (*

    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.

    *)
  4. region_name : string_ option;
    (*

    The source Amazon Web Services Region name. For example, us-east-1.

    Constraints:

    • Must specify a valid Amazon Web Services Region name.
    *)
}
type nonrec describe_serverless_v2_platform_versions_message = {
  1. marker : string_ 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.

    *)
  2. max_records : integer_optional option;
    (*

    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: 20

    Constraints: Minimum 1, maximum 200.

    *)
  3. include_all : boolean_optional option;
    (*

    Specifies whether to also include platform versions which are no longer in use.

    *)
  4. default_only : boolean_optional option;
    (*

    Specifies whether to return only the default platform versions for each engine. The default platform version is the version used for new DB clusters.

    *)
  5. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  6. engine : string_ option;
    (*

    The database engine to return platform version details for.

    Valid Values:

    • aurora-mysql
    • aurora-postgresql
    *)
  7. serverless_v2_platform_version : string_ option;
    (*

    A specific platform version to return details for.

    Example: 3

    *)
}
type nonrec describe_reserved_db_instances_offerings_message = {
  1. marker : string_ 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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. multi_a_z : boolean_optional option;
    (*

    Specifies whether to show only those reservations that support Multi-AZ.

    *)
  5. offering_type : string_ option;
    (*

    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"

    *)
  6. product_description : string_ option;
    (*

    Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

    The results show offerings that partially match the filter value.

    *)
  7. duration : string_ option;
    (*

    Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    *)
  8. db_instance_class : string_ option;
    (*

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    *)
  9. reserved_db_instances_offering_id : string_ option;
    (*

    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

    *)
}
type nonrec describe_reserved_db_instances_message = {
  1. marker : string_ 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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. lease_id : string_ option;
    (*

    The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

    Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

    *)
  5. multi_a_z : boolean_optional option;
    (*

    Specifies whether to show only those reservations that support Multi-AZ.

    *)
  6. offering_type : string_ option;
    (*

    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"

    *)
  7. product_description : string_ option;
    (*

    The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

    *)
  8. duration : string_ option;
    (*

    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

    *)
  9. db_instance_class : string_ option;
    (*

    The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

    *)
  10. reserved_db_instances_offering_id : string_ option;
    (*

    The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

    *)
  11. reserved_db_instance_id : string_ option;
    (*

    The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

    *)
}
type nonrec describe_pending_maintenance_actions_message = {
  1. max_records : integer_optional option;
    (*

    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.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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.
    *)
  4. resource_identifier : string_ option;
    (*

    The ARN of a resource to return pending maintenance actions for.

    *)
}
type nonrec describe_orderable_db_instance_options_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

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

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. vpc : boolean_optional option;
    (*

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

    *)
  5. availability_zone_group : string_ option;
    (*

    The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.

    Omit this parameter to show the available options in the specified Amazon Web Services Region.

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

    *)
  6. license_model : string_ option;
    (*

    A filter to include only the available options for the specified license model.

    RDS Custom supports only the BYOL licensing model.

    *)
  7. db_instance_class : string_ option;
    (*

    A filter to include only the available options for the specified DB instance class.

    *)
  8. engine_version : string_ option;
    (*

    A filter to include only the available options for the specified engine version.

    *)
  9. engine : string_;
    (*

    The name of the database engine to describe DB instance options for.

    Valid Values:

    • aurora-mysql
    • aurora-postgresql
    • custom-oracle-ee
    • custom-oracle-ee-cdb
    • custom-oracle-se2
    • custom-oracle-se2-cdb
    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    *)
}
type nonrec describe_option_groups_message = {
  1. major_engine_version : string_ option;
    (*

    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.

    *)
  2. engine_name : string_ option;
    (*

    A filter to only include option groups associated with this database engine.

    Valid Values:

    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    *)
  3. max_records : integer_optional option;
    (*

    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.

    *)
  4. marker : string_ option;
    (*

    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.

    *)
  5. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  6. option_group_name : string_ option;
    (*

    The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

    *)
}
type nonrec describe_option_group_options_message = {
  1. marker : string_ 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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. major_engine_version : string_ option;
    (*

    If specified, filters the results to include only options for the specified major engine version.

    *)
  5. engine_name : string_;
    (*

    The name of the engine to describe options for.

    Valid Values:

    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    *)
}
type nonrec describe_integrations_response = {
  1. integrations : integration_list option;
    (*

    A list of integrations.

    *)
  2. marker : marker option;
    (*

    A pagination token that can be used in a later DescribeIntegrations request.

    *)
}
type nonrec describe_integrations_message = {
  1. marker : marker option;
    (*

    An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more resources to return.

    *)
  4. integration_identifier : integration_identifier option;
    (*

    The unique identifier of the integration.

    *)
}
type nonrec describe_global_clusters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

    Currently, the only supported filter is region.

    If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

    *)
  4. global_cluster_identifier : global_cluster_identifier option;
    (*

    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.
    *)
}
type nonrec describe_export_tasks_message = {
  1. source_type : export_source_type option;
    (*

    The type of source for the export.

    *)
  2. max_records : max_records option;
    (*

    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.

    *)
  3. marker : string_ option;
    (*

    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.

    *)
  4. filters : filter_list option;
    (*

    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
    *)
  5. source_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

    *)
  6. export_task_identifier : string_ option;
    (*

    The identifier of the snapshot or cluster export task to be described.

    *)
}
type nonrec describe_events_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. event_categories : event_categories_list option;
    (*

    A list of event categories that trigger notifications for a event notification subscription.

    *)
  5. duration : integer_optional option;
    (*

    The number of minutes to retrieve events for.

    Default: 60

    *)
  6. end_time : t_stamp option;
    (*

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    *)
  7. start_time : t_stamp option;
    (*

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    *)
  8. source_type : source_type option;
    (*

    The event source to retrieve events for. If no value is specified, all events are returned.

    *)
  9. source_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec describe_event_subscriptions_message = {
  1. marker : string_ option;
    (*

    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 .

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. subscription_name : string_ option;
    (*

    The name of the RDS event notification subscription you want to describe.

    *)
}
type nonrec describe_event_categories_message = {
  1. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  2. source_type : string_ option;
    (*

    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

    *)
}
type nonrec describe_engine_default_parameters_result = {
  1. engine_defaults : engine_defaults option;
}
type nonrec describe_engine_default_parameters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more parameters to describe.

    The only supported filter is parameter-name. The results list only includes information about the parameters with these names.

    *)
  4. db_parameter_group_family : string_;
    (*

    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
    • custom-oracle-ee-cdb-19
    • db2-ae
    • db2-ce
    • db2-se
    • 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
    *)
}
type nonrec describe_engine_default_cluster_parameters_result = {
  1. engine_defaults : engine_defaults option;
}
type nonrec describe_engine_default_cluster_parameters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. db_parameter_group_family : string_;
    (*

    The name of the DB cluster parameter group family to return engine parameter information for.

    *)
}
type nonrec describe_db_subnet_groups_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. db_subnet_group_name : string_ option;
    (*

    The name of the DB subnet group to return details for.

    *)
}
type nonrec db_subnet_groups = db_subnet_group list
type nonrec db_subnet_group_message = {
  1. db_subnet_groups : db_subnet_groups option;
    (*

    A list of DBSubnetGroup instances.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec describe_db_snapshots_message = {
  1. dbi_resource_id : string_ option;
    (*

    A specific DB resource ID to describe.

    *)
  2. include_public : boolean_ option;
    (*

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

    *)
  3. include_shared : boolean_ option;
    (*

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

    *)
  4. marker : string_ option;
    (*

    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.

    *)
  5. max_records : integer_optional option;
    (*

    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.

    *)
  6. filters : filter_list option;
    (*

    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.
    *)
  7. snapshot_type : string_ option;
    (*

    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.

    *)
  8. db_snapshot_identifier : string_ option;
    (*

    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.
    *)
  9. db_instance_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec db_snapshot_list = db_snapshot list
type nonrec db_snapshot_message = {
  1. db_snapshots : db_snapshot_list option;
    (*

    A list of DBSnapshot instances.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec describe_db_snapshot_tenant_databases_message = {
  1. dbi_resource_id : string_ option;
    (*

    A specific DB resource identifier to describe.

    *)
  2. marker : string_ option;
    (*

    An optional pagination token provided by a previous DescribeDBSnapshotTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  3. max_records : integer_optional option;
    (*

    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.

    *)
  4. filters : filter_list option;
    (*

    A filter that specifies one or more tenant databases to describe.

    Supported filters:

    • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
    • tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.
    • dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.
    • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
    • db-snapshot-id - Accepts DB snapshot identifiers.
    • snapshot-type - Accepts types of DB snapshots.
    *)
  5. snapshot_type : string_ option;
    (*

    The type of DB snapshots to be returned. You can specify one of the following values:

    • automated – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
    • manual – All DB snapshots that have been taken by my Amazon Web Services account.
    • shared – All manual DB snapshots that have been shared to my Amazon Web Services account.
    • public – All DB snapshots that have been marked as public.
    • awsbackup – All DB snapshots managed by the Amazon Web Services Backup service.
    *)
  6. db_snapshot_identifier : string_ option;
    (*

    The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.

    Constraints:

    • If you specify this parameter, the value must match the ID of an existing DB snapshot.
    • If you specify an automatic snapshot, you must also specify SnapshotType.
    *)
  7. db_instance_identifier : string_ option;
    (*

    The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match the identifier of an existing DBInstance.
    *)
}
type nonrec db_snapshot_tenant_database = {
  1. tag_list : tag_list option;
  2. nchar_character_set_name : string_ option;
    (*

    The NCHAR character set name of the tenant database.

    *)
  3. db_snapshot_tenant_database_ar_n : string_ option;
    (*

    The Amazon Resource Name (ARN) for the snapshot tenant database.

    *)
  4. character_set_name : string_ option;
    (*

    The name of the character set of a tenant database.

    *)
  5. tenant_database_resource_id : string_ option;
    (*

    The resource ID of the tenant database.

    *)
  6. master_username : string_ option;
    (*

    The master username of the tenant database.

    *)
  7. tenant_db_name : string_ option;
    (*

    The name of the tenant database.

    *)
  8. tenant_database_create_time : t_stamp option;
    (*

    The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If you copy the snapshot, the creation time changes.

    *)
  9. snapshot_type : string_ option;
    (*

    The type of DB snapshot.

    *)
  10. engine_name : string_ option;
    (*

    The name of the database engine.

    *)
  11. dbi_resource_id : string_ option;
    (*

    The resource identifier of the source CDB instance. This identifier can't be changed and is unique to an Amazon Web Services Region.

    *)
  12. db_instance_identifier : string_ option;
    (*

    The ID for the DB instance that contains the tenant databases.

    *)
  13. db_snapshot_identifier : string_ option;
    (*

    The identifier for the snapshot of the DB instance.

    *)
}

Contains the details of a tenant database in a snapshot of a DB instance.

type nonrec db_snapshot_tenant_databases_list = db_snapshot_tenant_database list
type nonrec db_snapshot_tenant_databases_message = {
  1. db_snapshot_tenant_databases : db_snapshot_tenant_databases_list option;
    (*

    A list of DB snapshot tenant databases.

    *)
  2. marker : string_ 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.

    *)
}
type nonrec describe_db_snapshot_attributes_result = {
  1. db_snapshot_attributes_result : db_snapshot_attributes_result option;
}
type nonrec describe_db_snapshot_attributes_message = {
  1. db_snapshot_identifier : string_;
    (*

    The identifier for the DB snapshot to describe the attributes for.

    *)
}
type nonrec db_shard_groups_list = db_shard_group list
type nonrec describe_db_shard_groups_response = {
  1. marker : string_ option;
    (*

    A pagination token that can be used in a later DescribeDBClusters request.

    *)
  2. db_shard_groups : db_shard_groups_list option;
    (*

    Contains a list of DB shard groups for the user.

    *)
}
type nonrec describe_db_shard_groups_message = {
  1. max_records : max_records option;
    (*

    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

    *)
  2. marker : string_ option;
    (*

    An optional pagination token provided by a previous DescribeDBShardGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more DB shard groups to describe.

    *)
  4. db_shard_group_identifier : db_shard_group_identifier option;
    (*

    The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match an existing DB shard group identifier.
    *)
}
type nonrec describe_db_security_groups_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. db_security_group_name : string_ option;
    (*

    The name of the DB security group to return details for.

    *)
}
type nonrec db_security_groups = db_security_group list
type nonrec db_security_group_message = {
  1. db_security_groups : db_security_groups option;
    (*

    A list of DBSecurityGroup instances.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec describe_db_recommendations_message = {
  1. marker : string_ option;
    (*

    An optional pagination token provided by a previous DescribeDBRecommendations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of recommendations 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.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more recommendations to describe.

    Supported Filters:

    • recommendation-id - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values.

    • status - Accepts a list of recommendation statuses.

      Valid values:

      • active - The recommendations which are ready for you to apply.
      • pending - The applied or scheduled recommendations which are in progress.
      • resolved - The recommendations which are completed.
      • dismissed - The recommendations that you dismissed.

      The results list only includes the recommendations whose status is one of the specified filter values.

    • severity - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.

      Valid values:

      • high
      • medium
      • low
      • informational
    • type-id - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values.
    • dbi-resource-id - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases.
    • cluster-resource-id - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters.
    • pg-arn - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups.
    • cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
    *)
  4. locale : string_ option;
    (*

    The language that you choose to return the list of recommendations.

    Valid values:

    • en
    • en_UK
    • de
    • es
    • fr
    • id
    • it
    • ja
    • ko
    • pt_BR
    • zh_TW
    • zh_CN
    *)
  5. last_updated_before : t_stamp option;
    (*

    A filter to include only the recommendations that were updated before this specified time.

    *)
  6. last_updated_after : t_stamp option;
    (*

    A filter to include only the recommendations that were updated after this specified time.

    *)
}
type nonrec db_recommendation_list = db_recommendation list
type nonrec db_recommendations_message = {
  1. marker : string_ option;
    (*

    An optional pagination token provided by a previous DBRecommendationsMessage request. This token can be used later in a DescribeDBRecomendations request.

    *)
  2. db_recommendations : db_recommendation_list option;
    (*

    A list of recommendations which is returned from DescribeDBRecommendations API request.

    *)
}
type nonrec describe_db_proxy_targets_response = {
  1. marker : string_ 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.

    *)
  2. targets : target_list option;
    (*

    An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

    *)
}
type nonrec describe_db_proxy_targets_request = {
  1. max_records : max_records option;
    (*

    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.

    *)
  2. marker : string_ 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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. target_group_name : db_proxy_target_group_name option;
    (*

    The identifier of the DBProxyTargetGroup to describe.

    *)
  5. db_proxy_name : db_proxy_name;
    (*

    The identifier of the DBProxyTarget to describe.

    *)
}
type nonrec db_proxy_target_not_found_fault = {
  1. message : exception_message option;
}

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.

type nonrec describe_db_proxy_target_groups_response = {
  1. marker : string_ 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.

    *)
  2. target_groups : target_group_list option;
    (*

    An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.

    *)
}
type nonrec describe_db_proxy_target_groups_request = {
  1. max_records : max_records option;
    (*

    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.

    *)
  2. marker : string_ 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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. target_group_name : db_proxy_target_group_name option;
    (*

    The identifier of the DBProxyTargetGroup to describe.

    *)
  5. db_proxy_name : db_proxy_name;
    (*

    The identifier of the DBProxy associated with the target group.

    *)
}
type nonrec db_proxy_endpoint_list = db_proxy_endpoint list
type nonrec describe_db_proxy_endpoints_response = {
  1. marker : string_ 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.

    *)
  2. db_proxy_endpoints : db_proxy_endpoint_list option;
    (*

    The list of ProxyEndpoint objects returned by the API operation.

    *)
}
type nonrec describe_db_proxy_endpoints_request = {
  1. max_records : max_records option;
    (*

    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.

    *)
  2. marker : string_ 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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_proxy_endpoint_name : db_proxy_endpoint_name option;
    (*

    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.

    *)
  5. db_proxy_name : db_proxy_name option;
    (*

    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.

    *)
}
type nonrec db_proxy_list = db_proxy list
type nonrec describe_db_proxies_response = {
  1. marker : string_ 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.

    *)
  2. db_proxies : db_proxy_list option;
    (*

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

    *)
}
type nonrec describe_db_proxies_request = {
  1. max_records : max_records option;
    (*

    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.

    *)
  2. marker : string_ 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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_proxy_name : db_proxy_name option;
    (*

    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.

    *)
}
type nonrec describe_db_parameters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more DB parameters to describe.

    The only supported filter is parameter-name. The results list only includes information about the DB parameters with these names.

    *)
  4. source : string_ option;
    (*

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    *)
  5. db_parameter_group_name : string_;
    (*

    The name of a specific DB parameter group to return details for.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.
    *)
}
type nonrec db_parameter_group_details = {
  1. marker : string_ 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.

    *)
  2. parameters : parameters_list option;
    (*

    A list of Parameter values.

    *)
}

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

type nonrec describe_db_parameter_groups_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. db_parameter_group_name : string_ option;
    (*

    The name of a specific DB parameter group to return details for.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.
    *)
}
type nonrec db_parameter_group = {
  1. db_parameter_group_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB parameter group.

    *)
  2. description : string_ option;
    (*

    Provides the customer-specified description for this DB parameter group.

    *)
  3. db_parameter_group_family : string_ option;
    (*

    The name of the DB parameter group family that this DB parameter group is compatible with.

    *)
  4. db_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group.

    *)
}

Contains the details of an Amazon RDS DB parameter group.

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

type nonrec db_parameter_group_list = db_parameter_group list
type nonrec db_parameter_groups_message = {
  1. db_parameter_groups : db_parameter_group_list option;
    (*

    A list of DBParameterGroup instances.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec db_major_engine_version = {
  1. supported_engine_lifecycles : supported_engine_lifecycle_list option;
    (*

    A list of the lifecycles supported by this engine for the DescribeDBMajorEngineVersions operation.

    *)
  2. major_engine_version : string_ option;
    (*

    The major version number of the database engine.

    *)
  3. engine : string_ option;
    (*

    The name of the database engine.

    *)
}

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

type nonrec db_major_engine_versions_list = db_major_engine_version list
type nonrec describe_db_major_engine_versions_response = {
  1. marker : string_ 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.

    *)
  2. db_major_engine_versions : db_major_engine_versions_list option;
    (*

    A list of DBMajorEngineVersion elements.

    *)
}
type nonrec describe_db_major_engine_versions_request = {
  1. max_records : max_records option;
    (*

    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

    *)
  2. marker : marker 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.

    *)
  3. major_engine_version : major_engine_version option;
    (*

    A specific database major engine version to return details for.

    Example: 8.4

    *)
  4. engine : engine option;
    (*

    The database engine to return major version details for.

    Valid Values:

    • aurora-mysql
    • aurora-postgresql
    • custom-sqlserver-ee
    • custom-sqlserver-se
    • custom-sqlserver-web
    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    *)
}
type nonrec describe_db_log_files_details = {
  1. size : long option;
    (*

    The size, in bytes, of the log file for the specified DB instance.

    *)
  2. last_written : long option;
    (*

    A POSIX timestamp when the last log entry was written.

    *)
  3. log_file_name : string_ option;
    (*

    The name of the log file for the specified DB instance.

    *)
}

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

type nonrec describe_db_log_files_list = describe_db_log_files_details list
type nonrec describe_db_log_files_response = {
  1. marker : string_ option;
    (*

    A pagination token that can be used in a later DescribeDBLogFiles request.

    *)
  2. describe_db_log_files : describe_db_log_files_list option;
    (*

    The DB log files returned.

    *)
}

The response from a call to DescribeDBLogFiles.

type nonrec describe_db_log_files_message = {
  1. marker : string_ option;
    (*

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. file_size : long option;
    (*

    Filters the available log files for files larger than the specified size.

    *)
  5. file_last_written : long option;
    (*

    Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

    *)
  6. filename_contains : string_ option;
    (*

    Filters the available log files for log file names that contain the specified string.

    *)
  7. db_instance_identifier : string_;
    (*

    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.
    *)
}
type nonrec describe_db_instances_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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.
    *)
  4. db_instance_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec db_instance_list = db_instance list
type nonrec db_instance_message = {
  1. db_instances : db_instance_list option;
    (*

    A list of DBInstance instances.

    *)
  2. marker : string_ 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 .

    *)
}

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

type nonrec describe_db_instance_automated_backups_message = {
  1. db_instance_automated_backups_arn : string_ option;
    (*

    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.

    *)
  2. marker : string_ option;
    (*

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    *)
  3. max_records : integer_optional option;
    (*

    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.

    *)
  4. filters : filter_list option;
    (*

    A filter that specifies which resources to return based on status.

    Supported filters are the following:

    • status

      • active - Automated backups for current instances.
      • creating - Automated backups that are waiting for the first automated snapshot to be available.
      • retained - Automated backups for deleted instances and after backup replication is stopped.
    • 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.

    *)
  5. db_instance_identifier : string_ option;
    (*

    (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's automated backup. This parameter isn't case-sensitive.

    *)
  6. dbi_resource_id : string_ option;
    (*

    The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

    *)
}

Parameter input for DescribeDBInstanceAutomatedBackups.

type nonrec db_instance_automated_backup_list = db_instance_automated_backup list
type nonrec db_instance_automated_backup_message = {
  1. db_instance_automated_backups : db_instance_automated_backup_list option;
    (*

    A list of DBInstanceAutomatedBackup instances.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec describe_db_engine_versions_message = {
  1. include_all : boolean_optional option;
    (*

    Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.

    *)
  2. list_supported_timezones : boolean_optional option;
    (*

    Specifies 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 enable this parameter, RDS Custom returns no results.

    *)
  3. list_supported_character_sets : boolean_optional option;
    (*

    Specifies 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 enable this parameter, RDS Custom returns no results.

    *)
  4. default_only : boolean_ option;
    (*

    Specifies whether to return only the default version of the specified engine or the engine and major version combination.

    *)
  5. marker : string_ 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.

    *)
  6. max_records : integer_optional option;
    (*

    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.

    *)
  7. filters : filter_list option;
    (*

    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
    *)
  8. db_parameter_group_family : string_ option;
    (*

    The name of a specific DB parameter group family to return details for.

    Constraints:

    • If supplied, must match an existing DB parameter group family.
    *)
  9. engine_version : string_ option;
    (*

    A specific database engine version to return details for.

    Example: 5.1.49

    *)
  10. engine : string_ option;
    (*

    The database engine to return version details for.

    Valid Values:

    • aurora-mysql
    • aurora-postgresql
    • custom-oracle-ee
    • custom-oracle-ee-cdb
    • custom-oracle-se2
    • custom-oracle-se2-cdb
    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    • sqlserver-dev-ee
    *)
}
type nonrec db_engine_version_list = db_engine_version list
type nonrec db_engine_version_message = {
  1. db_engine_versions : db_engine_version_list option;
    (*

    A list of DBEngineVersion elements.

    *)
  2. marker : string_ 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.

    *)
}

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

type nonrec describe_db_clusters_message = {
  1. include_shared : boolean_ option;
    (*

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

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. max_records : integer_optional option;
    (*

    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

    *)
  4. filters : filter_list option;
    (*

    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.
    *)
  5. db_cluster_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec db_cluster_list = db_cluster list
type nonrec db_cluster_message = {
  1. db_clusters : db_cluster_list option;
    (*

    Contains a list of DB clusters for the user.

    *)
  2. marker : string_ option;
    (*

    A pagination token that can be used in a later DescribeDBClusters request.

    *)
}

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

type nonrec describe_db_cluster_snapshots_message = {
  1. db_cluster_resource_id : string_ option;
    (*

    A specific DB cluster resource ID to describe.

    *)
  2. include_public : boolean_ option;
    (*

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

    *)
  3. include_shared : boolean_ option;
    (*

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

    *)
  4. marker : string_ option;
    (*

    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.

    *)
  5. max_records : integer_optional option;
    (*

    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.

    *)
  6. filters : filter_list option;
    (*

    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.
    *)
  7. snapshot_type : string_ option;
    (*

    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.

    *)
  8. db_cluster_snapshot_identifier : string_ option;
    (*

    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.
    *)
  9. db_cluster_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec db_cluster_snapshot = {
  1. db_system_id : string_ option;
    (*

    Reserved for future use.

    *)
  2. db_cluster_resource_id : string_ option;
    (*

    The resource ID of the DB cluster that this DB cluster snapshot was created from.

    *)
  3. storage_throughput : integer_optional option;
    (*

    The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

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

    *)
  4. storage_type : string_ option;
    (*

    The storage type associated with the DB cluster snapshot.

    This setting is only for Aurora DB clusters.

    *)
  5. tag_list : tag_list option;
  6. iam_database_authentication_enabled : boolean_ option;
    (*

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

    *)
  7. source_db_cluster_snapshot_arn : string_ option;
    (*

    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.

    *)
  8. db_cluster_snapshot_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB cluster snapshot.

    *)
  9. kms_key_id : string_ option;
    (*

    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.

    *)
  10. preferred_backup_window : string_ option;
    (*

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  11. backup_retention_period : integer_optional option;
    (*

    The number of days for which automatic DB snapshots are retained.

    *)
  12. storage_encryption_type : storage_encryption_type option;
    (*

    The type of encryption used to protect data at rest in the DB cluster snapshot. Possible values:

    • none - The DB cluster snapshot is not encrypted.
    • sse-rds - The DB cluster snapshot is encrypted using an Amazon Web Services owned KMS key.
    • sse-kms - The DB cluster snapshot is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
    *)
  13. storage_encrypted : boolean_ option;
    (*

    Indicates whether the DB cluster snapshot is encrypted.

    *)
  14. percent_progress : integer option;
    (*

    The percentage of the estimated data that has been transferred.

    *)
  15. snapshot_type : string_ option;
    (*

    The type of the DB cluster snapshot.

    *)
  16. license_model : string_ option;
    (*

    The license model information for this DB cluster snapshot.

    *)
  17. engine_version : string_ option;
    (*

    The version of the database engine for this DB cluster snapshot.

    *)
  18. master_username : string_ option;
    (*

    The master username for this DB cluster snapshot.

    *)
  19. cluster_create_time : t_stamp option;
    (*

    The time when the DB cluster was created, in Universal Coordinated Time (UTC).

    *)
  20. vpc_id : string_ option;
    (*

    The VPC ID associated with the DB cluster snapshot.

    *)
  21. port : integer option;
    (*

    The port that the DB cluster was listening on at the time of the snapshot.

    *)
  22. status : string_ option;
    (*

    The status of this DB cluster snapshot. Valid statuses are the following:

    • available
    • copying
    • creating
    *)
  23. allocated_storage : integer option;
    (*

    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

    *)
  24. engine_mode : string_ option;
    (*

    The engine mode of the database engine for this DB cluster snapshot.

    *)
  25. engine : string_ option;
    (*

    The name of the database engine for this DB cluster snapshot.

    *)
  26. snapshot_create_time : t_stamp option;
    (*

    The time when the snapshot was taken, in Universal Coordinated Time (UTC).

    *)
  27. db_cluster_identifier : string_ option;
    (*

    The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

    *)
  28. db_cluster_snapshot_identifier : string_ option;
    (*

    The identifier for the DB cluster snapshot.

    *)
  29. availability_zones : availability_zones option;
    (*

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

    *)
}

Contains the details for an Amazon RDS DB cluster snapshot

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

type nonrec db_cluster_snapshot_list = db_cluster_snapshot list
type nonrec db_cluster_snapshot_message = {
  1. db_cluster_snapshots : db_cluster_snapshot_list option;
    (*

    Provides a list of DB cluster snapshots for the user.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}

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

type nonrec describe_db_cluster_snapshot_attributes_result = {
  1. db_cluster_snapshot_attributes_result : db_cluster_snapshot_attributes_result option;
}
type nonrec describe_db_cluster_snapshot_attributes_message = {
  1. db_cluster_snapshot_identifier : string_;
    (*

    The identifier for the DB cluster snapshot to describe the attributes for.

    *)
}
type nonrec describe_db_cluster_parameters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more DB cluster parameters to describe.

    The only supported filter is parameter-name. The results list only includes information about the DB cluster parameters with these names.

    *)
  4. source : string_ option;
    (*

    A specific source to return parameters for.

    Valid Values:

    • engine-default
    • system
    • user
    *)
  5. db_cluster_parameter_group_name : string_;
    (*

    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.
    *)
}
type nonrec db_cluster_parameter_group_details = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. parameters : parameters_list option;
    (*

    Provides a list of parameters for the DB cluster parameter group.

    *)
}

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

type nonrec describe_db_cluster_parameter_groups_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. db_cluster_parameter_group_name : string_ option;
    (*

    The name of a specific DB cluster parameter group to return details for.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.
    *)
}
type nonrec db_cluster_parameter_group = {
  1. db_cluster_parameter_group_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB cluster parameter group.

    *)
  2. description : string_ option;
    (*

    Provides the customer-specified description for this DB cluster parameter group.

    *)
  3. db_parameter_group_family : string_ option;
    (*

    The name of the DB parameter group family that this DB cluster parameter group is compatible with.

    *)
  4. db_cluster_parameter_group_name : string_ option;
    (*

    The name of the DB cluster parameter 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.

type nonrec db_cluster_parameter_group_list = db_cluster_parameter_group list
type nonrec db_cluster_parameter_groups_message = {
  1. db_cluster_parameter_groups : db_cluster_parameter_group_list option;
    (*

    A list of DB cluster parameter groups.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_db_cluster_endpoints_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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={i endpoint_type},Values={i endpoint_type1},{i 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.

    *)
  4. db_cluster_endpoint_identifier : string_ option;
    (*

    The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

    *)
  5. db_cluster_identifier : string_ option;
    (*

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    *)
}
type nonrec db_cluster_endpoint_list = db_cluster_endpoint list
type nonrec db_cluster_endpoint_message = {
  1. db_cluster_endpoints : db_cluster_endpoint_list option;
    (*

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

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_db_cluster_backtracks_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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.

    *)
  4. backtrack_identifier : string_ option;
    (*

    If specified, this value is the backtrack identifier of the backtrack to be described.

    Constraints:

    Example: 123e4567-e89b-12d3-a456-426655440000

    *)
  5. db_cluster_identifier : string_;
    (*

    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

    *)
}
type nonrec db_cluster_backtrack_not_found_fault = {
  1. message : exception_message option;
}

BacktrackIdentifier doesn't refer to an existing backtrack.

type nonrec db_cluster_backtrack = {
  1. status : string_ option;
    (*

    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.
    *)
  2. backtrack_request_creation_time : t_stamp option;
    (*

    The timestamp of the time at which the backtrack was requested.

    *)
  3. backtracked_from : t_stamp option;
    (*

    The timestamp of the time from which the DB cluster was backtracked.

    *)
  4. backtrack_to : t_stamp option;
    (*

    The timestamp of the time to which the DB cluster was backtracked.

    *)
  5. backtrack_identifier : string_ option;
    (*

    Contains the backtrack identifier.

    *)
  6. db_cluster_identifier : string_ option;
    (*

    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    *)
}

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

type nonrec db_cluster_backtrack_list = db_cluster_backtrack list
type nonrec db_cluster_backtrack_message = {
  1. db_cluster_backtracks : db_cluster_backtrack_list option;
    (*

    Contains a list of backtracks for the user.

    *)
  2. marker : string_ option;
    (*

    A pagination token that can be used in a later DescribeDBClusterBacktracks request.

    *)
}

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

type nonrec describe_db_cluster_automated_backups_message = {
  1. marker : string_ option;
    (*

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies which resources to return based on status.

    Supported filters are the following:

    • status

      • retained - Automated backups for deleted clusters and after backup replication is stopped.
    • db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.
    • db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.

    Returns all resources by default. The status for each resource is specified in the response.

    *)
  4. db_cluster_identifier : string_ option;
    (*

    (Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.

    *)
  5. db_cluster_resource_id : string_ option;
    (*

    The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

    *)
}
type nonrec db_cluster_automated_backup = {
  1. tag_list : tag_list option;
  2. aws_backup_recovery_point_arn : string_ option;
    (*

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

    *)
  3. storage_throughput : integer_optional option;
    (*

    The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

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

    *)
  4. iops : integer_optional option;
    (*

    The IOPS (I/O operations per second) value for the automated backup.

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

    *)
  5. storage_type : string_ option;
    (*

    The storage type associated with the DB cluster.

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

    *)
  6. kms_key_id : string_ option;
    (*

    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.

    *)
  7. port : integer option;
    (*

    The port number that the automated backup used for connections.

    Default: Inherits from the source DB cluster

    Valid Values: 1150-65535

    *)
  8. availability_zones : availability_zones option;
    (*

    The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

    *)
  9. engine_mode : string_ option;
    (*

    The engine mode of the database engine for the automated backup.

    *)
  10. preferred_backup_window : string_ option;
    (*

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  11. backup_retention_period : integer_optional option;
    (*

    The retention period for the automated backups.

    *)
  12. db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the source DB cluster.

    *)
  13. engine_version : string_ option;
    (*

    The version of the database engine for the automated backup.

    *)
  14. allocated_storage : integer option;
    (*

    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.

    *)
  15. storage_encryption_type : storage_encryption_type option;
    (*

    The type of encryption used to protect data at rest in the automated backup. Possible values:

    • none - The automated backup is not encrypted.
    • sse-rds - The automated backup is encrypted using an Amazon Web Services owned KMS key.
    • sse-kms - The automated backup is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
    *)
  16. storage_encrypted : boolean_ option;
    (*

    Indicates whether the source DB cluster is encrypted.

    *)
  17. cluster_create_time : t_stamp option;
    (*

    The time when the DB cluster was created, in Universal Coordinated Time (UTC).

    *)
  18. iam_database_authentication_enabled : boolean_ option;
    (*

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

    *)
  19. status : string_ option;
    (*

    A list of status information for an automated backup:

    • retained - Automated backups for deleted clusters.
    *)
  20. license_model : string_ option;
    (*

    The license model information for this DB cluster automated backup.

    *)
  21. region : string_ option;
    (*

    The Amazon Web Services Region associated with the automated backup.

    *)
  22. db_cluster_resource_id : string_ option;
    (*

    The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

    *)
  23. master_username : string_ option;
    (*

    The master user name of the automated backup.

    *)
  24. restore_window : restore_window option;
  25. db_cluster_identifier : string_ option;
    (*

    The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

    *)
  26. db_cluster_automated_backups_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the automated backups.

    *)
  27. vpc_id : string_ option;
    (*

    The VPC ID associated with the DB cluster.

    *)
  28. engine : string_ option;
    (*

    The name of the database engine for this automated backup.

    *)
}

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

type nonrec db_cluster_automated_backup_list = db_cluster_automated_backup list
type nonrec db_cluster_automated_backup_message = {
  1. db_cluster_automated_backups : db_cluster_automated_backup_list option;
    (*

    A list of DBClusterAutomatedBackup backups.

    *)
  2. marker : string_ option;
    (*

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    *)
}
type nonrec describe_certificates_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter isn't currently supported.

    *)
  4. certificate_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec certificate_list = certificate list
type nonrec certificate_message = {
  1. marker : string_ option;
    (*

    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 .

    *)
  2. certificates : certificate_list option;
    (*

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

    *)
  3. default_certificate_for_new_launches : string_ option;
    (*

    The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the ModifyCertificates operation.

    *)
}

Data returned by the DescribeCertificates action.

type nonrec blue_green_deployment_list = blue_green_deployment list
type nonrec describe_blue_green_deployments_response = {
  1. marker : string_ option;
    (*

    A pagination token that can be used in a later DescribeBlueGreenDeployments request.

    *)
  2. blue_green_deployments : blue_green_deployment_list option;
    (*

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

    *)
}
type nonrec describe_blue_green_deployments_request = {
  1. max_records : max_records option;
    (*

    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.
    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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.
    *)
  4. blue_green_deployment_identifier : blue_green_deployment_identifier option;
    (*

    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.
    *)
}
type nonrec describe_account_attributes_message = unit
type nonrec account_quota = {
  1. max : long option;
    (*

    The maximum allowed value for the quota.

    *)
  2. used : long option;
    (*

    The amount currently used toward the quota maximum.

    *)
  3. account_quota_name : string_ option;
    (*

    The name of the Amazon RDS quota for this Amazon Web Services account.

    *)
}

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.

type nonrec account_quota_list = account_quota list
type nonrec account_attributes_message = {
  1. account_quotas : account_quota_list option;
    (*

    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.

    *)
}

Data returned by the DescribeAccountAttributes action.

type nonrec deregister_db_proxy_targets_response = unit
type nonrec deregister_db_proxy_targets_request = {
  1. db_cluster_identifiers : string_list option;
    (*

    One or more DB cluster identifiers.

    *)
  2. db_instance_identifiers : string_list option;
    (*

    One or more DB instance identifiers.

    *)
  3. target_group_name : db_proxy_target_group_name option;
    (*

    The identifier of the DBProxyTargetGroup.

    *)
  4. db_proxy_name : db_proxy_name;
    (*

    The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

    *)
}
type nonrec delete_tenant_database_result = {
  1. tenant_database : tenant_database option;
}
type nonrec delete_tenant_database_message = {
  1. final_db_snapshot_identifier : string_ option;
    (*

    The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

    If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

    *)
  2. skip_final_snapshot : boolean_ option;
    (*

    Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB 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 it deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

    *)
  3. tenant_db_name : string_;
    (*

    The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.

    *)
  4. db_instance_identifier : string_;
    (*

    The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.

    *)
}
type nonrec delete_option_group_message = {
  1. option_group_name : string_;
    (*

    The name of the option group to be deleted.

    You can't delete default option groups.

    *)
}
type nonrec delete_integration_message = {
  1. integration_identifier : integration_identifier;
    (*

    The unique identifier of the integration.

    *)
}
type nonrec delete_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec delete_global_cluster_message = {
  1. global_cluster_identifier : global_cluster_identifier;
    (*

    The cluster identifier of the global database cluster being deleted.

    *)
}
type nonrec delete_event_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec delete_event_subscription_message = {
  1. subscription_name : string_;
    (*

    The name of the RDS event notification subscription you want to delete.

    *)
}
type nonrec delete_db_subnet_group_message = {
  1. db_subnet_group_name : string_;
    (*

    The name of the database subnet group to delete.

    You can't delete the default subnet group.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mydbsubnetgroup

    *)
}
type nonrec delete_db_snapshot_result = {
  1. db_snapshot : db_snapshot option;
}
type nonrec delete_db_snapshot_message = {
  1. db_snapshot_identifier : string_;
    (*

    The DB snapshot identifier.

    Constraints: Must be the name of an existing DB snapshot in the available state.

    *)
}
type nonrec delete_db_shard_group_message = {
  1. db_shard_group_identifier : db_shard_group_identifier;
    (*

    The name of the DB shard group to delete.

    *)
}
type nonrec delete_db_security_group_message = {
  1. db_security_group_name : string_;
    (*

    The name of the DB security group to delete.

    You can't delete the default DB security 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
    • Must not be "Default"
    *)
}
type nonrec delete_db_proxy_response = {
  1. db_proxy : db_proxy option;
    (*

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

    *)
}
type nonrec delete_db_proxy_request = {
  1. db_proxy_name : db_proxy_name;
    (*

    The name of the DB proxy to delete.

    *)
}
type nonrec delete_db_proxy_endpoint_response = {
  1. db_proxy_endpoint : db_proxy_endpoint option;
    (*

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

    *)
}
type nonrec delete_db_proxy_endpoint_request = {
  1. db_proxy_endpoint_name : db_proxy_endpoint_name;
    (*

    The name of the DB proxy endpoint to delete.

    *)
}
type nonrec delete_db_parameter_group_message = {
  1. db_parameter_group_name : string_;
    (*

    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
    *)
}
type nonrec delete_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec delete_db_instance_message = {
  1. delete_automated_backups : boolean_optional option;
    (*

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

    *)
  2. final_db_snapshot_identifier : string_ option;
    (*

    The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

    If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

    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.
    *)
  3. skip_final_snapshot : boolean_ option;
    (*

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

    If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

    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.

    *)
  4. db_instance_identifier : string_;
    (*

    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.
    *)
}
type nonrec delete_db_instance_automated_backup_result = {
  1. db_instance_automated_backup : db_instance_automated_backup option;
}
type nonrec delete_db_instance_automated_backup_message = {
  1. db_instance_automated_backups_arn : string_ option;
    (*

    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.

    *)
  2. dbi_resource_id : string_ option;
    (*

    The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    *)
}

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

type nonrec delete_db_cluster_snapshot_result = {
  1. db_cluster_snapshot : db_cluster_snapshot option;
}
type nonrec delete_db_cluster_snapshot_message = {
  1. db_cluster_snapshot_identifier : string_;
    (*

    The identifier of the DB cluster snapshot to delete.

    Constraints: Must be the name of an existing DB cluster snapshot in the available state.

    *)
}
type nonrec delete_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec delete_db_cluster_parameter_group_message = {
  1. db_cluster_parameter_group_name : string_;
    (*

    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.
    *)
}
type nonrec delete_db_cluster_message = {
  1. delete_automated_backups : boolean_optional option;
    (*

    Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the Amazon Web Services Backup policy specifies a point-in-time restore rule.

    *)
  2. final_db_snapshot_identifier : string_ option;
    (*

    The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

    If you specify this parameter and also skip the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter, the request results in an error.

    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
    *)
  3. skip_final_snapshot : boolean_ option;
    (*

    Specifies whether to skip the creation of a final DB cluster snapshot before RDS deletes the DB cluster. If you set this value to true, RDS doesn't create a final DB cluster snapshot. If you set this value to false or don't specify it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this parameter is disabled, so RDS creates a final DB cluster snapshot.

    If SkipFinalSnapshot is disabled, you must specify a value for the FinalDBSnapshotIdentifier parameter.

    *)
  4. db_cluster_identifier : string_;
    (*

    The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

    Constraints:

    • Must match an existing DBClusterIdentifier.
    *)
}
type nonrec delete_db_cluster_endpoint_message = {
  1. db_cluster_endpoint_identifier : string_;
    (*

    The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

    *)
}
type nonrec delete_db_cluster_automated_backup_result = {
  1. db_cluster_automated_backup : db_cluster_automated_backup option;
}
type nonrec delete_db_cluster_automated_backup_message = {
  1. db_cluster_resource_id : string_;
    (*

    The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

    *)
}
type nonrec db_cluster_snapshot_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec db_cluster_automated_backup_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec delete_custom_db_engine_version_message = {
  1. engine_version : custom_engine_version;
    (*

    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.

    *)
  2. engine : custom_engine_name;
    (*

    The database engine.

    RDS Custom for Oracle supports the following values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    • custom-oracle-se2
    • custom-oracle-se2-cdb

    RDS Custom for SQL Server supports the following values:

    • custom-sqlserver-ee
    • custom-sqlserver-se
    • custom-sqlserver-web
    • custom-sqlserver-dev

    RDS for SQL Server supports the following values:

    • sqlserver-ee (Bring Your Own Media)
    • sqlserver-se (Bring Your Own Media)
    • sqlserver-dev-ee
    *)
}
type nonrec delete_blue_green_deployment_response = {
  1. blue_green_deployment : blue_green_deployment option;
}
type nonrec delete_blue_green_deployment_request = {
  1. delete_target : boolean_optional option;
    (*

    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.

    *)
  2. blue_green_deployment_identifier : blue_green_deployment_identifier;
    (*

    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.
    *)
}
type nonrec db_subnet_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec db_subnet_group_not_allowed_fault = {
  1. message : exception_message option;
}

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

type nonrec db_subnet_group_already_exists_fault = {
  1. message : exception_message option;
}

DBSubnetGroupName is already used by an existing DB subnet group.

type nonrec db_security_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec db_security_group_not_supported_fault = {
  1. message : exception_message option;
}

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

type nonrec db_security_group_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec db_proxy_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec db_proxy_endpoint_quota_exceeded_fault = {
  1. message : exception_message option;
}

The DB proxy already has the maximum number of endpoints.

type nonrec db_parameter_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec db_parameter_group_already_exists_fault = {
  1. message : exception_message option;
}

A DB parameter group with the same name exists.

type nonrec db_instance_role_quota_exceeded_fault = {
  1. message : exception_message option;
}

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.

type nonrec db_instance_role_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec db_cluster_role_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec db_cluster_role_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec db_cluster_endpoint_quota_exceeded_fault = {
  1. message : exception_message option;
}

The cluster already has the maximum number of custom endpoints.

type nonrec db_cluster_endpoint_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec custom_db_engine_version_quota_exceeded_fault = {
  1. message : exception_message option;
}

You have exceeded your CEV quota.

type nonrec custom_db_engine_version_already_exists_fault = {
  1. message : exception_message option;
}

A CEV with the specified name already exists.

type nonrec custom_availability_zone_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec create_tenant_database_result = {
  1. tenant_database : tenant_database option;
}
type nonrec create_tenant_database_message = {
  1. tags : tag_list option;
  2. master_user_secret_kms_key_id : string_ option;
    (*

    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.

    *)
  3. manage_master_user_password : boolean_optional option;
    (*

    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.
    *)
  4. nchar_character_set_name : string_ option;
    (*

    The NCHAR value for the tenant database.

    *)
  5. character_set_name : string_ option;
    (*

    The character set for your tenant database. If you don't specify a value, the character set name defaults to AL32UTF8.

    *)
  6. master_user_password : sensitive_string option;
    (*

    The password for the master user in your tenant database.

    Constraints:

    • Must be 8 to 30 characters.
    • Can include any printable ASCII character except forward slash (/), double quote ("), at symbol (@), ampersand (&), or single quote (').
    • Can't be specified when ManageMasterUserPassword is enabled.
    *)
  7. master_username : string_;
    (*

    The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.

    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.
    *)
  8. tenant_db_name : string_;
    (*

    The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.

    *)
  9. db_instance_identifier : string_;
    (*

    The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.

    *)
}
type nonrec create_option_group_result = {
  1. option_group : option_group option;
}
type nonrec create_option_group_message = {
  1. tags : tag_list option;
    (*

    Tags to assign to the option group.

    *)
  2. option_group_description : string_;
    (*

    The description of the option group.

    *)
  3. major_engine_version : string_;
    (*

    Specifies the major version of the engine that this option group should be associated with.

    *)
  4. engine_name : string_;
    (*

    The name of the engine to associate this option group with.

    Valid Values:

    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    *)
  5. option_group_name : string_;
    (*

    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

    *)
}
type nonrec create_integration_message = {
  1. description : integration_description option;
    (*

    A description of the integration.

    *)
  2. data_filter : data_filter option;
    (*

    Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift.

    *)
  3. tags : tag_list option;
  4. additional_encryption_context : encryption_context_map option;
    (*

    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

    You can only include this parameter if you specify the KMSKeyId parameter.

    *)
  5. kms_key_id : string_ option;
    (*

    The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.

    *)
  6. integration_name : integration_name;
    (*

    The name of the integration.

    *)
  7. target_arn : arn;
    (*

    The ARN of the Redshift data warehouse to use as the target for replication.

    *)
  8. source_arn : source_arn;
    (*

    The Amazon Resource Name (ARN) of the database to use as the source for replication.

    *)
}
type nonrec create_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec create_global_cluster_message = {
  1. tags : tag_list option;
    (*

    Tags to assign to the global cluster.

    *)
  2. storage_encrypted : boolean_optional option;
    (*

    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.
    *)
  3. database_name : string_ option;
    (*

    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.
    *)
  4. deletion_protection : boolean_optional option;
    (*

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

    *)
  5. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this global database cluster.

    By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.

    This setting only applies to Aurora PostgreSQL-based global databases.

    You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide.

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  6. engine_version : string_ option;
    (*

    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.
    *)
  7. engine : string_ option;
    (*

    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.
    *)
  8. source_db_cluster_identifier : string_ option;
    (*

    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
    *)
  9. global_cluster_identifier : global_cluster_identifier;
    (*

    The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

    *)
}
type nonrec create_event_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec create_event_subscription_message = {
  1. tags : tag_list option;
  2. enabled : boolean_optional option;
    (*

    Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

    *)
  3. source_ids : source_ids_list option;
    (*

    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.
    *)
  4. event_categories : event_categories_list option;
    (*

    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.

    *)
  5. source_type : string_ option;
    (*

    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 | zero-etl | custom-engine-version | blue-green-deployment

    *)
  6. sns_topic_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.

    RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.

    *)
  7. subscription_name : string_;
    (*

    The name of the subscription.

    Constraints: The name must be less than 255 characters.

    *)
}
type nonrec create_db_subnet_group_result = {
  1. db_subnet_group : db_subnet_group option;
}
type nonrec create_db_subnet_group_message = {
  1. tags : tag_list option;
    (*

    Tags to assign to the DB subnet group.

    *)
  2. subnet_ids : subnet_identifier_list;
    (*

    The EC2 Subnet IDs for the DB subnet group.

    *)
  3. db_subnet_group_description : string_;
    (*

    The description for the DB subnet group.

    *)
  4. db_subnet_group_name : string_;
    (*

    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

    *)
}
type nonrec create_db_snapshot_result = {
  1. db_snapshot : db_snapshot option;
}
type nonrec create_db_snapshot_message = {
  1. tags : tag_list option;
  2. db_instance_identifier : string_;
    (*

    The identifier of the DB instance that you want to create the snapshot of.

    Constraints:

    • Must match the identifier of an existing DBInstance.
    *)
  3. db_snapshot_identifier : string_;
    (*

    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

    *)
}
type nonrec create_db_shard_group_message = {
  1. tags : tag_list option;
  2. publicly_accessible : boolean_optional option;
    (*

    Specifies whether the DB shard group is publicly accessible.

    When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.

    When the DB shard group isn't publicly accessible, it is an internal DB shard group 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 shard group is private.
    • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group 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 shard group is private.
    • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
    *)
  3. min_ac_u : double_optional option;
    (*

    The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

    *)
  4. max_ac_u : double_optional;
    (*

    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

    *)
  5. compute_redundancy : integer_optional option;
    (*

    Specifies whether to create standby standby DB data access shard for the DB shard group. Valid values are the following:

    • 0 - Creates a DB shard group without a standby DB data access shard. This is the default value.
    • 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ).
    • 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.
    *)
  6. db_cluster_identifier : string_;
    (*

    The name of the primary DB cluster for the DB shard group.

    *)
  7. db_shard_group_identifier : string_;
    (*

    The name of the DB shard group.

    *)
}
type nonrec create_db_security_group_result = {
  1. db_security_group : db_security_group option;
}
type nonrec create_db_security_group_message = {
  1. tags : tag_list option;
    (*

    Tags to assign to the DB security group.

    *)
  2. db_security_group_description : string_;
    (*

    The description for the DB security group.

    *)
  3. db_security_group_name : string_;
    (*

    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

    *)
}
type nonrec create_db_proxy_response = {
  1. db_proxy : db_proxy option;
    (*

    The DBProxy structure corresponding to the new proxy.

    *)
}
type nonrec create_db_proxy_request = {
  1. target_connection_network_type : target_connection_network_type option;
    (*

    The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

    Valid values:

    • IPV4 - The proxy connects to the database using IPv4 only.
    • IPV6 - The proxy connects to the database using IPv6 only.

    Default: IPV4

    Constraints:

    • If you specify IPV6, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.
    • All targets registered with the proxy must be compatible with the specified network type.
    *)
  2. endpoint_network_type : endpoint_network_type option;
    (*

    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

    Valid values:

    • IPV4 - The proxy endpoint supports IPv4 only.
    • IPV6 - The proxy endpoint supports IPv6 only.
    • DUAL - The proxy endpoint supports both IPv4 and IPv6.

    Default: IPV4

    Constraints:

    • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.
    • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.
    *)
  3. tags : tag_list option;
    (*

    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

    *)
  4. debug_logging : boolean_ option;
    (*

    Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

    *)
  5. idle_client_timeout : integer_optional option;
    (*

    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.

    *)
  6. require_tl_s : boolean_ option;
    (*

    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.

    *)
  7. vpc_security_group_ids : string_list option;
    (*

    One or more VPC security group IDs to associate with the new proxy.

    *)
  8. vpc_subnet_ids : string_list;
    (*

    One or more VPC subnet IDs to associate with the new proxy.

    *)
  9. role_arn : arn;
    (*

    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

    *)
  10. auth : user_auth_config_list option;
    (*

    The authorization mechanism that the proxy uses.

    *)
  11. default_auth_scheme : default_auth_scheme option;
    (*

    The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify DefaultAuthScheme or specify this parameter as NONE, you must specify the Auth option.

    *)
  12. engine_family : engine_family;
    (*

    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.

    *)
  13. db_proxy_name : db_proxy_name;
    (*

    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.

    *)
}
type nonrec create_db_proxy_endpoint_response = {
  1. db_proxy_endpoint : db_proxy_endpoint option;
    (*

    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.

    *)
}
type nonrec create_db_proxy_endpoint_request = {
  1. endpoint_network_type : endpoint_network_type option;
    (*

    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

    Valid values:

    • IPV4 - The proxy endpoint supports IPv4 only.
    • IPV6 - The proxy endpoint supports IPv6 only.
    • DUAL - The proxy endpoint supports both IPv4 and IPv6.

    Default: IPV4

    Constraints:

    • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.
    • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.
    *)
  2. tags : tag_list option;
  3. target_role : db_proxy_endpoint_target_role option;
    (*

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

    *)
  4. vpc_security_group_ids : string_list option;
    (*

    The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

    *)
  5. vpc_subnet_ids : string_list;
    (*

    The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

    *)
  6. db_proxy_endpoint_name : db_proxy_endpoint_name;
    (*

    The name of the DB proxy endpoint to create.

    *)
  7. db_proxy_name : db_proxy_name;
    (*

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

    *)
}
type nonrec create_db_parameter_group_result = {
  1. db_parameter_group : db_parameter_group option;
}
type nonrec create_db_parameter_group_message = {
  1. tags : tag_list option;
    (*

    Tags to assign to the DB parameter group.

    *)
  2. description : string_;
    (*

    The description for the DB parameter group.

    *)
  3. db_parameter_group_family : string_;
    (*

    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 output contains duplicates.

    The following are the valid DB engine values:

    • aurora-mysql
    • aurora-postgresql
    • db2-ae
    • db2-ce
    • db2-se
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    *)
  4. db_parameter_group_name : string_;
    (*

    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

    This value is stored as a lowercase string.

    *)
}
type nonrec create_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec create_db_instance_read_replica_result = {
  1. db_instance : db_instance option;
}
type nonrec create_db_instance_read_replica_message = {
  1. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB instance.

    Valid Values:

    • auto-backup - The DB instance's automated backup.
    *)
  2. additional_storage_volumes : additional_storage_volumes_list option;
    (*

    A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.

    *)
  3. ca_certificate_identifier : string_ option;
    (*

    The CA certificate identifier to use for the read replica'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.

    *)
  4. upgrade_storage_config : boolean_optional option;
    (*

    Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.

    *)
  5. dedicated_log_volume : boolean_optional option;
    (*

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

    *)
  6. source_db_cluster_identifier : string_ option;
    (*

    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.
    *)
  7. allocated_storage : integer_optional option;
    (*

    The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.

    This setting isn't valid for RDS for SQL Server.

    Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.

    *)
  8. custom_iam_instance_profile : string_ option;
    (*

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

    *)
  9. backup_target : string_ option;
    (*

    The location where RDS stores automated backups and manual snapshots.

    Valid Values:

    • local for Dedicated Local Zones
    • region for Amazon Web Services Region
    *)
  10. max_allocated_storage : integer_optional option;
    (*

    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.

    *)
  11. network_type : string_ option;
    (*

    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.

    *)
  12. enable_customer_owned_ip : boolean_optional option;
    (*

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

    *)
  13. replica_mode : replica_mode option;
    (*

    The open mode of the replica database.

    This parameter is only supported for Db2 DB instances and Oracle DB instances.

    Db2 Standby DB replicas are included in Db2 Advanced Edition (AE), Db2 Community Edition (CE), and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload.

    You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide.

    To create standby DB replicas for RDS for Db2, set this parameter to mounted.

    Oracle 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 read replicas for Amazon RDS for Oracle 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.

    *)
  14. domain_dns_ips : string_list option;
    (*

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

    Constraints:

    • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    Example: 123.124.125.126,234.235.236.237

    *)
  15. domain_auth_secret_arn : string_ option;
    (*

    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

    *)
  16. domain_ou : string_ option;
    (*

    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

    *)
  17. domain_fqdn : string_ option;
    (*

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

    Constraints:

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    *)
  18. domain_iam_role_name : string_ option;
    (*

    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.

    *)
  19. domain : string_ option;
    (*

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

    *)
  20. deletion_protection : boolean_optional option;
    (*

    Specifies whether to enable deletion protection for the DB instance. 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.

    *)
  21. use_default_processor_features : boolean_optional option;
    (*

    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.

    *)
  22. processor_features : processor_feature_list option;
    (*

    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.

    *)
  23. enable_cloudwatch_logs_exports : log_type_list option;
    (*

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

    *)
  24. performance_insights_retention_period : integer_optional option;
    (*

    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.

    *)
  25. performance_insights_kms_key_id : string_ option;
    (*

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

    *)
  26. enable_performance_insights : boolean_optional option;
    (*

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

    *)
  27. database_insights_mode : database_insights_mode option;
    (*

    The mode of Database Insights to enable for the read replica.

    This setting isn't supported.

    *)
  28. enable_iam_database_authentication : boolean_optional option;
    (*

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

    *)
  29. pre_signed_url : sensitive_string option;
    (*

    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.

    If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

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

    *)
  30. kms_key_id : string_ option;
    (*

    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.

    *)
  31. monitoring_role_arn : string_ option;
    (*

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

    *)
  32. monitoring_interval : integer_optional option;
    (*

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 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

    *)
  33. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  34. storage_type : string_ option;
    (*

    The storage type to associate with the read replica.

    If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

    Valid Values: gp2 | gp3 | io1 | io2 | standard

    Default: io1 if the Iops parameter is specified. Otherwise, gp3.

    *)
  35. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of Amazon EC2 VPC security groups to associate with the read replica.

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

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    *)
  36. db_subnet_group_name : string_ option;
    (*

    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 DB subnet group.
    • 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

    *)
  37. tags : tag_list option;
  38. publicly_accessible : boolean_optional option;
    (*

    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.

    For more information, see CreateDBInstance.

    *)
  39. db_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group to associate with this read replica DB instance.

    For the Db2 DB engine, if your source DB instance uses the bring your own license (BYOL) model, then a custom parameter group must be associated with the replica. For a same Amazon Web Services Region replica, if you don't specify a custom parameter group, Amazon RDS associates the custom parameter group associated with the source DB instance. For a cross-Region replica, you must specify a custom parameter group. This custom parameter group must include your IBM Site ID and IBM Customer ID. For more information, see IBM IDs for bring your own license (BYOL) for Db2.

    For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of the source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.

    For Multi-AZ DB cluster same Region read replica instances, if you don't specify a value for DBParameterGroupName, then Amazon RDS uses the default DBParameterGroup.

    Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas, for Multi-AZ DB cluster read replica instances, for Db2 DB instances, and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or 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.
    *)
  40. option_group_name : string_ option;
    (*

    The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.

    For SQL Server, you must use the option group associated with the source.

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

    *)
  41. storage_throughput : integer_optional option;
    (*

    Specifies the storage throughput value for the read replica.

    This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.

    *)
  42. iops : integer_optional option;
    (*

    The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

    *)
  43. auto_minor_version_upgrade : boolean_optional option;
    (*

    Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.

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

    Default: Inherits the value from the source DB instance.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  44. multi_a_z : boolean_optional option;
    (*

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

    *)
  45. port : integer_optional option;
    (*

    The port number that the DB instance uses for connections.

    Valid Values: 1150-65535

    Default: Inherits the value from the source DB instance.

    *)
  46. availability_zone : string_ option;
    (*

    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

    *)
  47. db_instance_class : string_ option;
    (*

    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 the value from the source DB instance.

    *)
  48. source_db_instance_identifier : string_ option;
    (*

    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, except for the following engines:

    • Db2 - Can have up to three replicas.
    • Oracle - Can have up to five read replicas.
    • SQL Server - Can have up to five read replicas.

    Constraints:

    • Must be the identifier of an existing Db2, MariaDB, MySQL, 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.
    *)
  49. db_instance_identifier : string_;
    (*

    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.

    *)
}
type nonrec create_db_instance_message = {
  1. master_user_authentication_type : master_user_authentication_type option;
    (*

    Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB instance.

    You can specify one of the following values:

    • password - Use standard database authentication with a password.
    • iam-db-auth - Use IAM database authentication for the master user.

    This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.

    *)
  2. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB instance.

    Valid Values:

    • auto-backup - The DB instance's automated backup.
    *)
  3. additional_storage_volumes : additional_storage_volumes_list option;
    (*

    A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.

    *)
  4. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this DB instance.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.

    This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

    You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  5. dedicated_log_volume : boolean_optional option;
    (*

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

    *)
  6. multi_tenant : boolean_optional option;
    (*

    Specifies whether to use the multi-tenant configuration or the single-tenant configuration (default). This parameter only applies to RDS for Oracle container database (CDB) engines.

    Note the following restrictions:

    • The DB engine that you specify in the request must support the multi-tenant configuration. If you attempt to enable the multi-tenant configuration on a DB engine that doesn't support it, the request fails.
    • If you specify the multi-tenant configuration when you create your DB instance, you can't later modify this DB instance to use the single-tenant configuration.
    *)
  7. master_user_secret_kms_key_id : string_ option;
    (*

    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.

    *)
  8. manage_master_user_password : boolean_optional option;
    (*

    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.
    *)
  9. ca_certificate_identifier : string_ option;
    (*

    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.

    *)
  10. db_system_id : string_ option;
    (*

    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.

    *)
  11. custom_iam_instance_profile : string_ option;
    (*

    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.

    *)
  12. backup_target : string_ option;
    (*

    The location for storing automated backups and manual snapshots.

    Valid Values:

    • local (Dedicated Local Zone)
    • 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.

    *)
  13. network_type : string_ option;
    (*

    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

    *)
  14. enable_customer_owned_ip : boolean_optional option;
    (*

    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.

    *)
  15. max_allocated_storage : integer_optional option;
    (*

    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
    *)
  16. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  17. processor_features : processor_feature_list option;
    (*

    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.

    *)
  18. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    The list of log types to enable 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 Db2 - diag.log | notify.log | iam-db-auth-error
    • RDS for MariaDB - audit | error | general | slowquery | iam-db-auth-error
    • RDS for Microsoft SQL Server - agent | error
    • RDS for MySQL - audit | error | general | slowquery | iam-db-auth-error
    • RDS for Oracle - alert | audit | listener | trace | oemagent
    • RDS for PostgreSQL - postgresql | upgrade | iam-db-auth-error
    *)
  19. performance_insights_retention_period : integer_optional option;
    (*

    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.

    *)
  20. performance_insights_kms_key_id : string_ option;
    (*

    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.

    *)
  21. enable_performance_insights : boolean_optional option;
    (*

    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.

    *)
  22. database_insights_mode : database_insights_mode option;
    (*

    The mode of Database Insights to enable for the DB instance.

    Aurora DB instances inherit this value from the DB cluster, so you can't change this value.

    *)
  23. enable_iam_database_authentication : boolean_optional option;
    (*

    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
    *)
  24. timezone : string_ option;
    (*

    The time zone of the DB instance. The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server.

    *)
  25. promotion_tier : integer_optional option;
    (*

    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

    *)
  26. domain_iam_role_name : string_ option;
    (*

    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
    *)
  27. monitoring_role_arn : string_ option;
    (*

    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.

    *)
  28. monitoring_interval : integer_optional option;
    (*

    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

    *)
  29. copy_tags_to_snapshot : boolean_optional option;
    (*

    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.

    *)
  30. domain_dns_ips : string_list option;
    (*

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

    Constraints:

    • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    Example: 123.124.125.126,234.235.236.237

    *)
  31. domain_auth_secret_arn : string_ option;
    (*

    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

    *)
  32. domain_ou : string_ option;
    (*

    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

    *)
  33. domain_fqdn : string_ option;
    (*

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

    Constraints:

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    *)
  34. domain : string_ option;
    (*

    The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, 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 the following DB instances:

    • Amazon Aurora (The domain is managed by the DB cluster.)
    • RDS Custom
    *)
  35. kms_key_id : string_ option;
    (*

    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.

    *)
  36. storage_encrypted : boolean_optional option;
    (*

    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.

    *)
  37. tde_credential_password : sensitive_string option;
    (*

    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.

    *)
  38. tde_credential_arn : string_ option;
    (*

    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.

    *)
  39. storage_type : string_ option;
    (*

    The storage type to associate with the DB instance.

    If you specify io1, io2, 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 | io2 | standard

    Default: io1, if the Iops parameter is specified. Otherwise, gp3.

    *)
  40. db_cluster_identifier : string_ option;
    (*

    The identifier of the DB cluster that this DB instance will belong to.

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

    *)
  41. tags : tag_list option;
    (*

    Tags to assign to the DB instance.

    *)
  42. publicly_accessible : boolean_optional option;
    (*

    Specifies whether the DB instance is publicly accessible.

    When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is controlled by its security group settings.

    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.

    The default behavior when PubliclyAccessible is not specified depends on whether a DBSubnetGroup is specified.

    If DBSubnetGroup isn't specified, PubliclyAccessible defaults to false for Aurora instances and true for non-Aurora instances.

    If DBSubnetGroup is specified, PubliclyAccessible defaults to false unless the value of DBSubnetGroup is default, in which case PubliclyAccessible defaults to true.

    If PubliclyAccessible is true and the VPC that the DBSubnetGroup is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.

    *)
  43. nchar_character_set_name : string_ option;
    (*

    The name of the NCHAR character set for the Oracle DB instance.

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

    *)
  44. character_set_name : string_ option;
    (*

    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.
    *)
  45. option_group_name : string_ option;
    (*

    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.

    *)
  46. storage_throughput : integer_optional option;
    (*

    The storage throughput value, in mebibyte per second (MiBps), 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.

    *)
  47. iops : integer_optional option;
    (*

    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 Db2, 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.
    *)
  48. license_model : string_ option;
    (*

    The license model information for this DB instance.

    License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide.

    The default for RDS for Db2 is bring-your-own-license.

    This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

    Valid Values:

    • RDS for Db2 - bring-your-own-license | marketplace-license
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included | bring-your-own-media
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license | license-included
    • RDS for PostgreSQL - postgresql-license
    *)
  49. auto_minor_version_upgrade : boolean_optional option;
    (*

    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.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  50. engine_version : string_ option;
    (*

    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 Db2 For information, see Db2 on Amazon RDS versions 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.

    *)
  51. multi_a_z : boolean_optional option;
    (*

    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 Amazon Aurora because the DB instance Availability Zones (AZs) are managed by the DB cluster.

    *)
  52. port : integer_optional option;
    (*

    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 Db2 - 50000
    • 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.
    *)
  53. preferred_backup_window : string_ option;
    (*

    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.
    *)
  54. backup_retention_period : integer_optional option;
    (*

    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.
    *)
  55. db_parameter_group_name : string_ option;
    (*

    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.
    *)
  56. preferred_maintenance_window : string_ option;
    (*

    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.
    *)
  57. db_subnet_group_name : string_ option;
    (*

    A DB subnet group to associate with this DB instance.

    Constraints:

    • Must match the name of an existing DB subnet group.

    Example: mydbsubnetgroup

    *)
  58. availability_zone : string_ option;
    (*

    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

    *)
  59. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    *)
  60. db_security_groups : db_security_group_name_list option;
    (*

    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.

    *)
  61. master_user_password : sensitive_string option;
    (*

    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 "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.

    Length Constraints:

    • RDS for Db2 - Must contain from 8 to 255 characters.
    • 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.
    *)
  62. master_username : string_ option;
    (*

    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.
    *)
  63. engine : string_;
    (*

    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-oracle-se2 (for RDS Custom for Oracle DB instances)
    • custom-oracle-se2-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)
    • custom-sqlserver-dev (for RDS Custom for SQL Server DB instances)
    • db2-ae
    • db2-ce
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-dev-ee
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    *)
  64. db_instance_class : string_;
    (*

    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.

    *)
  65. allocated_storage : integer_optional option;
    (*

    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, io2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

    RDS for Db2 Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.
    • Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.

    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, io2): 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, io2): 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, io2): 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, io2): 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, io2):

      • 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.
    *)
  66. db_instance_identifier : string_;
    (*

    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

    *)
  67. db_name : string_ option;
    (*

    The meaning of this parameter differs according to the database engine you use.

    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:

    • Must contain 1 to 64 alphanumeric characters.
    • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
    • 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. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

    Constraints:

    • It must contain 1 to 63 alphanumeric characters.
    • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
    • Can't be a word reserved by the database engine.

    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:

    • Must contain 1 to 8 alphanumeric characters.
    • Must contain a letter.
    • Can't be a word reserved by the database engine.

    Amazon RDS Custom for SQL Server Not applicable. Must be null.

    RDS for Db2 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. In some cases, we recommend that you don't add a database name. For more information, see Additional considerations in the Amazon RDS User Guide.

    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.

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

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

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

    RDS for PostgreSQL The name of the database to create when the DB instance is created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

    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.

    RDS for SQL Server Not applicable. Must be null.

    *)
}
type nonrec create_db_cluster_snapshot_result = {
  1. db_cluster_snapshot : db_cluster_snapshot option;
}
type nonrec create_db_cluster_snapshot_message = {
  1. tags : tag_list option;
    (*

    The tags to be assigned to the DB cluster snapshot.

    *)
  2. db_cluster_identifier : string_;
    (*

    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

    *)
  3. db_cluster_snapshot_identifier : string_;
    (*

    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

    *)
}
type nonrec create_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec create_db_cluster_parameter_group_result = {
  1. db_cluster_parameter_group : db_cluster_parameter_group option;
}
type nonrec create_db_cluster_parameter_group_message = {
  1. tags : tag_list option;
    (*

    Tags to assign to the DB cluster parameter group.

    *)
  2. description : string_;
    (*

    The description for the DB cluster parameter group.

    *)
  3. db_parameter_group_family : string_;
    (*

    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: postgres13

    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 output contains duplicates.

    The following are the valid DB engine values:

    • aurora-mysql
    • aurora-postgresql
    • mysql
    • postgres
    *)
  4. db_cluster_parameter_group_name : string_;
    (*

    The name of the DB cluster parameter group.

    Constraints:

    • Must not match the name of an existing DB cluster parameter group.

    This value is stored as a lowercase string.

    *)
}
type nonrec create_db_cluster_message = {
  1. with_express_configuration : boolean_optional option;
    (*

    Specifies to create an Aurora DB Cluster with express configuration in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API.

    Valid for Cluster Type: Aurora DB clusters

    *)
  2. master_user_authentication_type : master_user_authentication_type option;
    (*

    Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.

    You can specify one of the following values:

    • password - Use standard database authentication with a password.
    • iam-db-auth - Use IAM database authentication for the master user.

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

    This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.

    *)
  3. tag_specifications : tag_specification_list option;
    (*

    Tags to assign to resources associated with the DB cluster.

    Valid Values:

    • cluster-auto-backup - The DB cluster's automated backup.
    *)
  4. engine_lifecycle_support : string_ option;
    (*

    The life cycle type for this DB cluster.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.

    You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

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

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

    *)
  5. ca_certificate_identifier : string_ option;
    (*

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

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

    Valid for Cluster Type: Multi-AZ DB clusters

    *)
  6. master_user_secret_kms_key_id : string_ option;
    (*

    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

    *)
  7. enable_local_write_forwarding : boolean_optional option;
    (*

    Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

    Valid for: Aurora DB clusters only

    *)
  8. manage_master_user_password : boolean_optional option;
    (*

    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.
    *)
  9. db_system_id : string_ option;
    (*

    Reserved for future use.

    *)
  10. cluster_scalability_type : cluster_scalability_type option;
    (*

    Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.

    Valid for: Aurora DB clusters only

    You can't modify this setting after you create the DB cluster.

    *)
  11. enable_limitless_database : boolean_optional option;
    (*

    Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

    Valid for: Aurora DB clusters only

    This setting is no longer used. Instead use the ClusterScalabilityType setting.

    *)
  12. performance_insights_retention_period : integer_optional option;
    (*

    The number of days to retain Performance Insights data.

    Valid for Cluster Type: Aurora DB clusters and 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

    If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

    *)
  13. performance_insights_kms_key_id : string_ option;
    (*

    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: Aurora DB clusters and Multi-AZ DB clusters

    *)
  14. enable_performance_insights : boolean_optional option;
    (*

    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: Aurora DB clusters and Multi-AZ DB clusters

    *)
  15. database_insights_mode : database_insights_mode option;
    (*

    The mode of Database Insights to enable for the DB cluster.

    If you set this value to advanced, you must also set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.

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

    *)
  16. monitoring_role_arn : string_ option;
    (*

    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: Aurora DB clusters and Multi-AZ DB clusters

    *)
  17. monitoring_interval : integer_optional option;
    (*

    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: Aurora DB clusters and Multi-AZ DB clusters

    Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

    Default: 0

    *)
  18. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
  19. network_type : string_ option;
    (*

    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

    *)
  20. enable_global_write_forwarding : boolean_optional option;
    (*

    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

    *)
  21. domain_iam_role_name : string_ option;
    (*

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

    Valid for Cluster Type: Aurora DB clusters only

    *)
  22. domain : string_ option;
    (*

    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

    *)
  23. copy_tags_to_snapshot : boolean_optional option;
    (*

    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

    *)
  24. enable_http_endpoint : boolean_optional option;
    (*

    Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.

    When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

    For more information, see Using RDS Data API in the Amazon Aurora User Guide.

    Valid for Cluster Type: Aurora DB clusters only

    *)
  25. global_cluster_identifier : global_cluster_identifier option;
    (*

    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

    *)
  26. deletion_protection : boolean_optional option;
    (*

    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

    *)
  27. auto_minor_version_upgrade : boolean_optional option;
    (*

    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: Aurora DB clusters and Multi-AZ DB cluster.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

    *)
  28. publicly_accessible : boolean_optional option;
    (*

    Specifies whether the DB cluster is publicly accessible.

    Valid for Cluster Type: Multi-AZ DB clusters only

    When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is controlled by its security group settings.

    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.

    The default behavior when PubliclyAccessible is not specified depends on whether a DBSubnetGroup is specified.

    If DBSubnetGroup isn't specified, PubliclyAccessible defaults to true.

    If DBSubnetGroup is specified, PubliclyAccessible defaults to false unless the value of DBSubnetGroup is default, in which case PubliclyAccessible defaults to true.

    If PubliclyAccessible is true and the VPC that the DBSubnetGroup is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.

    *)
  29. iops : integer_optional option;
    (*

    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.
    *)
  30. storage_type : string_ option;
    (*

    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 | io2 | gp3

    Default:

    • Aurora DB clusters - aurora
    • Multi-AZ DB clusters - io1

    When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to aurora.

    *)
  31. allocated_storage : integer_optional option;
    (*

    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.

    *)
  32. db_cluster_instance_class : string_ option;
    (*

    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

    *)
  33. rds_custom_cluster_configuration : rds_custom_cluster_configuration option;
    (*

    Reserved for future use.

    *)
  34. scaling_configuration : scaling_configuration option;
    (*

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    Valid for Cluster Type: Aurora DB clusters only

    *)
  35. engine_mode : string_ option;
    (*

    The DB engine mode of the DB cluster, either provisioned or serverless.

    The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.

    For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:

    Valid for Cluster Type: Aurora DB clusters only

    *)
  36. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    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 | instance | slowquery | iam-db-auth-error
    • Aurora PostgreSQL - instance | postgresql | iam-db-auth-error
    • RDS for MySQL - error | general | slowquery | iam-db-auth-error
    • RDS for PostgreSQL - postgresql | upgrade | iam-db-auth-error

    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.

    *)
  37. backtrack_window : long_optional option;
    (*

    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).
    *)
  38. enable_iam_database_authentication : boolean_optional option;
    (*

    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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.

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

    *)
  39. pre_signed_url : sensitive_string option;
    (*

    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.

    If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

    Valid for Cluster Type: Aurora DB clusters only

    *)
  40. kms_key_id : string_ option;
    (*

    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

    *)
  41. storage_encrypted : boolean_optional option;
    (*

    Specifies whether the DB cluster is encrypted.

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

    *)
  42. tags : tag_list option;
    (*

    Tags to assign to the DB cluster.

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

    *)
  43. replication_source_identifier : string_ option;
    (*

    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

    *)
  44. preferred_maintenance_window : string_ option;
    (*

    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.
    *)
  45. preferred_backup_window : string_ option;
    (*

    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.
    *)
  46. option_group_name : string_ option;
    (*

    The option group to associate the DB cluster with.

    DB clusters are associated with a default option group that can't be modified.

    *)
  47. master_user_password : sensitive_string option;
    (*

    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.
    *)
  48. master_username : string_ option;
    (*

    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.
    *)
  49. port : integer_optional option;
    (*

    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
    *)
  50. engine_version : string_ option;
    (*

    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:

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

    *)
  51. engine : string_;
    (*

    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
    • neptune - For information about using Amazon Neptune, see the Amazon Neptune User Guide.
    *)
  52. db_subnet_group_name : string_ option;
    (*

    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.

    Example: mydbsubnetgroup

    *)
  53. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of EC2 VPC security groups to associate with this DB cluster.

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

    *)
  54. db_cluster_parameter_group_name : string_ option;
    (*

    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.
    *)
  55. db_cluster_identifier : string_;
    (*

    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 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
    • First character must be a letter.
    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

    *)
  56. database_name : string_ option;
    (*

    The name for your database of up to 64 alphanumeric characters. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

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

    *)
  57. character_set_name : string_ option;
    (*

    The name of the character set (CharacterSet) to associate the DB cluster with.

    Valid for Cluster Type: Aurora DB clusters only

    *)
  58. backup_retention_period : integer_optional option;
    (*

    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.
    *)
  59. availability_zones : availability_zones option;
    (*

    A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.

    For the first three DB instances that you create, RDS distributes each DB instance to a different AZ that you specify. For additional DB instances that you create, RDS randomly distributes them to the AZs that you specified. For example, if you create a DB cluster with one writer instance and three reader instances, RDS might distribute the writer instance to AZ 1, the first reader instance to AZ 2, the second reader instance to AZ 3, and the third reader instance to either AZ 1, AZ 2, or AZ 3.

    For more information, see Availability Zones and High availability for Aurora DB instances in the Amazon Aurora User Guide.

    Valid for Cluster Type: Aurora DB clusters only

    Constraints:

    • Can't specify more than three AZs.
    *)
}
type nonrec create_db_cluster_endpoint_message = {
  1. tags : tag_list option;
    (*

    The tags to be assigned to the Amazon RDS resource.

    *)
  2. excluded_members : string_list option;
    (*

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.

    *)
  3. static_members : string_list option;
    (*

    List of DB instance identifiers that are part of the custom endpoint group.

    *)
  4. endpoint_type : string_;
    (*

    The type of the endpoint, one of: READER, WRITER, ANY.

    *)
  5. db_cluster_endpoint_identifier : string_;
    (*

    The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

    *)
  6. db_cluster_identifier : string_;
    (*

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    *)
}
type nonrec bucket_name = string
type nonrec create_custom_db_engine_version_message = {
  1. tags : tag_list option;
  2. manifest : custom_db_engine_version_manifest option;
    (*

    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.

    *)
  3. description : description option;
    (*

    An optional description of your CEV.

    *)
  4. use_aws_provided_latest_image : boolean_optional option;
    (*

    Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.

    *)
  5. source_custom_db_engine_version_identifier : string255 option;
    (*

    The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.

    *)
  6. kms_key_id : kms_key_id_or_arn option;
    (*

    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.

    *)
  7. image_id : string255 option;
    (*

    The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.

    *)
  8. database_installation_files : string_list option;
    (*

    The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS.

    For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), provide the SQL Server RTM ISO file once per major version and edition combination. Minor versions reuse the same file.

    *)
  9. database_installation_files_s3_prefix : string255 option;
    (*

    The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

    *)
  10. database_installation_files_s3_bucket_name : bucket_name option;
    (*

    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.

    *)
  11. engine_version : custom_engine_version;
    (*

    The name of your custom engine version (CEV).

    For RDS Custom for Oracle, the name format is 19.*customized_string*. For example, a valid CEV name is 19.my_cev1.

    For RDS Custom for SQL Server and RDS for SQL Server sqlserver-dev-ee, the name format is *major_engine_version*.*minor_engine_version*.*customized_string*. For example, a valid CEV name is 16.00.4215.2.my_cev1.

    For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), specify the RDS engine version that you want to use. For example, 16.00.4175.1.v1.

    The CEV name is unique per customer per Amazon Web Services Regions.

    *)
  12. engine : custom_engine_name;
    (*

    The database engine.

    RDS Custom for Oracle supports the following values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    • custom-oracle-se2
    • custom-oracle-se2-cdb

    RDS Custom for SQL Server supports the following values:

    • custom-sqlserver-ee
    • custom-sqlserver-se
    • custom-sqlserver-web
    • custom-sqlserver-dev

    RDS for SQL Server supports the following values:

    • sqlserver-ee (Bring Your Own Media)
    • sqlserver-se (Bring Your Own Media)
    • sqlserver-dev-ee
    *)
}
type nonrec create_custom_db_engine_version_fault = {
  1. message : exception_message option;
}

An error occurred while trying to create the CEV.

type nonrec create_blue_green_deployment_response = {
  1. blue_green_deployment : blue_green_deployment option;
}
type nonrec create_blue_green_deployment_request = {
  1. target_storage_throughput : integer_optional option;
    (*

    The storage throughput value for the green DB instance.

    This setting applies only to the gp3 storage type.

    This setting doesn't apply to Amazon Aurora blue/green deployments.

    *)
  2. target_allocated_storage : integer_optional option;
    (*

    The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance.

    This setting doesn't apply to Amazon Aurora blue/green deployments.

    *)
  3. target_storage_type : target_storage_type option;
    (*

    The storage type to associate with the green DB instance.

    Valid Values: gp2 | gp3 | io1 | io2

    This setting doesn't apply to Amazon Aurora blue/green deployments.

    *)
  4. target_iops : integer_optional option;
    (*

    The amount of Provisioned IOPS (input/output operations per second) to allocate for the green 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 blue/green deployments.

    *)
  5. upgrade_target_storage_config : boolean_optional option;
    (*

    Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB instance.

    *)
  6. target_db_instance_class : target_db_instance_class option;
    (*

    Specify the DB instance class for the databases in the green environment.

    This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.

    *)
  7. tags : tag_list option;
    (*

    Tags to assign to the blue/green deployment.

    *)
  8. target_db_cluster_parameter_group_name : target_db_cluster_parameter_group_name option;
    (*

    The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

    To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.

    *)
  9. target_db_parameter_group_name : target_db_parameter_group_name option;
    (*

    The DB parameter group associated with the DB instance in the green environment.

    To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.

    *)
  10. target_engine_version : target_engine_version option;
    (*

    The engine version of the database in the green environment.

    Specify the engine version to upgrade to in the green environment.

    *)
  11. source : database_arn;
    (*

    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.

    *)
  12. blue_green_deployment_name : blue_green_deployment_name;
    (*

    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.
    *)
}
type nonrec blue_green_deployment_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec copy_option_group_result = {
  1. option_group : option_group option;
}
type nonrec copy_option_group_message = {
  1. tags : tag_list option;
  2. target_option_group_description : string_;
    (*

    The description for the copied option group.

    *)
  3. target_option_group_identifier : string_;
    (*

    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

    *)
  4. source_option_group_identifier : string_;
    (*

    The identifier for the source option group.

    Constraints:

    • Must specify a valid option group.
    *)
}
type nonrec copy_db_snapshot_result = {
  1. db_snapshot : db_snapshot option;
}
type nonrec copy_db_snapshot_message = {
  1. snapshot_availability_zone : string_ option;
    (*

    Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

    *)
  2. copy_option_group : boolean_optional option;
    (*

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

    *)
  3. snapshot_target : string_ option;
    (*

    Configures the location where RDS will store copied snapshots.

    Valid Values:

    • local (Dedicated Local Zone)
    • outposts (Amazon Web Services Outposts)
    • region (Amazon Web Services Region)
    *)
  4. target_custom_availability_zone : string_ option;
    (*

    The external custom Availability Zone (CAZ) identifier for the target CAZ.

    Example: rds-caz-aiqhTgQv.

    *)
  5. option_group_name : string_ option;
    (*

    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.

    *)
  6. pre_signed_url : sensitive_string option;
    (*

    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.

    If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

    *)
  7. copy_tags : boolean_optional option;
    (*

    Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.

    *)
  8. tags : tag_list option;
  9. kms_key_id : string_ option;
    (*

    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.

    *)
  10. target_db_snapshot_identifier : string_;
    (*

    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

    *)
  11. source_db_snapshot_identifier : string_;
    (*

    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 you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

    If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. You can also specify an ARN of a snapshot that is in a different account and a different Amazon Web Services Region. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

    Constraints:

    • Must specify a valid source 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

    *)
}
type nonrec copy_db_parameter_group_result = {
  1. db_parameter_group : db_parameter_group option;
}
type nonrec copy_db_parameter_group_message = {
  1. tags : tag_list option;
  2. target_db_parameter_group_description : string_;
    (*

    A description for the copied DB parameter group.

    *)
  3. target_db_parameter_group_identifier : string_;
    (*

    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

    *)
  4. source_db_parameter_group_identifier : string_;
    (*

    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.
    *)
}
type nonrec copy_db_cluster_snapshot_result = {
  1. db_cluster_snapshot : db_cluster_snapshot option;
}
type nonrec copy_db_cluster_snapshot_message = {
  1. tags : tag_list option;
  2. copy_tags : boolean_optional option;
    (*

    Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

    *)
  3. pre_signed_url : sensitive_string option;
    (*

    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.

    If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

    *)
  4. kms_key_id : string_ option;
    (*

    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.

    *)
  5. target_db_cluster_snapshot_identifier : string_;
    (*

    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

    *)
  6. source_db_cluster_snapshot_identifier : string_;
    (*

    The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

    Constraints:

    • Must specify a valid source 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. You can also specify an ARN of a snapshot that is in a different account and a different Amazon Web Services Region. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

    Example: my-cluster-snapshot1

    *)
}
type nonrec copy_db_cluster_parameter_group_result = {
  1. db_cluster_parameter_group : db_cluster_parameter_group option;
}
type nonrec copy_db_cluster_parameter_group_message = {
  1. tags : tag_list option;
  2. target_db_cluster_parameter_group_description : string_;
    (*

    A description for the copied DB cluster parameter group.

    *)
  3. target_db_cluster_parameter_group_identifier : string_;
    (*

    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

    *)
  4. source_db_cluster_parameter_group_identifier : string_;
    (*

    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.
    *)
}
type nonrec cancel_export_task_message = {
  1. export_task_identifier : string_;
    (*

    The identifier of the snapshot or cluster export task to cancel.

    *)
}
type nonrec backtrack_db_cluster_message = {
  1. use_earliest_time_on_point_in_time_unavailable : boolean_optional option;
    (*

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

    *)
  2. force : boolean_optional option;
    (*

    Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

    *)
  3. backtrack_to : t_stamp;
    (*

    The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.

    If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

    Constraints:

    • Must contain a valid ISO 8601 timestamp.
    • Can't contain a timestamp set in the future.

    Example: 2017-07-08T18:00Z

    *)
  4. db_cluster_identifier : string_;
    (*

    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

    *)
}
type nonrec authorize_db_security_group_ingress_result = {
  1. db_security_group : db_security_group option;
}
type nonrec authorize_db_security_group_ingress_message = {
  1. ec2_security_group_owner_id : string_ option;
    (*

    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.

    *)
  2. ec2_security_group_id : string_ option;
    (*

    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.

    *)
  3. ec2_security_group_name : string_ option;
    (*

    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.

    *)
  4. cidri_p : string_ option;
    (*

    The IP range to authorize.

    *)
  5. db_security_group_name : string_;
    (*

    The name of the DB security group to add authorization to.

    *)
}
type nonrec authorization_quota_exceeded_fault = {
  1. message : exception_message option;
}

The DB security group authorization quota has been reached.

type nonrec authorization_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec apply_pending_maintenance_action_result = {
  1. resource_pending_maintenance_actions : resource_pending_maintenance_actions option;
}
type nonrec apply_pending_maintenance_action_message = {
  1. opt_in_type : string_;
    (*

    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.
    *)
  2. apply_action : string_;
    (*

    The pending maintenance action to apply to this resource.

    Valid Values:

    • ca-certificate-rotation
    • db-upgrade
    • hardware-maintenance
    • os-upgrade
    • system-update

    For more information about these actions, see Maintenance actions for Amazon Aurora or Maintenance actions for Amazon RDS.

    *)
  3. resource_identifier : string_;
    (*

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

    *)
}
type nonrec add_tags_to_resource_message = {
  1. tags : tag_list;
    (*

    The tags to be assigned to the Amazon RDS resource.

    *)
  2. resource_name : string_;
    (*

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

    *)
}
type nonrec add_source_identifier_to_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec add_source_identifier_to_subscription_message = {
  1. source_identifier : string_;
    (*

    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.
    *)
  2. subscription_name : string_;
    (*

    The name of the RDS event notification subscription you want to add a source identifier to.

    *)
}
type nonrec add_role_to_db_instance_message = {
  1. feature_name : string_;
    (*

    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.

    *)
  2. role_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

    *)
  3. db_instance_identifier : string_;
    (*

    The name of the DB instance to associate the IAM role with.

    *)
}
type nonrec add_role_to_db_cluster_message = {
  1. feature_name : string_ option;
    (*

    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.

    *)
  2. role_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

    *)
  3. db_cluster_identifier : string_;
    (*

    The name of the DB cluster to associate the IAM role with.

    *)
}