Module Smaws_Client_DocDB

DocDB client library built on EIO.

Types

module Types : sig ... end

Builders

val make_vpc_security_group_membership : ?status:Types.string_ -> ?vpc_security_group_id:Types.string_ -> unit -> Types.vpc_security_group_membership
val make_upgrade_target : ?is_major_version_upgrade:Types.boolean_ -> ?auto_upgrade:Types.boolean_ -> ?description:Types.string_ -> ?engine_version:Types.string_ -> ?engine:Types.string_ -> unit -> Types.upgrade_target
val make_tag : ?value:Types.string_ -> ?key:Types.string_ -> unit -> Types.tag
val make_tag_list_message : ?tag_list:Types.tag_list -> unit -> Types.tag_list_message
val make_global_cluster_member : ?synchronization_status:Types.global_cluster_member_synchronization_status -> ?is_writer:Types.boolean_ -> ?readers:Types.readers_arn_list -> ?db_cluster_arn:Types.string_ -> unit -> Types.global_cluster_member
val make_failover_state : ?is_data_loss_allowed:Types.boolean_ -> ?to_db_cluster_arn:Types.string_ -> ?from_db_cluster_arn:Types.string_ -> ?status:Types.failover_status -> unit -> Types.failover_state
val make_global_cluster : ?tag_list:Types.tag_list -> ?failover_state:Types.failover_state -> ?global_cluster_members:Types.global_cluster_member_list -> ?deletion_protection:Types.boolean_optional -> ?storage_encrypted:Types.boolean_optional -> ?database_name:Types.string_ -> ?engine_version:Types.string_ -> ?engine:Types.string_ -> ?status:Types.string_ -> ?global_cluster_arn:Types.string_ -> ?global_cluster_resource_id:Types.string_ -> ?global_cluster_identifier:Types.global_cluster_identifier -> unit -> Types.global_cluster
val make_switchover_global_cluster_message : target_db_cluster_identifier:Types.db_cluster_identifier -> global_cluster_identifier:Types.global_cluster_identifier -> unit -> Types.switchover_global_cluster_message
val make_availability_zone : ?name:Types.string_ -> unit -> Types.availability_zone
val make_subnet : ?subnet_status:Types.string_ -> ?subnet_availability_zone:Types.availability_zone -> ?subnet_identifier:Types.string_ -> unit -> Types.subnet
val make_db_cluster_member : ?promotion_tier:Types.integer_optional -> ?db_cluster_parameter_group_status:Types.string_ -> ?is_cluster_writer:Types.boolean_ -> ?db_instance_identifier:Types.string_ -> unit -> Types.db_cluster_member
val make_db_cluster_role : ?status:Types.string_ -> ?role_arn:Types.string_ -> unit -> Types.db_cluster_role
val make_serverless_v2_scaling_configuration_info : ?max_capacity:Types.double_optional -> ?min_capacity:Types.double_optional -> unit -> Types.serverless_v2_scaling_configuration_info
val make_cluster_master_user_secret : ?kms_key_id:Types.string_ -> ?secret_status:Types.string_ -> ?secret_arn:Types.string_ -> unit -> Types.cluster_master_user_secret
val make_db_cluster : ?network_type:Types.string_ -> ?master_user_secret:Types.cluster_master_user_secret -> ?serverless_v2_scaling_configuration: Types.serverless_v2_scaling_configuration_info -> ?storage_type:Types.string_ -> ?io_optimized_next_allowed_modification_time:Types.t_stamp -> ?deletion_protection:Types.boolean_ -> ?enabled_cloudwatch_logs_exports:Types.log_type_list -> ?cluster_create_time:Types.t_stamp -> ?clone_group_id:Types.string_ -> ?associated_roles:Types.db_cluster_roles -> ?db_cluster_arn:Types.string_ -> ?db_cluster_resource_id:Types.string_ -> ?kms_key_id:Types.string_ -> ?storage_encrypted:Types.boolean_ -> ?hosted_zone_id:Types.string_ -> ?vpc_security_groups:Types.vpc_security_group_membership_list -> ?db_cluster_members:Types.db_cluster_member_list -> ?read_replica_identifiers:Types.read_replica_identifier_list -> ?replication_source_identifier:Types.string_ -> ?preferred_maintenance_window:Types.string_ -> ?preferred_backup_window:Types.string_ -> ?master_username:Types.string_ -> ?port:Types.integer_optional -> ?latest_restorable_time:Types.t_stamp -> ?engine_version:Types.string_ -> ?engine:Types.string_ -> ?multi_a_z:Types.boolean_ -> ?reader_endpoint:Types.string_ -> ?endpoint:Types.string_ -> ?earliest_restorable_time:Types.t_stamp -> ?percent_progress:Types.string_ -> ?status:Types.string_ -> ?db_subnet_group:Types.string_ -> ?db_cluster_parameter_group:Types.string_ -> ?db_cluster_identifier:Types.string_ -> ?backup_retention_period:Types.integer_optional -> ?availability_zones:Types.availability_zones -> unit -> Types.db_cluster
val make_stop_db_cluster_message : db_cluster_identifier:Types.string_ -> unit -> Types.stop_db_cluster_message
val make_start_db_cluster_message : db_cluster_identifier:Types.string_ -> unit -> Types.start_db_cluster_message
val make_serverless_v2_scaling_configuration : ?max_capacity:Types.double_optional -> ?min_capacity:Types.double_optional -> unit -> Types.serverless_v2_scaling_configuration
val make_serverless_v2_features_support : ?max_capacity:Types.double_optional -> ?min_capacity:Types.double_optional -> unit -> Types.serverless_v2_features_support
val make_restore_db_cluster_to_point_in_time_message : ?network_type:Types.string_ -> ?storage_type:Types.string_ -> ?serverless_v2_scaling_configuration: Types.serverless_v2_scaling_configuration -> ?deletion_protection:Types.boolean_optional -> ?enable_cloudwatch_logs_exports:Types.log_type_list -> ?kms_key_id:Types.string_ -> ?tags:Types.tag_list -> ?vpc_security_group_ids:Types.vpc_security_group_id_list -> ?db_subnet_group_name:Types.string_ -> ?port:Types.integer_optional -> ?use_latest_restorable_time:Types.boolean_ -> ?restore_to_time:Types.t_stamp -> ?restore_type:Types.string_ -> source_db_cluster_identifier:Types.string_ -> db_cluster_identifier:Types.string_ -> unit -> Types.restore_db_cluster_to_point_in_time_message
val make_restore_db_cluster_from_snapshot_message : ?network_type:Types.string_ -> ?storage_type:Types.string_ -> ?serverless_v2_scaling_configuration: Types.serverless_v2_scaling_configuration -> ?db_cluster_parameter_group_name:Types.string_ -> ?deletion_protection:Types.boolean_optional -> ?enable_cloudwatch_logs_exports:Types.log_type_list -> ?kms_key_id:Types.string_ -> ?tags:Types.tag_list -> ?vpc_security_group_ids:Types.vpc_security_group_id_list -> ?db_subnet_group_name:Types.string_ -> ?port:Types.integer_optional -> ?engine_version:Types.string_ -> ?availability_zones:Types.availability_zones -> engine:Types.string_ -> snapshot_identifier:Types.string_ -> db_cluster_identifier:Types.string_ -> unit -> Types.restore_db_cluster_from_snapshot_message
val make_pending_maintenance_action : ?description:Types.string_ -> ?current_apply_date:Types.t_stamp -> ?opt_in_status:Types.string_ -> ?forced_apply_date:Types.t_stamp -> ?auto_applied_after_date:Types.t_stamp -> ?action:Types.string_ -> unit -> Types.pending_maintenance_action
val make_resource_pending_maintenance_actions : ?pending_maintenance_action_details:Types.pending_maintenance_action_details -> ?resource_identifier:Types.string_ -> unit -> Types.resource_pending_maintenance_actions
val make_parameter : ?apply_method:Types.apply_method -> ?minimum_engine_version:Types.string_ -> ?is_modifiable:Types.boolean_ -> ?allowed_values:Types.string_ -> ?data_type:Types.string_ -> ?apply_type:Types.string_ -> ?source:Types.string_ -> ?description:Types.string_ -> ?parameter_value:Types.string_ -> ?parameter_name:Types.string_ -> unit -> Types.parameter
val make_reset_db_cluster_parameter_group_message : ?parameters:Types.parameters_list -> ?reset_all_parameters:Types.boolean_ -> db_cluster_parameter_group_name:Types.string_ -> unit -> Types.reset_db_cluster_parameter_group_message
val make_db_cluster_parameter_group_name_message : ?db_cluster_parameter_group_name:Types.string_ -> unit -> Types.db_cluster_parameter_group_name_message
val make_remove_tags_from_resource_message : tag_keys:Types.key_list -> resource_name:Types.string_ -> unit -> Types.remove_tags_from_resource_message
val make_event_subscription : ?event_subscription_arn:Types.string_ -> ?enabled:Types.boolean_ -> ?event_categories_list:Types.event_categories_list -> ?source_ids_list:Types.source_ids_list -> ?source_type:Types.string_ -> ?subscription_creation_time:Types.string_ -> ?status:Types.string_ -> ?sns_topic_arn:Types.string_ -> ?cust_subscription_id:Types.string_ -> ?customer_aws_id:Types.string_ -> unit -> Types.event_subscription
val make_remove_source_identifier_from_subscription_message : source_identifier:Types.string_ -> subscription_name:Types.string_ -> unit -> Types.remove_source_identifier_from_subscription_message
val make_remove_from_global_cluster_message : db_cluster_identifier:Types.string_ -> global_cluster_identifier:Types.global_cluster_identifier -> unit -> Types.remove_from_global_cluster_message
val make_endpoint : ?hosted_zone_id:Types.string_ -> ?port:Types.integer -> ?address:Types.string_ -> unit -> Types.endpoint
val make_db_subnet_group : ?supported_network_types:Types.network_type_list -> ?db_subnet_group_arn:Types.string_ -> ?subnets:Types.subnet_list -> ?subnet_group_status:Types.string_ -> ?vpc_id:Types.string_ -> ?db_subnet_group_description:Types.string_ -> ?db_subnet_group_name:Types.string_ -> unit -> Types.db_subnet_group
val make_pending_cloudwatch_logs_exports : ?log_types_to_disable:Types.log_type_list -> ?log_types_to_enable:Types.log_type_list -> unit -> Types.pending_cloudwatch_logs_exports
val make_pending_modified_values : ?pending_cloudwatch_logs_exports:Types.pending_cloudwatch_logs_exports -> ?db_subnet_group_name:Types.string_ -> ?ca_certificate_identifier:Types.string_ -> ?storage_type:Types.string_ -> ?db_instance_identifier:Types.string_ -> ?iops:Types.integer_optional -> ?license_model:Types.string_ -> ?engine_version:Types.string_ -> ?multi_a_z:Types.boolean_optional -> ?backup_retention_period:Types.integer_optional -> ?port:Types.integer_optional -> ?master_user_password:Types.string_ -> ?allocated_storage:Types.integer_optional -> ?db_instance_class:Types.string_ -> unit -> Types.pending_modified_values
val make_db_instance_status_info : ?message:Types.string_ -> ?status:Types.string_ -> ?normal:Types.boolean_ -> ?status_type:Types.string_ -> unit -> Types.db_instance_status_info
val make_certificate_details : ?valid_till:Types.t_stamp -> ?ca_identifier:Types.string_ -> unit -> Types.certificate_details
val make_db_instance : ?performance_insights_kms_key_id:Types.string_ -> ?performance_insights_enabled:Types.boolean_optional -> ?certificate_details:Types.certificate_details -> ?enabled_cloudwatch_logs_exports:Types.log_type_list -> ?db_instance_arn:Types.string_ -> ?promotion_tier:Types.integer_optional -> ?copy_tags_to_snapshot:Types.boolean_optional -> ?ca_certificate_identifier:Types.string_ -> ?dbi_resource_id:Types.string_ -> ?kms_key_id:Types.string_ -> ?storage_encrypted:Types.boolean_ -> ?db_cluster_identifier:Types.string_ -> ?status_infos:Types.db_instance_status_info_list -> ?publicly_accessible:Types.boolean_ -> ?auto_minor_version_upgrade:Types.boolean_ -> ?engine_version:Types.string_ -> ?latest_restorable_time:Types.t_stamp -> ?pending_modified_values:Types.pending_modified_values -> ?preferred_maintenance_window:Types.string_ -> ?db_subnet_group:Types.db_subnet_group -> ?availability_zone:Types.string_ -> ?vpc_security_groups:Types.vpc_security_group_membership_list -> ?backup_retention_period:Types.integer -> ?preferred_backup_window:Types.string_ -> ?instance_create_time:Types.t_stamp -> ?endpoint:Types.endpoint -> ?db_instance_status:Types.string_ -> ?engine:Types.string_ -> ?db_instance_class:Types.string_ -> ?db_instance_identifier:Types.string_ -> unit -> Types.db_instance
val make_reboot_db_instance_message : ?force_failover:Types.boolean_optional -> db_instance_identifier:Types.string_ -> unit -> Types.reboot_db_instance_message
val make_pending_maintenance_actions_message : ?marker:Types.string_ -> ?pending_maintenance_actions:Types.pending_maintenance_actions -> unit -> Types.pending_maintenance_actions_message
val make_orderable_db_instance_option : ?storage_type:Types.string_ -> ?vpc:Types.boolean_ -> ?availability_zones:Types.availability_zone_list -> ?license_model:Types.string_ -> ?db_instance_class:Types.string_ -> ?engine_version:Types.string_ -> ?engine:Types.string_ -> unit -> Types.orderable_db_instance_option
val make_orderable_db_instance_options_message : ?marker:Types.string_ -> ?orderable_db_instance_options:Types.orderable_db_instance_options_list -> unit -> Types.orderable_db_instance_options_message
val make_modify_global_cluster_message : ?deletion_protection:Types.boolean_optional -> ?new_global_cluster_identifier:Types.global_cluster_identifier -> global_cluster_identifier:Types.global_cluster_identifier -> unit -> Types.modify_global_cluster_message
val make_modify_event_subscription_message : ?enabled:Types.boolean_optional -> ?event_categories:Types.event_categories_list -> ?source_type:Types.string_ -> ?sns_topic_arn:Types.string_ -> subscription_name:Types.string_ -> unit -> Types.modify_event_subscription_message
val make_modify_db_subnet_group_message : ?db_subnet_group_description:Types.string_ -> subnet_ids:Types.subnet_identifier_list -> db_subnet_group_name:Types.string_ -> unit -> Types.modify_db_subnet_group_message
val make_modify_db_instance_message : ?certificate_rotation_restart:Types.boolean_optional -> ?performance_insights_kms_key_id:Types.string_ -> ?enable_performance_insights:Types.boolean_optional -> ?promotion_tier:Types.integer_optional -> ?copy_tags_to_snapshot:Types.boolean_optional -> ?ca_certificate_identifier:Types.string_ -> ?new_db_instance_identifier:Types.string_ -> ?auto_minor_version_upgrade:Types.boolean_optional -> ?preferred_maintenance_window:Types.string_ -> ?apply_immediately:Types.boolean_ -> ?db_instance_class:Types.string_ -> db_instance_identifier:Types.string_ -> unit -> Types.modify_db_instance_message
val make_db_cluster_snapshot_attribute : ?attribute_values:Types.attribute_value_list -> ?attribute_name:Types.string_ -> unit -> Types.db_cluster_snapshot_attribute
val make_modify_db_cluster_snapshot_attribute_message : ?values_to_remove:Types.attribute_value_list -> ?values_to_add:Types.attribute_value_list -> attribute_name:Types.string_ -> db_cluster_snapshot_identifier:Types.string_ -> unit -> Types.modify_db_cluster_snapshot_attribute_message
val make_modify_db_cluster_parameter_group_message : parameters:Types.parameters_list -> db_cluster_parameter_group_name:Types.string_ -> unit -> Types.modify_db_cluster_parameter_group_message
val make_cloudwatch_logs_export_configuration : ?disable_log_types:Types.log_type_list -> ?enable_log_types:Types.log_type_list -> unit -> Types.cloudwatch_logs_export_configuration
val make_modify_db_cluster_message : ?network_type:Types.string_ -> ?rotate_master_user_password:Types.boolean_optional -> ?master_user_secret_kms_key_id:Types.string_ -> ?manage_master_user_password:Types.boolean_optional -> ?serverless_v2_scaling_configuration: Types.serverless_v2_scaling_configuration -> ?storage_type:Types.string_ -> ?deletion_protection:Types.boolean_optional -> ?allow_major_version_upgrade:Types.boolean_ -> ?engine_version:Types.string_ -> ?cloudwatch_logs_export_configuration: Types.cloudwatch_logs_export_configuration -> ?preferred_maintenance_window:Types.string_ -> ?preferred_backup_window:Types.string_ -> ?master_user_password:Types.string_ -> ?port:Types.integer_optional -> ?vpc_security_group_ids:Types.vpc_security_group_id_list -> ?db_cluster_parameter_group_name:Types.string_ -> ?backup_retention_period:Types.integer_optional -> ?apply_immediately:Types.boolean_ -> ?new_db_cluster_identifier:Types.string_ -> db_cluster_identifier:Types.string_ -> unit -> Types.modify_db_cluster_message
val make_filter : values:Types.filter_value_list -> name:Types.string_ -> unit -> Types.filter
val make_list_tags_for_resource_message : ?filters:Types.filter_list -> resource_name:Types.string_ -> unit -> Types.list_tags_for_resource_message
val make_global_clusters_message : ?global_clusters:Types.global_cluster_list -> ?marker:Types.string_ -> unit -> Types.global_clusters_message
val make_failover_global_cluster_message : ?switchover:Types.boolean_optional -> ?allow_data_loss:Types.boolean_optional -> target_db_cluster_identifier:Types.db_cluster_identifier -> global_cluster_identifier:Types.global_cluster_identifier -> unit -> Types.failover_global_cluster_message
val make_failover_db_cluster_message : ?target_db_instance_identifier:Types.string_ -> ?db_cluster_identifier:Types.string_ -> unit -> Types.failover_db_cluster_message
val make_event : ?source_arn:Types.string_ -> ?date:Types.t_stamp -> ?event_categories:Types.event_categories_list -> ?message:Types.string_ -> ?source_type:Types.source_type -> ?source_identifier:Types.string_ -> unit -> Types.event
val make_events_message : ?events:Types.event_list -> ?marker:Types.string_ -> unit -> Types.events_message
val make_event_subscriptions_message : ?event_subscriptions_list:Types.event_subscriptions_list -> ?marker:Types.string_ -> unit -> Types.event_subscriptions_message
val make_event_categories_map : ?event_categories:Types.event_categories_list -> ?source_type:Types.string_ -> unit -> Types.event_categories_map
val make_event_categories_message : ?event_categories_map_list:Types.event_categories_map_list -> unit -> Types.event_categories_message
val make_engine_defaults : ?parameters:Types.parameters_list -> ?marker:Types.string_ -> ?db_parameter_group_family:Types.string_ -> unit -> Types.engine_defaults
val make_describe_pending_maintenance_actions_message : ?max_records:Types.integer_optional -> ?marker:Types.string_ -> ?filters:Types.filter_list -> ?resource_identifier:Types.string_ -> unit -> Types.describe_pending_maintenance_actions_message
val make_describe_orderable_db_instance_options_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?vpc:Types.boolean_optional -> ?license_model:Types.string_ -> ?db_instance_class:Types.string_ -> ?engine_version:Types.string_ -> engine:Types.string_ -> unit -> Types.describe_orderable_db_instance_options_message
val make_describe_global_clusters_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?global_cluster_identifier:Types.global_cluster_identifier -> unit -> Types.describe_global_clusters_message
val make_describe_events_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?event_categories:Types.event_categories_list -> ?duration:Types.integer_optional -> ?end_time:Types.t_stamp -> ?start_time:Types.t_stamp -> ?source_type:Types.source_type -> ?source_identifier:Types.string_ -> unit -> Types.describe_events_message
val make_describe_event_subscriptions_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?subscription_name:Types.string_ -> unit -> Types.describe_event_subscriptions_message
val make_describe_event_categories_message : ?filters:Types.filter_list -> ?source_type:Types.string_ -> unit -> Types.describe_event_categories_message
val make_describe_engine_default_cluster_parameters_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> db_parameter_group_family:Types.string_ -> unit -> Types.describe_engine_default_cluster_parameters_message
val make_describe_db_subnet_groups_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?db_subnet_group_name:Types.string_ -> unit -> Types.describe_db_subnet_groups_message
val make_db_subnet_group_message : ?db_subnet_groups:Types.db_subnet_groups -> ?marker:Types.string_ -> unit -> Types.db_subnet_group_message
val make_describe_db_instances_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?db_instance_identifier:Types.string_ -> unit -> Types.describe_db_instances_message
val make_db_instance_message : ?db_instances:Types.db_instance_list -> ?marker:Types.string_ -> unit -> Types.db_instance_message
val make_describe_db_engine_versions_message : ?list_supported_timezones:Types.boolean_optional -> ?list_supported_character_sets:Types.boolean_optional -> ?default_only:Types.boolean_ -> ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?db_parameter_group_family:Types.string_ -> ?engine_version:Types.string_ -> ?engine:Types.string_ -> unit -> Types.describe_db_engine_versions_message
val make_db_engine_version : ?serverless_v2_features_support:Types.serverless_v2_features_support -> ?supports_certificate_rotation_without_restart:Types.boolean_optional -> ?supported_ca_certificate_identifiers:Types.ca_certificate_identifiers_list -> ?supports_log_exports_to_cloudwatch_logs:Types.boolean_ -> ?exportable_log_types:Types.log_type_list -> ?valid_upgrade_target:Types.valid_upgrade_target_list -> ?db_engine_version_description:Types.string_ -> ?db_engine_description:Types.string_ -> ?db_parameter_group_family:Types.string_ -> ?engine_version:Types.string_ -> ?engine:Types.string_ -> unit -> Types.db_engine_version
val make_db_engine_version_message : ?db_engine_versions:Types.db_engine_version_list -> ?marker:Types.string_ -> unit -> Types.db_engine_version_message
val make_describe_db_clusters_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?db_cluster_identifier:Types.string_ -> unit -> Types.describe_db_clusters_message
val make_db_cluster_message : ?db_clusters:Types.db_cluster_list -> ?marker:Types.string_ -> unit -> Types.db_cluster_message
val make_describe_db_cluster_snapshots_message : ?include_public:Types.boolean_ -> ?include_shared:Types.boolean_ -> ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?snapshot_type:Types.string_ -> ?db_cluster_snapshot_identifier:Types.string_ -> ?db_cluster_identifier:Types.string_ -> unit -> Types.describe_db_cluster_snapshots_message
val make_db_cluster_snapshot : ?storage_type:Types.string_ -> ?source_db_cluster_snapshot_arn:Types.string_ -> ?db_cluster_snapshot_arn:Types.string_ -> ?kms_key_id:Types.string_ -> ?storage_encrypted:Types.boolean_ -> ?percent_progress:Types.integer -> ?snapshot_type:Types.string_ -> ?engine_version:Types.string_ -> ?master_username:Types.string_ -> ?cluster_create_time:Types.t_stamp -> ?vpc_id:Types.string_ -> ?port:Types.integer -> ?status:Types.string_ -> ?engine:Types.string_ -> ?snapshot_create_time:Types.t_stamp -> ?db_cluster_identifier:Types.string_ -> ?db_cluster_snapshot_identifier:Types.string_ -> ?availability_zones:Types.availability_zones -> unit -> Types.db_cluster_snapshot
val make_db_cluster_snapshot_message : ?db_cluster_snapshots:Types.db_cluster_snapshot_list -> ?marker:Types.string_ -> unit -> Types.db_cluster_snapshot_message
val make_describe_db_cluster_snapshot_attributes_message : db_cluster_snapshot_identifier:Types.string_ -> unit -> Types.describe_db_cluster_snapshot_attributes_message
val make_describe_db_cluster_parameters_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?source:Types.string_ -> db_cluster_parameter_group_name:Types.string_ -> unit -> Types.describe_db_cluster_parameters_message
val make_db_cluster_parameter_group_details : ?marker:Types.string_ -> ?parameters:Types.parameters_list -> unit -> Types.db_cluster_parameter_group_details
val make_describe_db_cluster_parameter_groups_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?db_cluster_parameter_group_name:Types.string_ -> unit -> Types.describe_db_cluster_parameter_groups_message
val make_db_cluster_parameter_group : ?db_cluster_parameter_group_arn:Types.string_ -> ?description:Types.string_ -> ?db_parameter_group_family:Types.string_ -> ?db_cluster_parameter_group_name:Types.string_ -> unit -> Types.db_cluster_parameter_group
val make_db_cluster_parameter_groups_message : ?db_cluster_parameter_groups:Types.db_cluster_parameter_group_list -> ?marker:Types.string_ -> unit -> Types.db_cluster_parameter_groups_message
val make_describe_certificates_message : ?marker:Types.string_ -> ?max_records:Types.integer_optional -> ?filters:Types.filter_list -> ?certificate_identifier:Types.string_ -> unit -> Types.describe_certificates_message
val make_certificate : ?certificate_arn:Types.string_ -> ?valid_till:Types.t_stamp -> ?valid_from:Types.t_stamp -> ?thumbprint:Types.string_ -> ?certificate_type:Types.string_ -> ?certificate_identifier:Types.string_ -> unit -> Types.certificate
val make_certificate_message : ?marker:Types.string_ -> ?certificates:Types.certificate_list -> unit -> Types.certificate_message
val make_delete_global_cluster_message : global_cluster_identifier:Types.global_cluster_identifier -> unit -> Types.delete_global_cluster_message
val make_delete_event_subscription_message : subscription_name:Types.string_ -> unit -> Types.delete_event_subscription_message
val make_delete_db_subnet_group_message : db_subnet_group_name:Types.string_ -> unit -> Types.delete_db_subnet_group_message
val make_delete_db_instance_message : db_instance_identifier:Types.string_ -> unit -> Types.delete_db_instance_message
val make_delete_db_cluster_snapshot_message : db_cluster_snapshot_identifier:Types.string_ -> unit -> Types.delete_db_cluster_snapshot_message
val make_delete_db_cluster_parameter_group_message : db_cluster_parameter_group_name:Types.string_ -> unit -> Types.delete_db_cluster_parameter_group_message
val make_delete_db_cluster_message : ?final_db_snapshot_identifier:Types.string_ -> ?skip_final_snapshot:Types.boolean_ -> db_cluster_identifier:Types.string_ -> unit -> Types.delete_db_cluster_message
val make_create_global_cluster_message : ?storage_encrypted:Types.boolean_optional -> ?database_name:Types.string_ -> ?deletion_protection:Types.boolean_optional -> ?engine_version:Types.string_ -> ?engine:Types.string_ -> ?source_db_cluster_identifier:Types.string_ -> global_cluster_identifier:Types.global_cluster_identifier -> unit -> Types.create_global_cluster_message
val make_create_event_subscription_message : ?tags:Types.tag_list -> ?enabled:Types.boolean_optional -> ?source_ids:Types.source_ids_list -> ?event_categories:Types.event_categories_list -> ?source_type:Types.string_ -> sns_topic_arn:Types.string_ -> subscription_name:Types.string_ -> unit -> Types.create_event_subscription_message
val make_create_db_subnet_group_message : ?tags:Types.tag_list -> subnet_ids:Types.subnet_identifier_list -> db_subnet_group_description:Types.string_ -> db_subnet_group_name:Types.string_ -> unit -> Types.create_db_subnet_group_message
val make_create_db_instance_message : ?ca_certificate_identifier:Types.string_ -> ?performance_insights_kms_key_id:Types.string_ -> ?enable_performance_insights:Types.boolean_optional -> ?promotion_tier:Types.integer_optional -> ?copy_tags_to_snapshot:Types.boolean_optional -> ?tags:Types.tag_list -> ?auto_minor_version_upgrade:Types.boolean_optional -> ?preferred_maintenance_window:Types.string_ -> ?availability_zone:Types.string_ -> db_cluster_identifier:Types.string_ -> engine:Types.string_ -> db_instance_class:Types.string_ -> db_instance_identifier:Types.string_ -> unit -> Types.create_db_instance_message
val make_create_db_cluster_snapshot_message : ?tags:Types.tag_list -> db_cluster_identifier:Types.string_ -> db_cluster_snapshot_identifier:Types.string_ -> unit -> Types.create_db_cluster_snapshot_message
val make_create_db_cluster_parameter_group_message : ?tags:Types.tag_list -> description:Types.string_ -> db_parameter_group_family:Types.string_ -> db_cluster_parameter_group_name:Types.string_ -> unit -> Types.create_db_cluster_parameter_group_message
val make_create_db_cluster_message : ?network_type:Types.string_ -> ?master_user_secret_kms_key_id:Types.string_ -> ?manage_master_user_password:Types.boolean_optional -> ?serverless_v2_scaling_configuration: Types.serverless_v2_scaling_configuration -> ?storage_type:Types.string_ -> ?global_cluster_identifier:Types.global_cluster_identifier -> ?deletion_protection:Types.boolean_optional -> ?enable_cloudwatch_logs_exports:Types.log_type_list -> ?pre_signed_url:Types.string_ -> ?kms_key_id:Types.string_ -> ?storage_encrypted:Types.boolean_optional -> ?tags:Types.tag_list -> ?preferred_maintenance_window:Types.string_ -> ?preferred_backup_window:Types.string_ -> ?master_user_password:Types.string_ -> ?master_username:Types.string_ -> ?port:Types.integer_optional -> ?engine_version:Types.string_ -> ?db_subnet_group_name:Types.string_ -> ?vpc_security_group_ids:Types.vpc_security_group_id_list -> ?db_cluster_parameter_group_name:Types.string_ -> ?backup_retention_period:Types.integer_optional -> ?availability_zones:Types.availability_zones -> engine:Types.string_ -> db_cluster_identifier:Types.string_ -> unit -> Types.create_db_cluster_message
val make_copy_db_cluster_snapshot_message : ?tags:Types.tag_list -> ?copy_tags:Types.boolean_optional -> ?pre_signed_url:Types.string_ -> ?kms_key_id:Types.string_ -> target_db_cluster_snapshot_identifier:Types.string_ -> source_db_cluster_snapshot_identifier:Types.string_ -> unit -> Types.copy_db_cluster_snapshot_message
val make_copy_db_cluster_parameter_group_message : ?tags:Types.tag_list -> target_db_cluster_parameter_group_description:Types.string_ -> target_db_cluster_parameter_group_identifier:Types.string_ -> source_db_cluster_parameter_group_identifier:Types.string_ -> unit -> Types.copy_db_cluster_parameter_group_message
val make_apply_pending_maintenance_action_message : opt_in_type:Types.string_ -> apply_action:Types.string_ -> resource_identifier:Types.string_ -> unit -> Types.apply_pending_maintenance_action_message
val make_add_tags_to_resource_message : tags:Types.tag_list -> resource_name:Types.string_ -> unit -> Types.add_tags_to_resource_message
val make_add_source_identifier_to_subscription_message : source_identifier:Types.string_ -> subscription_name:Types.string_ -> unit -> Types.add_source_identifier_to_subscription_message

Operations

Adds a source identifier to an existing event notification subscription.

module AddTagsToResource : sig ... end

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.

module ApplyPendingMaintenanceAction : sig ... end

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

module CopyDBClusterParameterGroup : sig ... end

Copies the specified cluster parameter group.

module CopyDBClusterSnapshot : sig ... end

Copies a snapshot of a cluster.

module CreateDBCluster : sig ... end

Creates a new Amazon DocumentDB cluster.

module CreateDBClusterParameterGroup : sig ... end

Creates a new cluster parameter group.

module CreateDBClusterSnapshot : sig ... end

Creates a snapshot of a cluster.

module CreateDBInstance : sig ... end

Creates a new instance.

module CreateDBSubnetGroup : sig ... end

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

module CreateEventSubscription : sig ... end

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

module CreateGlobalCluster : sig ... end

Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to 10 read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

module DeleteDBCluster : sig ... end

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

module DeleteDBClusterParameterGroup : sig ... end

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

module DeleteDBClusterSnapshot : sig ... end

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

module DeleteDBInstance : sig ... end

Deletes a previously provisioned instance.

module DeleteDBSubnetGroup : sig ... end

Deletes a subnet group.

module DeleteEventSubscription : sig ... end

Deletes an Amazon DocumentDB event notification subscription.

module DeleteGlobalCluster : sig ... end

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

module DescribeCertificates : sig ... end

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

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

module DescribeDBClusterParameters : sig ... end

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

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

module DescribeDBClusterSnapshots : sig ... end

Returns information about cluster snapshots. This API operation supports pagination.

module DescribeDBClusters : sig ... end

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

module DescribeDBEngineVersions : sig ... end

Returns a list of the available engines.

module DescribeDBInstances : sig ... end

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

module DescribeDBSubnetGroups : sig ... end

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

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

module DescribeEventCategories : sig ... end

Displays a list of categories for all event source types, or, if specified, for a specified source type.

module DescribeEventSubscriptions : sig ... end

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

module DescribeEvents : sig ... end

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

module DescribeGlobalClusters : sig ... end

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

Returns a list of orderable instance options for the specified engine.

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

module FailoverDBCluster : sig ... end

Forces a failover for a cluster.

module FailoverGlobalCluster : sig ... end

Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.

module ListTagsForResource : sig ... end

Lists all tags on an Amazon DocumentDB resource.

module ModifyDBCluster : sig ... end

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

module ModifyDBClusterParameterGroup : sig ... end

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

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

module ModifyDBInstance : sig ... end

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

module ModifyDBSubnetGroup : sig ... end

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

module ModifyEventSubscription : sig ... end

Modifies an existing Amazon DocumentDB event notification subscription.

module ModifyGlobalCluster : sig ... end

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

module RebootDBInstance : sig ... end

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

module RemoveFromGlobalCluster : sig ... end

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

Removes a source identifier from an existing Amazon DocumentDB event notification subscription.

module RemoveTagsFromResource : sig ... end

Removes metadata tags from an Amazon DocumentDB resource.

module ResetDBClusterParameterGroup : sig ... end

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

module RestoreDBClusterFromSnapshot : sig ... end

Creates a new cluster from a snapshot or cluster snapshot.

module RestoreDBClusterToPointInTime : sig ... end

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

module StartDBCluster : sig ... end

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

module StopDBCluster : sig ... end

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

module SwitchoverGlobalCluster : sig ... end
module Query_serializers : sig ... end
module Query_deserializers : sig ... end