Module Smaws_Client_DocDB.Types

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

    The status of the VPC security group.

    *)
  2. vpc_security_group_id : string_ option;
    (*

    The name of the VPC security group.

    *)
}

Used as a response element for queries on virtual private cloud (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 boolean_ = bool
type nonrec upgrade_target = {
  1. is_major_version_upgrade : boolean_ option;
    (*

    A value that indicates whether a database engine is upgraded to a major version.

    *)
  2. auto_upgrade : boolean_ option;
    (*

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

    *)
  3. description : string_ option;
    (*

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

    *)
  4. engine_version : string_ option;
    (*

    The version number of the upgrade target database engine.

    *)
  5. engine : string_ option;
    (*

    The name of the upgrade target database engine.

    *)
}

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

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

    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 contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

    *)
  2. key : string_ option;
    (*

    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 contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

    *)
}

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

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

    A list of one or more tags.

    *)
}

Represents the output of ListTagsForResource.

type nonrec t_stamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec global_cluster_identifier = string
type nonrec boolean_optional = bool
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 Amazon DocumentDB cluster in the global cluster.

    *)
  2. is_writer : boolean_ option;
    (*

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

    *)
  3. readers : readers_arn_list option;
    (*

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

    *)
  4. db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

    *)
}

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

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 Amazon DocumentDB 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 Amazon DocumentDB 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 cluster and the specified secondary cluster are being verified before the operation starts.
    • failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.
    • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.
    *)
}

Contains the state of scheduled or in-process operations on an Amazon DocumentDB global cluster. This data type is empty unless a switchover or failover operation is scheduled or is in progress on the global cluster.

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

    A list of global cluster tags.

    *)
  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. This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

    *)
  3. global_cluster_members : global_cluster_member_list option;
    (*

    The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

    *)
  4. deletion_protection : boolean_optional option;
    (*

    The deletion protection setting for the new global cluster.

    *)
  5. storage_encrypted : boolean_optional option;
    (*

    The storage encryption setting for the global cluster.

    *)
  6. database_name : string_ option;
    (*

    The default database name within the new global cluster.

    *)
  7. engine_version : string_ option;
    (*

    Indicates the database engine version.

    *)
  8. engine : string_ option;
    (*

    The Amazon DocumentDB database engine used by the global cluster.

    *)
  9. status : string_ option;
    (*

    Specifies the current state of this global cluster.

    *)
  10. global_cluster_arn : string_ option;
    (*

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

    *)
  11. global_cluster_resource_id : string_ option;
    (*

    The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

    *)
  12. global_cluster_identifier : global_cluster_identifier option;
    (*

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

    *)
}

A data type representing an Amazon DocumentDB global cluster.

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 Amazon DocumentDB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.

    Constraints:

    • Must match the identifier of an existing secondary cluster.
    • Minimum length of 1. Maximum length of 255.

    Pattern: [A-Za-z][0-9A-Za-z-:._]*

    *)
  2. global_cluster_identifier : global_cluster_identifier;
    (*

    The identifier of the Amazon DocumentDB global database cluster to switch over. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster. This parameter isn’t case-sensitive.

    Constraints:

    • Must match the identifier of an existing global cluster (Amazon DocumentDB global database).
    • Minimum length of 1. Maximum length of 255.

    Pattern: [A-Za-z][0-9A-Za-z-:._]*

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

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

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

The cluster isn't in a valid state.

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

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

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

DBClusterIdentifier doesn't refer to an existing cluster.

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 provided category does not exist.

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

The provided subscription name already exists.

type nonrec availability_zone = {
  1. name : string_ option;
    (*

    The name of the Availability Zone.

    *)
}

Information about an Availability Zone.

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

    Specifies the status of the subnet.

    *)
  2. subnet_availability_zone : availability_zone option;
    (*

    Specifies the Availability Zone for the subnet.

    *)
  3. subnet_identifier : string_ option;
    (*

    Specifies the identifier of the subnet.

    *)
}

Detailed information about a subnet.

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

The subnet is already in use in the Availability Zone.

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

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

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

The request would cause you to exceed the allowed amount of storage available across all instances.

type nonrec availability_zones = string_ list
type nonrec integer_optional = int
type nonrec read_replica_identifier_list = string_ list
type nonrec db_cluster_member = {
  1. promotion_tier : integer_optional option;
    (*

    A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

    *)
  2. db_cluster_parameter_group_status : string_ option;
    (*

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

    *)
  3. is_cluster_writer : boolean_ option;
    (*

    A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

    *)
  4. db_instance_identifier : string_ option;
    (*

    Specifies the instance identifier for this member of the cluster.

    *)
}

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

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

    Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

    • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
    • PENDING - The IAMrole ARN is being associated with the cluster.
    • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
    *)
  2. role_arn : string_ option;
    (*

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

    *)
}

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

type nonrec db_cluster_roles = db_cluster_role list
type nonrec log_type_list = string_ list
type nonrec double_optional = float
type nonrec serverless_v2_scaling_configuration_info = {
  1. max_capacity : double_optional option;
    (*

    The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.

    *)
  2. min_capacity : double_optional option;
    (*

    The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

    *)
}

Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.

type nonrec cluster_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 Amazon DocumentDB 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 instance to turn off automatic management of database credentials, and then modify the 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 Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.

type nonrec db_cluster = {
  1. network_type : string_ option;
    (*

    The network type of the cluster.

    The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.

    Valid Values: IPV4 | DUAL

    *)
  2. master_user_secret : cluster_master_user_secret option;
    (*

    The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.

    *)
  3. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration_info option;
    (*

    The scaling configuration of an Amazon DocumentDB Serverless cluster.

    *)
  4. storage_type : string_ option;
    (*

    Storage type associated with your cluster

    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

    Valid values for storage type - standard | iopt1

    Default value is standard

    *)
  5. io_optimized_next_allowed_modification_time : t_stamp option;
    (*

    The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.

    *)
  6. deletion_protection : boolean_ option;
    (*

    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    *)
  7. enabled_cloudwatch_logs_exports : log_type_list option;
    (*

    A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

    *)
  8. cluster_create_time : t_stamp option;
    (*

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

    *)
  9. clone_group_id : string_ option;
    (*

    Identifies the clone group to which the DB cluster is associated.

    *)
  10. associated_roles : db_cluster_roles option;
    (*

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

    *)
  11. db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the cluster.

    *)
  12. db_cluster_resource_id : string_ option;
    (*

    The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

    *)
  13. kms_key_id : string_ option;
    (*

    If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

    *)
  14. storage_encrypted : boolean_ option;
    (*

    Specifies whether the cluster is encrypted.

    *)
  15. hosted_zone_id : string_ option;
    (*

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

    *)
  16. vpc_security_groups : vpc_security_group_membership_list option;
    (*

    Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

    *)
  17. db_cluster_members : db_cluster_member_list option;
    (*

    Provides the list of instances that make up the cluster.

    *)
  18. read_replica_identifiers : read_replica_identifier_list option;
    (*

    Contains one or more identifiers of the secondary clusters that are associated with this cluster.

    *)
  19. replication_source_identifier : string_ option;
    (*

    Contains the identifier of the source cluster if this cluster is a secondary cluster.

    *)
  20. preferred_maintenance_window : string_ option;
    (*

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

    *)
  21. preferred_backup_window : string_ option;
    (*

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

    *)
  22. master_username : string_ option;
    (*

    Contains the master user name for the cluster.

    *)
  23. port : integer_optional option;
    (*

    Specifies the port that the database engine is listening on.

    *)
  24. latest_restorable_time : t_stamp option;
    (*

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

    *)
  25. engine_version : string_ option;
    (*

    Indicates the database engine version.

    *)
  26. engine : string_ option;
    (*

    Provides the name of the database engine to be used for this cluster.

    *)
  27. multi_a_z : boolean_ option;
    (*

    Specifies whether the cluster has instances in multiple Availability Zones.

    *)
  28. reader_endpoint : string_ option;
    (*

    The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

    If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

    *)
  29. endpoint : string_ option;
    (*

    Specifies the connection endpoint for the primary instance of the cluster.

    *)
  30. earliest_restorable_time : t_stamp option;
    (*

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

    *)
  31. percent_progress : string_ option;
    (*

    Specifies the progress of the operation as a percentage.

    *)
  32. status : string_ option;
    (*

    Specifies the current state of this cluster.

    *)
  33. db_subnet_group : string_ option;
    (*

    Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

    *)
  34. db_cluster_parameter_group : string_ option;
    (*

    Specifies the name of the cluster parameter group for the cluster.

    *)
  35. db_cluster_identifier : string_ option;
    (*

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

    *)
  36. backup_retention_period : integer_optional option;
    (*

    Specifies the number of days for which automatic snapshots are retained.

    *)
  37. availability_zones : availability_zones option;
    (*

    Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

    *)
}

Detailed information about a cluster.

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

    The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

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

The specified instance isn't in the available state.

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

    The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

    *)
}
type nonrec source_type =
  1. | Db_cluster_snapshot
  2. | Db_cluster
  3. | Db_snapshot
  4. | Db_security_group
  5. | Db_parameter_group
  6. | Db_instance
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 snapshot_quota_exceeded_fault = {
  1. message : exception_message option;
}

The request would cause you to exceed the allowed number of snapshots.

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. max_capacity : double_optional option;
    (*

    The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.

    *)
  2. min_capacity : double_optional option;
    (*

    The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

    *)
}

Sets the scaling configuration of an Amazon DocumentDB Serverless cluster.

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

    The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.

    *)
  2. min_capacity : double_optional option;
    (*

    The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

    *)
}

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

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

The SNS topic Amazon Resource Name (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 Amazon Resource Name (ARN).

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

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

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

    The network type of the cluster.

    The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.

    Valid Values: IPV4 | DUAL

    *)
  2. storage_type : string_ option;
    (*

    The storage type to associate with the DB cluster.

    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

    Valid values for storage type - standard | iopt1

    Default value is standard

    *)
  3. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
    (*

    Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

    *)
  4. deletion_protection : boolean_optional option;
    (*

    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    *)
  5. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

    *)
  6. kms_key_id : string_ option;
    (*

    The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

    If you do not specify a value for the KmsKeyId parameter, then the following occurs:

    • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
    • If the cluster is not encrypted, then the restored cluster is not encrypted.

    If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

    *)
  7. tags : tag_list option;
    (*

    The tags to be assigned to the restored cluster.

    *)
  8. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of VPC security groups that the new cluster belongs to.

    *)
  9. db_subnet_group_name : string_ option;
    (*

    The subnet group name to use for the new cluster.

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

    Example: mySubnetgroup

    *)
  10. port : integer_optional option;
    (*

    The port number on which the new cluster accepts connections.

    Constraints: Must be a value from 1150 to 65535.

    Default: The default port for the engine.

    *)
  11. use_latest_restorable_time : boolean_ option;
    (*

    A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

    Default: false

    Constraints: Cannot be specified if the RestoreToTime parameter is provided.

    *)
  12. restore_to_time : t_stamp option;
    (*

    The date and time to restore the cluster to.

    Valid values: A time in Universal Coordinated Time (UTC) format.

    Constraints:

    • Must be before the latest restorable time for the instance.
    • Must be specified if the UseLatestRestorableTime parameter is not provided.
    • Cannot be specified if the UseLatestRestorableTime parameter is true.
    • Cannot be specified if the RestoreType parameter is copy-on-write.

    Example: 2015-03-07T23:45:00Z

    *)
  13. source_db_cluster_identifier : string_;
    (*

    The identifier of the source cluster from which to restore.

    Constraints:

    • Must match the identifier of an existing DBCluster.
    *)
  14. 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.

    Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

    If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

    *)
  15. db_cluster_identifier : string_;
    (*

    The name of the new cluster to be created.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.
    *)
}

Represents the input to RestoreDBClusterToPointInTime.

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

The network type is not supported by either DBSubnetGroup or the DB engine version.

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

An error occurred when accessing an KMS key.

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

The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

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

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

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

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

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

The state of the snapshot doesn't allow deletion.

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

The provided value isn't a valid cluster snapshot state.

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

There is not enough 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 cluster doesn't have enough capacity for the current operation.

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

DBSubnetGroupName doesn't refer to an existing subnet group.

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

DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

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

The cluster can't be created because you have reached the maximum allowed quota of clusters.

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

You already have a 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. network_type : string_ option;
    (*

    The network type of the cluster.

    The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.

    Valid Values: IPV4 | DUAL

    *)
  2. storage_type : string_ option;
    (*

    The storage type to associate with the DB cluster.

    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

    Valid values for storage type - standard | iopt1

    Default value is standard

    *)
  3. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
    (*

    Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

    *)
  4. db_cluster_parameter_group_name : string_ option;
    (*

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

    Type: String.       Required: No.

    If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

    *)
  5. deletion_protection : boolean_optional option;
    (*

    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    *)
  6. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

    *)
  7. kms_key_id : string_ option;
    (*

    The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If you do not specify a value for the KmsKeyId parameter, then the following occurs:

    • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
    • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
    *)
  8. tags : tag_list option;
    (*

    The tags to be assigned to the restored cluster.

    *)
  9. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

    *)
  10. db_subnet_group_name : string_ option;
    (*

    The name of the subnet group to use for the new cluster.

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

    Example: mySubnetgroup

    *)
  11. port : integer_optional option;
    (*

    The port number on which the new cluster accepts connections.

    Constraints: Must be a value from 1150 to 65535.

    Default: The same port as the original cluster.

    *)
  12. engine_version : string_ option;
    (*

    The version of the database engine to use for the new cluster.

    *)
  13. engine : string_;
    (*

    The database engine to use for the new cluster.

    Default: The same as source.

    Constraint: Must be compatible with the engine of the source.

    *)
  14. snapshot_identifier : string_;
    (*

    The identifier for the snapshot or cluster snapshot to restore from.

    You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

    Constraints:

    • Must match the identifier of an existing snapshot.
    *)
  15. db_cluster_identifier : string_;
    (*

    The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-snapshot-id

    *)
  16. availability_zones : availability_zones option;
    (*

    Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

    *)
}

Represents the input to RestoreDBClusterFromSnapshot.

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

DBSnapshotIdentifier doesn't refer to an existing snapshot.

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.

    *)
  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. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

    *)
  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. If this date is specified, any next-maintenance opt-in requests are ignored.

    *)
  6. action : string_ option;
    (*

    The type of pending maintenance action that is available for the resource.

    *)
}

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 Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

    *)
}

Represents the output of ApplyPendingMaintenanceAction.

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

The specified resource ID was not found.

type nonrec apply_method =
  1. | Pending_reboot
  2. | Immediate
type nonrec parameter = {
  1. apply_method : apply_method option;
    (*

    Indicates when to apply parameter updates.

    *)
  2. minimum_engine_version : string_ option;
    (*

    The earliest engine version to which the parameter can apply.

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

    *)
  4. allowed_values : string_ option;
    (*

    Specifies the valid range of values for the parameter.

    *)
  5. data_type : string_ option;
    (*

    Specifies the valid data type for the parameter.

    *)
  6. apply_type : string_ option;
    (*

    Specifies the engine-specific parameters type.

    *)
  7. source : string_ option;
    (*

    Indicates the source of the parameter value.

    *)
  8. description : string_ option;
    (*

    Provides a description of the parameter.

    *)
  9. parameter_value : string_ option;
    (*

    Specifies the value of the parameter. Must be one or more of the cluster parameter's AllowedValues in CSV format:

    Valid values are:

    • enabled: The cluster accepts secure connections using TLS version 1.0 through 1.3.
    • disabled: The cluster does not accept secure connections using TLS.
    • fips-140-3: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.
    • tls1.2+: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).
    • tls1.3+: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).
    *)
  10. parameter_name : string_ option;
    (*

    Specifies the name of the parameter.

    *)
}

Detailed information about an individual parameter.

type nonrec parameters_list = parameter list
type nonrec reset_db_cluster_parameter_group_message = {
  1. parameters : parameters_list option;
    (*

    A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

    *)
  2. reset_all_parameters : boolean_ option;
    (*

    A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. 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 cluster parameter group to reset.

    *)
}

Represents the input to ResetDBClusterParameterGroup.

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

The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

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

DBParameterGroupName doesn't refer to an existing parameter group.

type nonrec db_cluster_parameter_group_name_message = {
  1. db_cluster_parameter_group_name : string_ option;
    (*

    The name of a cluster parameter group.

    Constraints:

    • Must be from 1 to 255 letters or numbers.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    This value is stored as a lowercase string.

    *)
}

Contains the name of a cluster parameter group.

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 DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

    *)
}

Represents the input to RemoveTagsFromResource.

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

DBInstanceIdentifier doesn't refer to an existing instance.

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;
    (*

    A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

    *)
  3. event_categories_list : event_categories_list option;
    (*

    A list of event categories for the Amazon DocumentDB event notification subscription.

    *)
  4. source_ids_list : source_ids_list option;
    (*

    A list of source IDs for the Amazon DocumentDB event notification subscription.

    *)
  5. source_type : string_ option;
    (*

    The source type for the Amazon DocumentDB event notification subscription.

    *)
  6. subscription_creation_time : string_ option;
    (*

    The time at which the Amazon DocumentDB event notification subscription was created.

    *)
  7. status : string_ option;
    (*

    The status of the Amazon DocumentDB event notification subscription.

    Constraints:

    Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

    The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

    *)
  8. sns_topic_arn : string_ option;
    (*

    The topic ARN of the Amazon DocumentDB event notification subscription.

    *)
  9. cust_subscription_id : string_ option;
    (*

    The Amazon DocumentDB event notification subscription ID.

    *)
  10. customer_aws_id : string_ option;
    (*

    The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

    *)
}

Detailed information about an event to which you have subscribed.

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 instance identifier for an instance, or the name of a security group.

    *)
  2. subscription_name : string_;
    (*

    The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

    *)
}

Represents the input to RemoveSourceIdentifierFromSubscription.

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 Amazon DocumentDB global cluster.

    *)
  2. global_cluster_identifier : global_cluster_identifier;
    (*

    The cluster identifier to detach from the Amazon DocumentDB global cluster.

    *)
}

Represents the input to RemoveFromGlobalCluster.

type nonrec integer = 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 instance.

    *)
}

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

type nonrec network_type_list = string_ list
type nonrec db_subnet_group = {
  1. supported_network_types : network_type_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).

    *)
  2. db_subnet_group_arn : string_ option;
    (*

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

    *)
  3. subnets : subnet_list option;
    (*

    Detailed information about one or more subnets within a subnet group.

    *)
  4. subnet_group_status : string_ option;
    (*

    Provides the status of the subnet group.

    *)
  5. vpc_id : string_ option;
    (*

    Provides the virtual private cloud (VPC) ID of the subnet group.

    *)
  6. db_subnet_group_description : string_ option;
    (*

    Provides the description of the subnet group.

    *)
  7. db_subnet_group_name : string_ option;
    (*

    The name of the subnet group.

    *)
}

Detailed information about a subnet group.

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 Amazon 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. These log types are in the process of being activated or deactivated.

type nonrec pending_modified_values = {
  1. pending_cloudwatch_logs_exports : pending_cloudwatch_logs_exports option;
    (*

    A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

    *)
  2. db_subnet_group_name : string_ option;
    (*

    The new subnet group for the instance.

    *)
  3. ca_certificate_identifier : string_ option;
    (*

    Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

    *)
  4. storage_type : string_ option;
    (*

    Specifies the storage type to be associated with the instance.

    *)
  5. db_instance_identifier : string_ option;
    (*

    Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

    *)
  6. iops : integer_optional option;
    (*

    Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

    *)
  7. license_model : string_ option;
    (*

    The license model for the instance.

    Valid values: license-included, bring-your-own-license, general-public-license

    *)
  8. engine_version : string_ option;
    (*

    Indicates the database engine version.

    *)
  9. multi_a_z : boolean_optional option;
    (*

    Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

    *)
  10. backup_retention_period : integer_optional option;
    (*

    Specifies the pending number of days for which automated backups are retained.

    *)
  11. port : integer_optional option;
    (*

    Specifies the pending port for the instance.

    *)
  12. master_user_password : string_ option;
    (*

    Contains the pending or currently in-progress change of the master credentials for the instance.

    *)
  13. allocated_storage : integer_optional option;
    (*

    Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

    *)
  14. db_instance_class : string_ option;
    (*

    Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

    *)
}

One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.

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 is not in an error state, this value is blank.

    *)
  2. status : string_ option;
    (*

    Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

    *)
  3. normal : boolean_ option;
    (*

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

    *)
  4. status_type : string_ option;
    (*

    This value is currently "read replication."

    *)
}

Provides a list of status information for an instance.

type nonrec db_instance_status_info_list = db_instance_status_info list
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.

    *)
}

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

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

type nonrec db_instance = {
  1. performance_insights_kms_key_id : string_ option;
    (*

    The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    *)
  2. performance_insights_enabled : boolean_optional option;
    (*

    Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

    *)
  3. certificate_details : certificate_details option;
    (*

    The details of the DB instance's server certificate.

    *)
  4. enabled_cloudwatch_logs_exports : log_type_list option;
    (*

    A list of log types that this instance is configured to export to CloudWatch Logs.

    *)
  5. db_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the instance.

    *)
  6. promotion_tier : integer_optional option;
    (*

    A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

    *)
  7. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  8. ca_certificate_identifier : string_ option;
    (*

    The identifier of the CA certificate for this DB instance.

    *)
  9. dbi_resource_id : string_ option;
    (*

    The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

    *)
  10. kms_key_id : string_ option;
    (*

    If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

    *)
  11. storage_encrypted : boolean_ option;
    (*

    Specifies whether or not the instance is encrypted.

    *)
  12. db_cluster_identifier : string_ option;
    (*

    Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

    *)
  13. status_infos : db_instance_status_info_list option;
    (*

    The status of a read replica. If the instance is not a read replica, this is blank.

    *)
  14. publicly_accessible : boolean_ option;
    (*

    Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

    *)
  15. auto_minor_version_upgrade : boolean_ option;
    (*

    Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    *)
  16. engine_version : string_ option;
    (*

    Indicates the database engine version.

    *)
  17. latest_restorable_time : t_stamp option;
    (*

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

    *)
  18. pending_modified_values : pending_modified_values option;
    (*

    Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

    *)
  19. preferred_maintenance_window : string_ option;
    (*

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

    *)
  20. db_subnet_group : db_subnet_group option;
    (*

    Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

    *)
  21. availability_zone : string_ option;
    (*

    Specifies the name of the Availability Zone that the instance is located in.

    *)
  22. vpc_security_groups : vpc_security_group_membership_list option;
    (*

    Provides a list of VPC security group elements that the instance belongs to.

    *)
  23. backup_retention_period : integer option;
    (*

    Specifies the number of days for which automatic snapshots are retained.

    *)
  24. preferred_backup_window : string_ option;
    (*

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

    *)
  25. instance_create_time : t_stamp option;
    (*

    Provides the date and time that the instance was created.

    *)
  26. endpoint : endpoint option;
    (*

    Specifies the connection endpoint.

    *)
  27. db_instance_status : string_ option;
    (*

    Specifies the current state of this database.

    *)
  28. engine : string_ option;
    (*

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

    *)
  29. db_instance_class : string_ option;
    (*

    Contains the name of the compute and memory capacity class of the instance.

    *)
  30. db_instance_identifier : string_ option;
    (*

    Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

    *)
}

Detailed information about an instance.

type nonrec reboot_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec reboot_db_instance_message = {
  1. force_failover : boolean_optional option;
    (*

    When true, the reboot is conducted through a Multi-AZ failover.

    Constraint: You can't specify true if the instance is not configured for Multi-AZ.

    *)
  2. db_instance_identifier : string_;
    (*

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.
    *)
}

Represents the input to RebootDBInstance.

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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. pending_maintenance_actions : pending_maintenance_actions option;
    (*

    The maintenance actions to be applied.

    *)
}

Represents the output of DescribePendingMaintenanceActions.

type nonrec availability_zone_list = availability_zone list
type nonrec orderable_db_instance_option = {
  1. storage_type : string_ option;
    (*

    The storage type to associate with the DB cluster

    *)
  2. vpc : boolean_ option;
    (*

    Indicates whether an instance is in a virtual private cloud (VPC).

    *)
  3. availability_zones : availability_zone_list option;
    (*

    A list of Availability Zones for an instance.

    *)
  4. license_model : string_ option;
    (*

    The license model for an instance.

    *)
  5. db_instance_class : string_ option;
    (*

    The instance class for an instance.

    *)
  6. engine_version : string_ option;
    (*

    The engine version of an instance.

    *)
  7. engine : string_ option;
    (*

    The engine type of an instance.

    *)
}

The options that are available for an instance.

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 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;
    (*

    The options that are available for a particular orderable instance.

    *)
}

Represents the output of DescribeOrderableDBInstanceOptions.

type nonrec modify_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec modify_global_cluster_message = {
  1. deletion_protection : boolean_optional option;
    (*

    Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

    *)
  2. new_global_cluster_identifier : global_cluster_identifier option;
    (*

    The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

    • 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

    *)
  3. global_cluster_identifier : global_cluster_identifier;
    (*

    The identifier for the global cluster being modified. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing global cluster.
    *)
}

Represents the input to ModifyGlobalCluster.

type nonrec modify_event_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec modify_event_subscription_message = {
  1. enabled : boolean_optional option;
    (*

    A Boolean value; set to true to activate the subscription.

    *)
  2. event_categories : event_categories_list option;
    (*

    A list of event categories for a SourceType that you want to subscribe to.

    *)
  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 an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

    Valid values: db-instance, db-parameter-group, db-security-group

    *)
  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 Amazon DocumentDB event notification subscription.

    *)
}

Represents the input to ModifyEventSubscription.

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 Amazon EC2 subnet IDs for the subnet group.

    *)
  2. db_subnet_group_description : string_ option;
    (*

    The description for the subnet group.

    *)
  3. db_subnet_group_name : string_;
    (*

    The name for the 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: mySubnetgroup

    *)
}

Represents the input to ModifyDBSubnetGroup.

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

The request would cause you to exceed the allowed number of subnets in a subnet group.

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

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

type nonrec modify_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec modify_db_instance_message = {
  1. 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, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

    *)
  2. performance_insights_kms_key_id : string_ option;
    (*

    The KMS key identifier for encryption of Performance Insights data.

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

    *)
  3. enable_performance_insights : boolean_optional option;
    (*

    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

    *)
  4. promotion_tier : integer_optional option;
    (*

    A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

    Default: 1

    Valid values: 0-15

    *)
  5. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  6. ca_certificate_identifier : string_ option;
    (*

    Indicates the certificate that needs to be associated with the instance.

    *)
  7. new_db_instance_identifier : string_ option;
    (*

    The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    *)
  8. auto_minor_version_upgrade : boolean_optional option;
    (*

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    *)
  9. preferred_maintenance_window : string_ option;
    (*

    The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

    Default: Uses existing setting.

    Format: ddd:hh24:mi-ddd:hh24:mi

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Must be at least 30 minutes.

    *)
  10. 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 instance.

    If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

    Default: false

    *)
  11. db_instance_class : string_ option;
    (*

    The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

    If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

    Default: Uses existing setting.

    *)
  12. db_instance_identifier : string_;
    (*

    The instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.
    *)
}

Represents the input to ModifyDBInstance.

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

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

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

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

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

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

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

DBSecurityGroupName doesn't refer to an existing security group.

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

You already have a 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 authorization_not_found_fault = {
  1. message : exception_message option;
}

The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

type nonrec attribute_value_list = string_ list
type nonrec db_cluster_snapshot_attribute = {
  1. attribute_values : attribute_value_list option;
    (*

    The values for the manual 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 cluster snapshot. If a value of all is in the list, then the manual 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 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 cluster snapshot.

    *)
}

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

Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.

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

    *)
  2. db_cluster_snapshot_identifier : string_ option;
    (*

    The identifier of the cluster snapshot that the attributes apply to.

    *)
}

Detailed information about the attributes that are associated with a cluster snapshot.

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 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 cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . 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 cluster snapshot.

    *)
  2. values_to_add : attribute_value_list option;
    (*

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

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

    *)
  3. attribute_name : string_;
    (*

    The name of the cluster snapshot attribute to modify.

    To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

    *)
  4. db_cluster_snapshot_identifier : string_;
    (*

    The identifier for the cluster snapshot to modify the attributes for.

    *)
}

Represents the input to ModifyDBClusterSnapshotAttribute.

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 cluster parameter group to modify.

    *)
  2. db_cluster_parameter_group_name : string_;
    (*

    The name of the cluster parameter group to modify.

    *)
}

Represents the input to ModifyDBClusterParameterGroup.

type nonrec cloudwatch_logs_export_configuration = {
  1. disable_log_types : log_type_list option;
    (*

    The list of log types to disable.

    *)
  2. enable_log_types : log_type_list option;
    (*

    The list of log types to enable.

    *)
}

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

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

type nonrec modify_db_cluster_message = {
  1. network_type : string_ option;
    (*

    The network type of the cluster.

    The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.

    Valid Values: IPV4 | DUAL

    *)
  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 Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.

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

    *)
  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 both of the following conditions are met:

    • The cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the 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 enabling 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.

    *)
  4. manage_master_user_password : boolean_optional option;
    (*

    Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the 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 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, Amazon DocumentDB deletes the secret and uses the new password for the master user specified by MasterUserPassword.

    *)
  5. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
    (*

    Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

    *)
  6. storage_type : string_ option;
    (*

    The storage type to associate with the DB cluster.

    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

    Valid values for storage type - standard | iopt1

    Default value is standard

    *)
  7. deletion_protection : boolean_optional option;
    (*

    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    *)
  8. allow_major_version_upgrade : boolean_ option;
    (*

    A value that indicates whether major version upgrades are allowed.

    Constraints:

    • You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the cluster's current version.
    • Since some parameters are version specific, changing them requires executing a new ModifyDBCluster API call after the in-place MVU completes.

    Performing an MVU directly impacts the following parameters:

    • MasterUserPassword
    • NewDBClusterIdentifier
    • VpcSecurityGroupIds
    • Port
    *)
  9. 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.

    To list all of the available engine versions for Amazon DocumentDB use the following command:

    aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

    *)
  10. cloudwatch_logs_export_configuration : cloudwatch_logs_export_configuration option;
    (*

    The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

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

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

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

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

    The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

    Constraints: Must contain from 8 to 100 characters.

    *)
  14. port : integer_optional option;
    (*

    The port number on which the cluster accepts connections.

    Constraints: Must be a value from 1150 to 65535.

    Default: The same port as the original cluster.

    *)
  15. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    A list of virtual private cloud (VPC) security groups that the cluster will belong to.

    *)
  16. db_cluster_parameter_group_name : string_ option;
    (*

    The name of the cluster parameter group to use for the cluster.

    *)
  17. backup_retention_period : integer_optional option;
    (*

    The number of days for which automated backups are retained. You must specify a minimum value of 1.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35.
    *)
  18. apply_immediately : boolean_ option;
    (*

    A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

    The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

    Default: false

    *)
  19. new_db_cluster_identifier : string_ option;
    (*

    The new cluster identifier for the cluster when renaming a 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.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster2

    *)
  20. db_cluster_identifier : string_;
    (*

    The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.
    *)
}

Represents the input to ModifyDBCluster.

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

The subnet group can't be deleted because it's in use.

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

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

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 named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

type nonrec filter_list = filter list
type nonrec list_tags_for_resource_message = {
  1. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  2. resource_name : string_;
    (*

    The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

    *)
}

Represents the input to ListTagsForResource.

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

Someone else might be modifying a subscription. Wait a few seconds, and try again.

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

The subnet isn't in the available state.

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

The request would cause you to exceed the allowed number of instances.

type nonrec global_cluster_list = global_cluster list
type nonrec global_clusters_message = {
  1. global_clusters : global_cluster_list option;
  2. marker : string_ option;
}
type nonrec global_cluster_quota_exceeded_fault = {
  1. message : exception_message option;
}

The number of global clusters for this account is already at the maximum allowed.

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

The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.

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 cluster operation. Allowing data loss triggers a global failover operation.

    If you don't specify AllowDataLoss, the global 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 Amazon DocumentDB cluster that you want to promote to the primary for the global cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.

    Constraints:

    • Must match the identifier of an existing secondary cluster.
    • Minimum length of 1. Maximum length of 255.

    Pattern: [A-Za-z][0-9A-Za-z-:._]*

    *)
  4. global_cluster_identifier : global_cluster_identifier;
    (*

    The identifier of the Amazon DocumentDB global cluster to apply this operation. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster.

    Constraints:

    • Must match the identifier of an existing global cluster.
    • Minimum length of 1. Maximum length of 255.

    Pattern: [A-Za-z][0-9A-Za-z-:._]*

    *)
}
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 instance to promote to the primary instance.

    You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

    *)
  2. db_cluster_identifier : string_ option;
    (*

    A cluster identifier to force a failover for. This parameter is not case sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.
    *)
}

Represents the input to FailoverDBCluster.

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.

    *)
}

Detailed information about an event.

type nonrec event_list = event list
type nonrec events_message = {
  1. events : event_list option;
    (*

    Detailed information about one or more events.

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

    *)
}

Represents the output of DescribeEvents.

type nonrec event_subscriptions_list = event_subscription list
type nonrec event_subscriptions_message = {
  1. event_subscriptions_list : event_subscriptions_list option;
    (*

    A list of event subscriptions.

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

    *)
}

Represents the output of DescribeEventSubscriptions.

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.

    *)
}

An event source type, accompanied by one or more event category names.

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 event category maps.

    *)
}

Represents the output of DescribeEventCategories.

type nonrec engine_defaults = {
  1. parameters : parameters_list option;
    (*

    The parameters of a particular cluster parameter group family.

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

    The name of the cluster parameter group family to return the engine parameter information for.

    *)
}

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

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 (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;
    (*

    A filter that specifies one or more resources to return pending maintenance actions for.

    Supported filters:

    • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
    • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only 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.

    *)
}

Represents the input to DescribePendingMaintenanceActions.

type nonrec describe_orderable_db_instance_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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. vpc : boolean_optional option;
    (*

    The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

    *)
  5. license_model : string_ option;
    (*

    The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

    *)
  6. db_instance_class : string_ option;
    (*

    The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

    *)
  7. engine_version : string_ option;
    (*

    The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

    *)
  8. engine : string_;
    (*

    The name of the engine to retrieve instance options for.

    *)
}

Represents the input to DescribeOrderableDBInstanceOptions.

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.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more global DB clusters to describe.

    Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

    *)
  4. global_cluster_identifier : global_cluster_identifier option;
    (*

    The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

    *)
}
type nonrec describe_events_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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. event_categories : event_categories_list option;
    (*

    A list of event categories that trigger notifications for an 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.

    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.

    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 provided, SourceType must also be provided.
    • If the source type is DBInstance, a DBInstanceIdentifier must be provided.
    • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.
    • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.
    • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.
    • Cannot end with a hyphen or contain two consecutive hyphens.
    *)
}

Represents the input to DescribeEvents.

type nonrec describe_event_subscriptions_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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. subscription_name : string_ option;
    (*

    The name of the Amazon DocumentDB event notification subscription that you want to describe.

    *)
}

Represents the input to DescribeEventSubscriptions.

type nonrec describe_event_categories_message = {
  1. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  2. source_type : string_ option;
    (*

    The type of source that is generating the events.

    Valid values: db-instance, db-parameter-group, db-security-group

    *)
}

Represents the input to DescribeEventCategories.

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 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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_parameter_group_family : string_;
    (*

    The name of the cluster parameter group family to return the engine parameter information for.

    *)
}

Represents the input to DescribeEngineDefaultClusterParameters.

type nonrec describe_db_subnet_groups_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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_subnet_group_name : string_ option;
    (*

    The name of the subnet group to return details for.

    *)
}

Represents the input to DescribeDBSubnetGroups.

type nonrec db_subnet_groups = db_subnet_group list
type nonrec db_subnet_group_message = {
  1. db_subnet_groups : db_subnet_groups option;
    (*

    Detailed information about one or more subnet groups.

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

    *)
}

Represents the output of DescribeDBSubnetGroups.

type nonrec describe_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 records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more instances to describe.

    Supported filters:

    • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
    • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
    *)
  4. db_instance_identifier : string_ option;
    (*

    The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

    Constraints:

    • If provided, must match the identifier of an existing DBInstance.
    *)
}

Represents the input to DescribeDBInstances.

type nonrec db_instance_list = db_instance list
type nonrec db_instance_message = {
  1. db_instances : db_instance_list option;
    (*

    Detailed information about one or more 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.

    *)
}

Represents the output of DescribeDBInstances.

type nonrec describe_db_engine_versions_message = {
  1. list_supported_timezones : boolean_optional option;
    (*

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

    *)
  2. list_supported_character_sets : boolean_optional option;
    (*

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

    *)
  3. default_only : boolean_ option;
    (*

    Indicates that only the default version of the specified engine or engine and major version combination is returned.

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

    *)
  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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  6. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  7. db_parameter_group_family : string_ option;
    (*

    The name of a specific parameter group family to return details for.

    Constraints:

    • If provided, must match an existing DBParameterGroupFamily.
    *)
  8. engine_version : string_ option;
    (*

    The database engine version to return.

    Example: 3.6.0

    *)
  9. engine : string_ option;
    (*

    The database engine to return.

    *)
}

Represents the input to DescribeDBEngineVersions.

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 Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions. You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster. You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.

    *)
  2. supports_certificate_rotation_without_restart : boolean_optional option;
    (*

    Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

    *)
  3. supported_ca_certificate_identifiers : ca_certificate_identifiers_list option;
    (*

    A list of the supported CA certificate identifiers.

    For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

    *)
  4. supports_log_exports_to_cloudwatch_logs : boolean_ option;
    (*

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

    *)
  5. exportable_log_types : log_type_list option;
    (*

    The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

    *)
  6. valid_upgrade_target : valid_upgrade_target_list option;
    (*

    A list of engine versions that this database engine version can be upgraded to.

    *)
  7. db_engine_version_description : string_ option;
    (*

    The description of the database engine version.

    *)
  8. db_engine_description : string_ option;
    (*

    The description of the database engine.

    *)
  9. db_parameter_group_family : string_ option;
    (*

    The name of the parameter group family for the database engine.

    *)
  10. engine_version : string_ option;
    (*

    The version number of the database engine.

    *)
  11. engine : string_ option;
    (*

    The name of the database engine.

    *)
}

Detailed information about an engine version.

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;
    (*

    Detailed information about one or more engine versions.

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

    *)
}

Represents the output of DescribeDBEngineVersions.

type nonrec describe_db_clusters_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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    A filter that specifies one or more clusters to describe.

    Supported filters:

    • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.
    *)
  4. db_cluster_identifier : string_ option;
    (*

    The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

    Constraints:

    • If provided, must match an existing DBClusterIdentifier.
    *)
}

Represents the input to DescribeDBClusters.

type nonrec db_cluster_list = db_cluster list
type nonrec db_cluster_message = {
  1. db_clusters : db_cluster_list option;
    (*

    A list of clusters.

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

    *)
}

Represents the output of DescribeDBClusters.

type nonrec describe_db_cluster_snapshots_message = {
  1. include_public : boolean_ option;
    (*

    Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

    *)
  2. include_shared : boolean_ option;
    (*

    Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

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

    *)
  4. 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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  5. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  6. snapshot_type : string_ option;
    (*

    The type of cluster snapshots to be returned. You can specify one of the following values:

    • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
    • public - Return all cluster snapshots that have been marked as public.

    If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

    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.

    *)
  7. db_cluster_snapshot_identifier : string_ option;
    (*

    A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

    Constraints:

    • If provided, must match the identifier of an existing DBClusterSnapshot.
    • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
    *)
  8. db_cluster_identifier : string_ option;
    (*

    The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

    Constraints:

    • If provided, must match the identifier of an existing DBCluster.
    *)
}

Represents the input to DescribeDBClusterSnapshots.

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

    Storage type associated with your cluster snapshot

    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

    Valid values for storage type - standard | iopt1

    Default value is standard

    *)
  2. source_db_cluster_snapshot_arn : string_ option;
    (*

    If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

    *)
  3. db_cluster_snapshot_arn : string_ option;
    (*

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

    *)
  4. kms_key_id : string_ option;
    (*

    If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

    *)
  5. storage_encrypted : boolean_ option;
    (*

    Specifies whether the cluster snapshot is encrypted.

    *)
  6. percent_progress : integer option;
    (*

    Specifies the percentage of the estimated data that has been transferred.

    *)
  7. snapshot_type : string_ option;
    (*

    Provides the type of the cluster snapshot.

    *)
  8. engine_version : string_ option;
    (*

    Provides the version of the database engine for this cluster snapshot.

    *)
  9. master_username : string_ option;
    (*

    Provides the master user name for the cluster snapshot.

    *)
  10. cluster_create_time : t_stamp option;
    (*

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

    *)
  11. vpc_id : string_ option;
    (*

    Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

    *)
  12. port : integer option;
    (*

    Specifies the port that the cluster was listening on at the time of the snapshot.

    *)
  13. status : string_ option;
    (*

    Specifies the status of this cluster snapshot.

    *)
  14. engine : string_ option;
    (*

    Specifies the name of the database engine.

    *)
  15. snapshot_create_time : t_stamp option;
    (*

    Provides the time when the snapshot was taken, in UTC.

    *)
  16. db_cluster_identifier : string_ option;
    (*

    Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

    *)
  17. db_cluster_snapshot_identifier : string_ option;
    (*

    Specifies the identifier for the cluster snapshot.

    *)
  18. availability_zones : availability_zones option;
    (*

    Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

    *)
}

Detailed information about a cluster snapshot.

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

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

    *)
}

Represents the output of DescribeDBClusterSnapshots.

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 cluster snapshot to describe the attributes for.

    *)
}

Represents the input to DescribeDBClusterSnapshotAttributes.

type nonrec describe_db_cluster_parameters_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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. source : string_ option;
    (*

    A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

    *)
  5. db_cluster_parameter_group_name : string_;
    (*

    The name of a specific cluster parameter group to return parameter details for.

    Constraints:

    • If provided, must match the name of an existing DBClusterParameterGroup.
    *)
}

Represents the input to DescribeDBClusterParameters.

type nonrec db_cluster_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;
    (*

    Provides a list of parameters for the cluster parameter group.

    *)
}

Represents the output of DBClusterParameterGroup.

type nonrec describe_db_cluster_parameter_groups_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 (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_cluster_parameter_group_name : string_ option;
    (*

    The name of a specific cluster parameter group to return details for.

    Constraints:

    • If provided, must match the name of an existing DBClusterParameterGroup.
    *)
}

Represents the input to DescribeDBClusterParameterGroups.

type nonrec db_cluster_parameter_group = {
  1. db_cluster_parameter_group_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the cluster parameter group.

    *)
  2. description : string_ option;
    (*

    Provides the customer-specified description for this cluster parameter group.

    *)
  3. db_parameter_group_family : string_ option;
    (*

    Provides the name of the parameter group family that this cluster parameter group is compatible with.

    *)
  4. db_cluster_parameter_group_name : string_ option;
    (*

    Provides the name of the cluster parameter group.

    *)
}

Detailed information about a cluster parameter group.

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 cluster parameter groups.

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

    *)
}

Represents the output of DBClusterParameterGroups.

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 that the remaining results can be retrieved.

    Default: 100

    Constraints:

    • Minimum: 20
    • Maximum: 100
    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. certificate_identifier : string_ option;
    (*

    The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

    Constraints

    • Must match an existing CertificateIdentifier.
    *)
}
type nonrec certificate = {
  1. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the certificate.

    Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

    *)
  2. valid_till : t_stamp option;
    (*

    The date-time after which the certificate is no longer valid.

    Example: 2024-07-31T17:57:09Z

    *)
  3. valid_from : t_stamp option;
    (*

    The starting date-time from which the certificate is valid.

    Example: 2019-07-31T17:57:09Z

    *)
  4. thumbprint : string_ option;
    (*

    The thumbprint of the certificate.

    *)
  5. certificate_type : string_ option;
    (*

    The type of the certificate.

    Example: CA

    *)
  6. certificate_identifier : string_ option;
    (*

    The unique key that identifies a certificate.

    Example: rds-ca-2019

    *)
}

A certificate authority (CA) certificate for an Amazon Web Services account.

type nonrec certificate_list = certificate list
type nonrec certificate_message = {
  1. marker : string_ option;
    (*

    An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

    *)
  2. certificates : certificate_list option;
    (*

    A list of certificates for this Amazon Web Services account.

    *)
}
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 cluster being deleted.

    *)
}

Represents the input to DeleteGlobalCluster.

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 Amazon DocumentDB event notification subscription that you want to delete.

    *)
}

Represents the input to DeleteEventSubscription.

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: mySubnetgroup

    *)
}

Represents the input to DeleteDBSubnetGroup.

type nonrec delete_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec delete_db_instance_message = {
  1. db_instance_identifier : string_;
    (*

    The instance identifier for the instance to be deleted. This parameter isn't case sensitive.

    Constraints:

    • Must match the name of an existing instance.
    *)
}

Represents the input to DeleteDBInstance.

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

DBSnapshotIdentifier is already being used by an existing snapshot.

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 cluster snapshot to delete.

    Constraints: Must be the name of an existing cluster snapshot in the available state.

    *)
}

Represents the input to DeleteDBClusterSnapshot.

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 cluster parameter group.

    Constraints:

    • Must be the name of an existing cluster parameter group.
    • You can't delete a default cluster parameter group.
    • Cannot be associated with any clusters.
    *)
}

Represents the input to DeleteDBClusterParameterGroup.

type nonrec delete_db_cluster_message = {
  1. final_db_snapshot_identifier : string_ option;
    (*

    The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

    Constraints:

    • Must be from 1 to 255 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.
    *)
  2. skip_final_snapshot : boolean_ option;
    (*

    Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

    If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

    Default: false

    *)
  3. db_cluster_identifier : string_;
    (*

    The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

    Constraints:

    • Must match an existing DBClusterIdentifier.
    *)
}

Represents the input to DeleteDBCluster.

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

You already have a cluster snapshot with the given identifier.

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

The request would cause you to exceed the allowed number of subnet groups.

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

DBSubnetGroupName is already being used by an existing subnet group.

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

This request would cause you to exceed the allowed number of parameter groups.

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

A parameter group with the same name already exists.

type nonrec create_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec create_global_cluster_message = {
  1. storage_encrypted : boolean_optional option;
    (*

    The storage encryption setting for the new global cluster.

    *)
  2. database_name : string_ option;
    (*

    The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

    *)
  3. deletion_protection : boolean_optional option;
    (*

    The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.

    *)
  4. engine_version : string_ option;
    (*

    The engine version of the global cluster.

    *)
  5. engine : string_ option;
    (*

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

    *)
  6. source_db_cluster_identifier : string_ option;
    (*

    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

    *)
  7. global_cluster_identifier : global_cluster_identifier;
    (*

    The cluster identifier of the new global cluster.

    *)
}

Represents the input to CreateGlobalCluster.

type nonrec create_event_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec create_event_subscription_message = {
  1. tags : tag_list option;
    (*

    The tags to be assigned to the event subscription.

    *)
  2. enabled : boolean_optional option;
    (*

    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

    *)
  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 provided, SourceType must also be provided.
    • If the source type is an instance, a DBInstanceIdentifier must be provided.
    • If the source type is a security group, a DBSecurityGroupName must be provided.
    • If the source type is a parameter group, a DBParameterGroupName must be provided.
    • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
    *)
  4. event_categories : event_categories_list option;
    (*

    A list of event categories for a SourceType that you want to subscribe to.

    *)
  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 an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

    Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

    *)
  6. sns_topic_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

    *)
  7. subscription_name : string_;
    (*

    The name of the subscription.

    Constraints: The name must be fewer than 255 characters.

    *)
}

Represents the input to CreateEventSubscription.

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;
    (*

    The tags to be assigned to the subnet group.

    *)
  2. subnet_ids : subnet_identifier_list;
    (*

    The Amazon EC2 subnet IDs for the subnet group.

    *)
  3. db_subnet_group_description : string_;
    (*

    The description for the subnet group.

    *)
  4. db_subnet_group_name : string_;
    (*

    The name for the 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.

    Example: mySubnetgroup

    *)
}

Represents the input to CreateDBSubnetGroup.

type nonrec create_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec create_db_instance_message = {
  1. ca_certificate_identifier : string_ option;
    (*

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

    For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

    *)
  2. performance_insights_kms_key_id : string_ option;
    (*

    The KMS key identifier for encryption of Performance Insights data.

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

    *)
  3. enable_performance_insights : boolean_optional option;
    (*

    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

    *)
  4. promotion_tier : integer_optional option;
    (*

    A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

    Default: 1

    Valid values: 0-15

    *)
  5. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  6. db_cluster_identifier : string_;
    (*

    The identifier of the cluster that the instance will belong to.

    *)
  7. tags : tag_list option;
    (*

    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

    *)
  8. auto_minor_version_upgrade : boolean_optional option;
    (*

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    Default: false

    *)
  9. preferred_maintenance_window : string_ option;
    (*

    The time range each week 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.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    *)
  10. availability_zone : string_ option;
    (*

    The Amazon EC2 Availability Zone that the instance is created in.

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

    Example: us-east-1d

    *)
  11. engine : string_;
    (*

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

    Valid value: docdb

    *)
  12. db_instance_class : string_;
    (*

    The compute and memory capacity of the instance; for example, db.r5.large.

    *)
  13. db_instance_identifier : string_;
    (*

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    *)
}

Represents the input to CreateDBInstance.

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

    *)
  2. db_cluster_identifier : string_;
    (*

    The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    Example: my-cluster

    *)
  3. db_cluster_snapshot_identifier : string_;
    (*

    The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster-snapshot1

    *)
}

Represents the input of CreateDBClusterSnapshot.

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;
    (*

    The tags to be assigned to the cluster parameter group.

    *)
  2. description : string_;
    (*

    The description for the cluster parameter group.

    *)
  3. db_parameter_group_family : string_;
    (*

    The cluster parameter group family name.

    *)
  4. db_cluster_parameter_group_name : string_;
    (*

    The name of the cluster parameter group.

    Constraints:

    • Must not match the name of an existing DBClusterParameterGroup.

    This value is stored as a lowercase string.

    *)
}

Represents the input of CreateDBClusterParameterGroup.

type nonrec create_db_cluster_message = {
  1. network_type : string_ option;
    (*

    The network type of the cluster.

    The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.

    Valid Values: IPV4 | DUAL

    *)
  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 Amazon DocumentDB 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.

    *)
  3. manage_master_user_password : boolean_optional option;
    (*

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

    Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

    *)
  4. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
    (*

    Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

    *)
  5. storage_type : string_ option;
    (*

    The storage type to associate with the DB cluster.

    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

    Valid values for storage type - standard | iopt1

    Default value is standard

    When you create an Amazon DocumentDB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

    *)
  6. global_cluster_identifier : global_cluster_identifier option;
    (*

    The cluster identifier of the new global cluster.

    *)
  7. deletion_protection : boolean_optional option;
    (*

    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    *)
  8. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

    *)
  9. pre_signed_url : string_ option;
    (*

    Not currently supported.

    *)
  10. kms_key_id : string_ option;
    (*

    The KMS key identifier for an encrypted cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If an encryption key is not specified in KmsKeyId:

    • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

    *)
  11. storage_encrypted : boolean_optional option;
    (*

    Specifies whether the cluster is encrypted.

    *)
  12. tags : tag_list option;
    (*

    The tags to be assigned to the cluster.

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

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

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

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

    The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

    Constraints: Must contain from 8 to 100 characters.

    *)
  16. master_username : string_ option;
    (*

    The name of the master user for the cluster.

    Constraints:

    • Must be from 1 to 63 letters or numbers.
    • The first character must be a letter.
    • Cannot be a reserved word for the chosen database engine.
    *)
  17. port : integer_optional option;
    (*

    The port number on which the instances in the cluster accept connections.

    *)
  18. engine_version : string_ option;
    (*

    The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

    *)
  19. engine : string_;
    (*

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

    Valid values: docdb

    *)
  20. db_subnet_group_name : string_ option;
    (*

    A subnet group to associate with this cluster.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    *)
  21. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    *)
  22. db_cluster_parameter_group_name : string_ option;
    (*

    The name of the cluster parameter group to associate with this cluster.

    *)
  23. db_cluster_identifier : string_;
    (*

    The cluster identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster

    *)
  24. backup_retention_period : integer_optional option;
    (*

    The number of days for which automated backups are retained. You must specify a minimum value of 1.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35.
    *)
  25. availability_zones : availability_zones option;
    (*

    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

    *)
}

Represents the input to CreateDBCluster.

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;
    (*

    The tags to be assigned to the cluster snapshot.

    *)
  2. copy_tags : boolean_optional option;
    (*

    Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

    *)
  3. pre_signed_url : string_ option;
    (*

    The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.

    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 pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

    The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

    • SourceRegion - The ID of the region that contains the snapshot to be copied.
    • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted 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 cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
    • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.
    *)
  4. kms_key_id : string_ option;
    (*

    The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

    If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

    To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.

    If you copy an unencrypted 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 cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster-snapshot2

    *)
  6. source_db_cluster_snapshot_identifier : string_;
    (*

    The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

    Constraints:

    • Must specify a valid cluster snapshot in the available state.
    • If the source cluster snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.
    • If the source cluster snapshot is in a different Amazon Web Services Region or owned by another Amazon Web Services account, specify the snapshot ARN.

    Example: my-cluster-snapshot1

    *)
}

Represents the input to CopyDBClusterSnapshot.

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;
    (*

    The tags that are to be assigned to the parameter group.

    *)
  2. target_db_cluster_parameter_group_description : string_;
    (*

    A description for the copied cluster parameter group.

    *)
  3. target_db_cluster_parameter_group_identifier : string_;
    (*

    The identifier for the copied cluster parameter group.

    Constraints:

    • Cannot be null, empty, or blank.
    • Must contain from 1 to 255 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot 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 cluster parameter group.

    Constraints:

    • Must specify a valid cluster parameter group.
    • If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
    • If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
    *)
}

Represents the input to CopyDBClusterParameterGroup.

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: system-update, db-upgrade

    *)
  3. resource_identifier : string_;
    (*

    The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

    *)
}

Represents the input to ApplyPendingMaintenanceAction.

type nonrec add_tags_to_resource_message = {
  1. tags : tag_list;
    (*

    The tags to be assigned to the Amazon DocumentDB resource.

    *)
  2. resource_name : string_;
    (*

    The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

    *)
}

Represents the input to AddTagsToResource.

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:

    • If the source type is an instance, a DBInstanceIdentifier must be provided.
    • If the source type is a security group, a DBSecurityGroupName must be provided.
    • If the source type is a parameter group, a DBParameterGroupName must be provided.
    • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
    *)
  2. subscription_name : string_;
    (*

    The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

    *)
}

Represents the input to AddSourceIdentifierToSubscription.