ExAws.RDS.Core
Amazon Relational Database Service
Amazon Relational Database Service
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, Oracle, or Aurora database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance’s compute resources and storage capacity to meet your application’s demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.
Summary↑
Types ↑
option_group_option :: [default_port: integer_optional, description: binary, engine_name: binary, major_engine_version: binary, minimum_required_minor_engine_version: binary, name: binary, option_group_option_settings: option_group_option_settings_list, options_depended_on: options_depended_on, permanent: boolean, persistent: boolean, port_required: boolean]
key_list :: [binary]
create_db_cluster_parameter_group_result :: [{:db_cluster_parameter_group, db_cluster_parameter_group}]
db_cluster :: [allocated_storage: integer_optional, availability_zones: availability_zones, backup_retention_period: integer_optional, character_set_name: binary, db_cluster_identifier: binary, db_cluster_members: db_cluster_member_list, db_cluster_option_group_memberships: db_cluster_option_group_memberships, db_cluster_parameter_group: binary, db_subnet_group: binary, database_name: binary, earliest_restorable_time: t_stamp, endpoint: binary, engine: binary, engine_version: binary, latest_restorable_time: t_stamp, master_username: binary, percent_progress: binary, port: integer_optional, preferred_backup_window: binary, preferred_maintenance_window: binary, status: binary, vpc_security_groups: vpc_security_group_membership_list]
source_type :: binary
subnet_list :: [subnet]
describe_db_log_files_response :: [describe_db_log_files: describe_db_log_files_list, marker: binary]
db_subnet_group_message :: [db_subnet_groups: db_subnet_groups, marker: binary]
copy_db_snapshot_message :: [source_db_snapshot_identifier: binary, tags: tag_list, target_db_snapshot_identifier: binary]
db_security_group_name_list :: [binary]
describe_reserved_db_instances_offerings_message :: [db_instance_class: binary, duration: binary, filters: filter_list, marker: binary, max_records: integer_optional, multi_az: boolean_optional, offering_type: binary, product_description: binary, reserved_db_instances_offering_id: binary]
describe_db_clusters_message :: [db_cluster_identifier: binary, filters: filter_list, marker: binary, max_records: integer_optional]
subnet :: [subnet_availability_zone: availability_zone, subnet_identifier: binary, subnet_status: binary]
tag_list_message :: [{:tag_list, tag_list}]
parameter :: [allowed_values: binary, apply_method: apply_method, apply_type: binary, data_type: binary, description: binary, is_modifiable: boolean, minimum_engine_version: binary, parameter_name: binary, parameter_value: binary, source: binary]
orderable_db_instance_options_message :: [marker: binary, orderable_db_instance_options: orderable_db_instance_options_list]
db_parameter_group :: [db_parameter_group_family: binary, db_parameter_group_name: binary, description: binary]
ec2_security_group :: [e_c2_security_group_id: binary, e_c2_security_group_name: binary, e_c2_security_group_owner_id: binary, status: binary]
event_categories_map :: [event_categories: event_categories_list, source_type: binary]
restore_db_instance_to_point_in_time_message :: [auto_minor_version_upgrade: boolean_optional, availability_zone: binary, db_instance_class: binary, db_name: binary, db_subnet_group_name: binary, engine: binary, iops: integer_optional, license_model: binary, multi_az: boolean_optional, option_group_name: binary, port: integer_optional, publicly_accessible: boolean_optional, restore_time: t_stamp, source_db_instance_identifier: binary, storage_type: binary, tags: tag_list, target_db_instance_identifier: binary, tde_credential_arn: binary, tde_credential_password: binary, use_latest_restorable_time: boolean]
db_instance :: [backup_retention_period: integer, db_cluster_identifier: binary, tde_credential_arn: binary, read_replica_source_db_instance_identifier: binary, latest_restorable_time: t_stamp, read_replica_db_instance_identifiers: read_replica_db_instance_identifier_list, license_model: binary, multi_az: boolean, preferred_backup_window: binary, option_group_memberships: option_group_membership_list, dbi_resource_id: binary, character_set_name: binary, db_instance_port: integer, status_infos: db_instance_status_info_list, engine: binary, engine_version: binary, storage_type: binary, pending_modified_values: pending_modified_values, kms_key_id: binary, ca_certificate_identifier: binary, db_instance_class: binary, endpoint: endpoint, storage_encrypted: boolean, db_parameter_groups: db_parameter_group_status_list, publicly_accessible: boolean, availability_zone: binary, secondary_availability_zone: binary, db_instance_status: binary, allocated_storage: integer, db_security_groups: db_security_group_membership_list, auto_minor_version_upgrade: boolean, db_subnet_group: db_subnet_group, db_name: binary, preferred_maintenance_window: binary, iops: integer_optional, master_username: binary, vpc_security_groups: vpc_security_group_membership_list, instance_create_time: t_stamp, db_instance_identifier: binary]
delete_db_cluster_parameter_group_message :: [{:db_cluster_parameter_group_name, binary}]
create_db_cluster_parameter_group_message :: [db_cluster_parameter_group_name: binary, db_parameter_group_family: binary, description: binary, tags: tag_list]
promote_read_replica_result :: [{:db_instance, db_instance}]
subnet_already_in_use :: []
describe_db_cluster_parameter_groups_message :: [db_cluster_parameter_group_name: binary, filters: filter_list, marker: binary, max_records: integer_optional]
describe_db_security_groups_message :: [db_security_group_name: binary, filters: filter_list, marker: binary, max_records: integer_optional]
delete_event_subscription_result :: [{:event_subscription, event_subscription}]
option_group :: [allows_vpc_and_non_vpc_instance_memberships: boolean, engine_name: binary, major_engine_version: binary, option_group_description: binary, option_group_name: binary, options: options_list, vpc_id: binary]
event_list :: [event]
db_cluster_parameter_group_name_message :: [{:db_cluster_parameter_group_name, binary}]
modify_db_cluster_parameter_group_message :: [db_cluster_parameter_group_name: binary, parameters: parameters_list]
character_set :: [character_set_description: binary, character_set_name: binary]
add_source_identifier_to_subscription_result :: [{:event_subscription, event_subscription}]
create_db_cluster_snapshot_result :: [{:db_cluster_snapshot, db_cluster_snapshot}]
create_db_instance_read_replica_message :: [auto_minor_version_upgrade: boolean_optional, availability_zone: binary, db_instance_class: binary, db_instance_identifier: binary, db_subnet_group_name: binary, iops: integer_optional, option_group_name: binary, port: integer_optional, publicly_accessible: boolean_optional, source_db_instance_identifier: binary, storage_type: binary, tags: tag_list]
download_db_log_file_portion_message :: [db_instance_identifier: binary, log_file_name: binary, marker: binary, number_of_lines: integer]
apply_pending_maintenance_action_result :: [{:resource_pending_maintenance_actions, resource_pending_maintenance_actions}]
db_cluster_snapshot :: [allocated_storage: integer, availability_zones: availability_zones, cluster_create_time: t_stamp, db_cluster_identifier: binary, db_cluster_snapshot_identifier: binary, engine: binary, engine_version: binary, license_model: binary, master_username: binary, percent_progress: integer, port: integer, snapshot_create_time: t_stamp, snapshot_type: binary, status: binary, vpc_id: binary]
describe_event_categories_message :: [filters: filter_list, source_type: binary]
copy_db_cluster_snapshot_message :: [source_db_cluster_snapshot_identifier: binary, tags: tag_list, target_db_cluster_snapshot_identifier: binary]
source_not_found_fault :: []
event_subscriptions_message :: [event_subscriptions_list: event_subscriptions_list, marker: binary]
create_db_security_group_message :: [db_security_group_description: binary, db_security_group_name: binary, tags: tag_list]
option_groups :: [marker: binary, option_groups_list: option_groups_list]
create_db_subnet_group_result :: [{:db_subnet_group, db_subnet_group}]
db_cluster_parameter_group :: [db_cluster_parameter_group_name: binary, db_parameter_group_family: binary, description: binary]
account_quota :: [account_quota_name: binary, max: long, used: long]
delete_event_subscription_message :: [{:subscription_name, binary}]
pending_maintenance_action :: [action: binary, auto_applied_after_date: t_stamp, current_apply_date: t_stamp, description: binary, forced_apply_date: t_stamp, opt_in_status: binary]
modify_db_parameter_group_message :: [db_parameter_group_name: binary, parameters: parameters_list]
modify_db_subnet_group_result :: [{:db_subnet_group, db_subnet_group}]
create_option_group_message :: [engine_name: binary, major_engine_version: binary, option_group_description: binary, option_group_name: binary, tags: tag_list]
source_ids_list :: [binary]
describe_engine_default_cluster_parameters_message :: [db_parameter_group_family: binary, filters: filter_list, marker: binary, max_records: integer_optional]
option_names_list :: [binary]
create_db_cluster_snapshot_message :: [db_cluster_identifier: binary, db_cluster_snapshot_identifier: binary, tags: tag_list]
db_parameter_groups_message :: [db_parameter_groups: db_parameter_group_list, marker: binary]
failover_db_cluster_message :: [{:db_cluster_identifier, binary}]
promote_read_replica_message :: [backup_retention_period: integer_optional, db_instance_identifier: binary, preferred_backup_window: binary]
remove_tags_from_resource_message :: [resource_name: binary, tag_keys: key_list]
restore_db_instance_from_db_snapshot_result :: [{:db_instance, db_instance}]
sns_invalid_topic_fault :: []
option :: [db_security_group_memberships: db_security_group_membership_list, option_description: binary, option_name: binary, option_settings: option_setting_configuration_list, permanent: boolean, persistent: boolean, port: integer_optional, vpc_security_group_memberships: vpc_security_group_membership_list]
delete_db_cluster_result :: [{:db_cluster, db_cluster}]
delete_db_snapshot_message :: [{:db_snapshot_identifier, binary}]
filter :: [name: binary, values: filter_value_list]
db_cluster_parameter_groups_message :: [db_cluster_parameter_groups: db_cluster_parameter_group_list, marker: binary]
download_db_log_file_portion_details :: [additional_data_pending: boolean, log_file_data: binary, marker: binary]
add_tags_to_resource_message :: [resource_name: binary, tags: tag_list]
create_db_subnet_group_message :: [db_subnet_group_description: binary, db_subnet_group_name: binary, subnet_ids: subnet_identifier_list, tags: tag_list]
create_db_cluster_message :: [availability_zones: availability_zones, backup_retention_period: integer_optional, character_set_name: binary, db_cluster_identifier: binary, db_cluster_parameter_group_name: binary, db_subnet_group_name: binary, database_name: binary, engine: binary, engine_version: binary, master_user_password: binary, master_username: binary, option_group_name: binary, port: integer_optional, preferred_backup_window: binary, preferred_maintenance_window: binary, tags: tag_list, vpc_security_group_ids: vpc_security_group_id_list]
describe_db_subnet_groups_message :: [db_subnet_group_name: binary, filters: filter_list, marker: binary, max_records: integer_optional]
engine_defaults :: [db_parameter_group_family: binary, marker: binary, parameters: parameters_list]
reset_db_cluster_parameter_group_message :: [db_cluster_parameter_group_name: binary, parameters: parameters_list, reset_all_parameters: boolean]
vpc_security_group_membership :: [status: binary, vpc_security_group_id: binary]
restore_db_cluster_to_point_in_time_message :: [db_cluster_identifier: binary, db_subnet_group_name: binary, option_group_name: binary, port: integer_optional, restore_to_time: t_stamp, source_db_cluster_identifier: binary, tags: tag_list, use_latest_restorable_time: boolean, vpc_security_group_ids: vpc_security_group_id_list]
create_event_subscription_message :: [enabled: boolean_optional, event_categories: event_categories_list, sns_topic_arn: binary, source_ids: source_ids_list, source_type: binary, subscription_name: binary, tags: tag_list]
db_engine_version :: [db_engine_description: binary, db_engine_version_description: binary, db_parameter_group_family: binary, default_character_set: character_set, engine: binary, engine_version: binary, supported_character_sets: supported_character_sets_list]
read_replica_db_instance_identifier_list :: [binary]
purchase_reserved_db_instances_offering_result :: [{:reserved_db_instance, reserved_db_instance}]
describe_db_engine_versions_message :: [db_parameter_group_family: binary, default_only: boolean, engine: binary, engine_version: binary, filters: filter_list, list_supported_character_sets: boolean_optional, marker: binary, max_records: integer_optional]
delete_db_cluster_snapshot_result :: [{:db_cluster_snapshot, db_cluster_snapshot}]
filter_value_list :: [binary]
delete_db_parameter_group_message :: [{:db_parameter_group_name, binary}]
pending_maintenance_actions_message :: [marker: binary, pending_maintenance_actions: pending_maintenance_actions]
event_subscription :: [cust_subscription_id: binary, customer_aws_id: binary, enabled: boolean, event_categories_list: event_categories_list, sns_topic_arn: binary, source_ids_list: source_ids_list, source_type: binary, status: binary, subscription_creation_time: binary]
delete_db_instance_message :: [db_instance_identifier: binary, final_db_snapshot_identifier: binary, skip_final_snapshot: boolean]
describe_engine_default_parameters_result :: [{:engine_defaults, engine_defaults}]
pending_modified_values :: [allocated_storage: integer_optional, backup_retention_period: integer_optional, ca_certificate_identifier: binary, db_instance_class: binary, db_instance_identifier: binary, engine_version: binary, iops: integer_optional, master_user_password: binary, multi_az: boolean_optional, port: integer_optional, storage_type: binary]
option_group_option_setting :: [allowed_values: binary, apply_type: binary, default_value: binary, is_modifiable: boolean, setting_description: binary, setting_name: binary]
modify_db_cluster_message :: [apply_immediately: boolean, backup_retention_period: integer_optional, db_cluster_identifier: binary, db_cluster_parameter_group_name: binary, master_user_password: binary, new_db_cluster_identifier: binary, option_group_name: binary, port: integer_optional, preferred_backup_window: binary, preferred_maintenance_window: binary, vpc_security_group_ids: vpc_security_group_id_list]
describe_certificates_message :: [certificate_identifier: binary, filters: filter_list, marker: binary, max_records: integer_optional]
tag :: [key: binary, value: binary]
db_snapshot_message :: [db_snapshots: db_snapshot_list, marker: binary]
recurring_charge :: [recurring_charge_amount: double, recurring_charge_frequency: binary]
resource_not_found_fault :: []
apply_method :: binary
endpoint :: [address: binary, port: integer]
reserved_db_instance_message :: [marker: binary, reserved_db_instances: reserved_db_instance_list]
add_source_identifier_to_subscription_message :: [source_identifier: binary, subscription_name: binary]
copy_option_group_message :: [source_option_group_identifier: binary, tags: tag_list, target_option_group_description: binary, target_option_group_identifier: binary]
subnet_identifier_list :: [binary]
copy_db_cluster_snapshot_result :: [{:db_cluster_snapshot, db_cluster_snapshot}]
copy_option_group_result :: [{:option_group, option_group}]
delete_db_cluster_snapshot_message :: [{:db_cluster_snapshot_identifier, binary}]
db_security_group_membership :: [db_security_group_name: binary, status: binary]
reset_db_parameter_group_message :: [db_parameter_group_name: binary, parameters: parameters_list, reset_all_parameters: boolean]
describe_db_snapshots_message :: [db_instance_identifier: binary, db_snapshot_identifier: binary, filters: filter_list, marker: binary, max_records: integer_optional, snapshot_type: binary]
modify_option_group_message :: [apply_immediately: boolean, option_group_name: binary, options_to_include: option_configuration_list, options_to_remove: option_names_list]
db_engine_version_message :: [db_engine_versions: db_engine_version_list, marker: binary]
t_stamp :: integer
modify_db_instance_message :: [allocated_storage: integer_optional, allow_major_version_upgrade: boolean, apply_immediately: boolean, auto_minor_version_upgrade: boolean_optional, backup_retention_period: integer_optional, ca_certificate_identifier: binary, db_instance_class: binary, db_instance_identifier: binary, db_parameter_group_name: binary, db_security_groups: db_security_group_name_list, engine_version: binary, iops: integer_optional, master_user_password: binary, multi_az: boolean_optional, new_db_instance_identifier: binary, option_group_name: binary, preferred_backup_window: binary, preferred_maintenance_window: binary, storage_type: binary, tde_credential_arn: binary, tde_credential_password: binary, vpc_security_group_ids: vpc_security_group_id_list]
purchase_reserved_db_instances_offering_message :: [db_instance_count: integer_optional, reserved_db_instance_id: binary, reserved_db_instances_offering_id: binary, tags: tag_list]
revoke_db_security_group_ingress_result :: [{:db_security_group, db_security_group}]
describe_db_cluster_parameters_message :: [db_cluster_parameter_group_name: binary, filters: filter_list, marker: binary, max_records: integer_optional, source: binary]
event_categories_list :: [binary]
revoke_db_security_group_ingress_message :: [cidrip: binary, db_security_group_name: binary, e_c2_security_group_id: binary, e_c2_security_group_name: binary, e_c2_security_group_owner_id: binary]
invalid_subnet :: []
create_db_snapshot_message :: [db_instance_identifier: binary, db_snapshot_identifier: binary, tags: tag_list]
db_parameter_group_details :: [marker: binary, parameters: parameters_list]
double :: float
availability_zone :: [{:name, binary}]
modify_option_group_result :: [{:option_group, option_group}]
create_db_instance_read_replica_result :: [{:db_instance, db_instance}]
db_instance_status_info :: [message: binary, normal: boolean, status: binary, status_type: binary]
copy_db_parameter_group_result :: [{:db_parameter_group, db_parameter_group}]
account_attributes_message :: [{:account_quotas, account_quota_list}]
reserved_db_instance :: [currency_code: binary, db_instance_class: binary, db_instance_count: integer, duration: integer, fixed_price: double, multi_az: boolean, offering_type: binary, product_description: binary, recurring_charges: recurring_charge_list, reserved_db_instance_id: binary, reserved_db_instances_offering_id: binary, start_time: t_stamp, state: binary, usage_price: double]
boolean_optional :: boolean
list_tags_for_resource_message :: [filters: filter_list, resource_name: binary]
options_depended_on :: [binary]
create_db_instance_message :: [allocated_storage: integer_optional, auto_minor_version_upgrade: boolean_optional, availability_zone: binary, backup_retention_period: integer_optional, character_set_name: binary, db_cluster_identifier: binary, db_instance_class: binary, db_instance_identifier: binary, db_name: binary, db_parameter_group_name: binary, db_security_groups: db_security_group_name_list, db_subnet_group_name: binary, engine: binary, engine_version: binary, iops: integer_optional, kms_key_id: binary, license_model: binary, master_user_password: binary, master_username: binary, multi_az: boolean_optional, option_group_name: binary, port: integer_optional, preferred_backup_window: binary, preferred_maintenance_window: binary, publicly_accessible: boolean_optional, storage_encrypted: boolean_optional, storage_type: binary, tags: tag_list, tde_credential_arn: binary, tde_credential_password: binary, vpc_security_group_ids: vpc_security_group_id_list]
describe_db_log_files_message :: [db_instance_identifier: binary, file_last_written: long, file_size: long, filename_contains: binary, filters: filter_list, marker: binary, max_records: integer_optional]
long :: integer
create_event_subscription_result :: [{:event_subscription, event_subscription}]
delete_db_subnet_group_message :: [{:db_subnet_group_name, binary}]
db_instance_message :: [db_instances: db_instance_list, marker: binary]
describe_pending_maintenance_actions_message :: [filters: filter_list, marker: binary, max_records: integer_optional, resource_identifier: binary]
remove_source_identifier_from_subscription_result :: [{:event_subscription, event_subscription}]
describe_event_subscriptions_message :: [filters: filter_list, marker: binary, max_records: integer_optional, subscription_name: binary]
describe_option_group_options_message :: [engine_name: binary, filters: filter_list, major_engine_version: binary, marker: binary, max_records: integer_optional]
authorize_db_security_group_ingress_result :: [{:db_security_group, db_security_group}]
option_setting :: [allowed_values: binary, apply_type: binary, data_type: binary, default_value: binary, description: binary, is_collection: boolean, is_modifiable: boolean, name: binary, value: binary]
authorize_db_security_group_ingress_message :: [cidrip: binary, db_security_group_name: binary, e_c2_security_group_id: binary, e_c2_security_group_name: binary, e_c2_security_group_owner_id: binary]
option_group_options_message :: [marker: binary, option_group_options: option_group_options_list]
describe_engine_default_cluster_parameters_result :: [{:engine_defaults, engine_defaults}]
db_cluster_message :: [db_clusters: db_cluster_list, marker: binary]
describe_db_instances_message :: [db_instance_identifier: binary, filters: filter_list, marker: binary, max_records: integer_optional]
availability_zones :: [binary]
create_db_instance_result :: [{:db_instance, db_instance}]
modify_db_cluster_result :: [{:db_cluster, db_cluster}]
describe_events_message :: [duration: integer_optional, end_time: t_stamp, event_categories: event_categories_list, filters: filter_list, marker: binary, max_records: integer_optional, source_identifier: binary, source_type: source_type, start_time: t_stamp]
restore_db_instance_to_point_in_time_result :: [{:db_instance, db_instance}]
db_cluster_snapshot_message :: [db_cluster_snapshots: db_cluster_snapshot_list, marker: binary]
db_cluster_parameter_group_details :: [marker: binary, parameters: parameters_list]
failover_db_cluster_result :: [{:db_cluster, db_cluster}]
create_db_security_group_result :: [{:db_security_group, db_security_group}]
restore_db_cluster_from_snapshot_message :: [availability_zones: availability_zones, db_cluster_identifier: binary, db_subnet_group_name: binary, database_name: binary, engine: binary, engine_version: binary, option_group_name: binary, port: integer_optional, snapshot_identifier: binary, tags: tag_list, vpc_security_group_ids: vpc_security_group_id_list]
describe_orderable_db_instance_options_message :: [db_instance_class: binary, engine: binary, engine_version: binary, filters: filter_list, license_model: binary, marker: binary, max_records: integer_optional, vpc: boolean_optional]
delete_option_group_message :: [{:option_group_name, binary}]
reserved_db_instances_offering :: [currency_code: binary, db_instance_class: binary, duration: integer, fixed_price: double, multi_az: boolean, offering_type: binary, product_description: binary, recurring_charges: recurring_charge_list, reserved_db_instances_offering_id: binary, usage_price: double]
describe_option_groups_message :: [engine_name: binary, filters: filter_list, major_engine_version: binary, marker: binary, max_records: integer_optional, option_group_name: binary]
describe_reserved_db_instances_message :: [db_instance_class: binary, duration: binary, filters: filter_list, marker: binary, max_records: integer_optional, multi_az: boolean_optional, offering_type: binary, product_description: binary, reserved_db_instance_id: binary, reserved_db_instances_offering_id: binary]
create_db_parameter_group_message :: [db_parameter_group_family: binary, db_parameter_group_name: binary, description: binary, tags: tag_list]
filter_list :: [filter]
db_parameter_group_status :: [db_parameter_group_name: binary, parameter_apply_status: binary]
db_subnet_group :: [db_subnet_group_description: binary, db_subnet_group_name: binary, subnet_group_status: binary, subnets: subnet_list, vpc_id: binary]
modify_event_subscription_message :: [enabled: boolean_optional, event_categories: event_categories_list, sns_topic_arn: binary, source_type: binary, subscription_name: binary]
modify_db_subnet_group_message :: [db_subnet_group_description: binary, db_subnet_group_name: binary, subnet_ids: subnet_identifier_list]
create_option_group_result :: [{:option_group, option_group}]
delete_db_snapshot_result :: [{:db_snapshot, db_snapshot}]
describe_db_parameter_groups_message :: [db_parameter_group_name: binary, filters: filter_list, marker: binary, max_records: integer_optional]
describe_db_parameters_message :: [db_parameter_group_name: binary, filters: filter_list, marker: binary, max_records: integer_optional, source: binary]
orderable_db_instance_option :: [availability_zones: availability_zone_list, db_instance_class: binary, engine: binary, engine_version: binary, license_model: binary, multi_az_capable: boolean, read_replica_capable: boolean, storage_type: binary, supports_iops: boolean, supports_storage_encryption: boolean, vpc: boolean]
db_security_group_message :: [db_security_groups: db_security_groups, marker: binary]
db_cluster_option_group_status :: [db_cluster_option_group_name: binary, status: binary]
describe_db_cluster_snapshots_message :: [db_cluster_identifier: binary, db_cluster_snapshot_identifier: binary, filters: filter_list, marker: binary, max_records: integer_optional, snapshot_type: binary]
resource_pending_maintenance_actions :: [pending_maintenance_action_details: pending_maintenance_action_details, resource_identifier: binary]
options_list :: [option]
delete_db_instance_result :: [{:db_instance, db_instance}]
restore_db_cluster_from_snapshot_result :: [{:db_cluster, db_cluster}]
remove_source_identifier_from_subscription_message :: [source_identifier: binary, subscription_name: binary]
copy_db_parameter_group_message :: [source_db_parameter_group_identifier: binary, tags: tag_list, target_db_parameter_group_description: binary, target_db_parameter_group_identifier: binary]
parameters_list :: [parameter]
db_snapshot :: [allocated_storage: integer, availability_zone: binary, db_instance_identifier: binary, db_snapshot_identifier: binary, encrypted: boolean, engine: binary, engine_version: binary, instance_create_time: t_stamp, iops: integer_optional, kms_key_id: binary, license_model: binary, master_username: binary, option_group_name: binary, percent_progress: integer, port: integer, snapshot_create_time: t_stamp, snapshot_type: binary, source_db_snapshot_identifier: binary, source_region: binary, status: binary, storage_type: binary, tde_credential_arn: binary, vpc_id: binary]
delete_db_security_group_message :: [{:db_security_group_name, binary}]
events_message :: [events: event_list, marker: binary]
modify_db_instance_result :: [{:db_instance, db_instance}]
option_group_membership :: [option_group_name: binary, status: binary]
reboot_db_instance_message :: [db_instance_identifier: binary, force_failover: boolean_optional]
event :: [date: t_stamp, event_categories: event_categories_list, message: binary, source_identifier: binary, source_type: source_type]
apply_pending_maintenance_action_message :: [apply_action: binary, opt_in_type: binary, resource_identifier: binary]
vpc_security_group_id_list :: [binary]
invalid_restore_fault :: []
integer_optional :: integer
create_db_parameter_group_result :: [{:db_parameter_group, db_parameter_group}]
restore_db_cluster_to_point_in_time_result :: [{:db_cluster, db_cluster}]
modify_event_subscription_result :: [{:event_subscription, event_subscription}]
reboot_db_instance_result :: [{:db_instance, db_instance}]
db_parameter_group_name_message :: [{:db_parameter_group_name, binary}]
ip_range_list :: [ip_range]
create_db_snapshot_result :: [{:db_snapshot, db_snapshot}]
db_security_group :: [db_security_group_description: binary, db_security_group_name: binary, e_c2_security_groups: ec2_security_group_list, ip_ranges: ip_range_list, owner_id: binary, vpc_id: binary]
option_configuration :: [db_security_group_memberships: db_security_group_name_list, option_name: binary, option_settings: option_settings_list, port: integer_optional, vpc_security_group_memberships: vpc_security_group_id_list]
certificate_message :: [certificates: certificate_list, marker: binary]
reserved_db_instances_offering_message :: [marker: binary, reserved_db_instances_offerings: reserved_db_instances_offering_list]
describe_db_log_files_details :: [last_written: long, log_file_name: binary, size: long]
db_cluster_member :: [db_cluster_parameter_group_status: binary, db_instance_identifier: binary, is_cluster_writer: boolean]
ip_range :: [cidrip: binary, status: binary]
certificate :: [certificate_identifier: binary, certificate_type: binary, thumbprint: binary, valid_from: t_stamp, valid_till: t_stamp]
delete_db_cluster_message :: [db_cluster_identifier: binary, final_db_snapshot_identifier: binary, skip_final_snapshot: boolean]
create_db_cluster_result :: [{:db_cluster, db_cluster}]
event_categories_message :: [{:event_categories_map_list, event_categories_map_list}]
describe_engine_default_parameters_message :: [db_parameter_group_family: binary, filters: filter_list, marker: binary, max_records: integer_optional]
copy_db_snapshot_result :: [{:db_snapshot, db_snapshot}]
restore_db_instance_from_db_snapshot_message :: [auto_minor_version_upgrade: boolean_optional, availability_zone: binary, db_instance_class: binary, db_instance_identifier: binary, db_name: binary, db_snapshot_identifier: binary, db_subnet_group_name: binary, engine: binary, iops: integer_optional, license_model: binary, multi_az: boolean_optional, option_group_name: binary, port: integer_optional, publicly_accessible: boolean_optional, storage_type: binary, tags: tag_list, tde_credential_arn: binary, tde_credential_password: binary]
Functions
Specs:
- add_source_identifier_to_subscription(client :: ExAws.RDS.t, input :: add_source_identifier_to_subscription_message) :: ExAws.Request.Query.response_t
AddSourceIdentifierToSubscription
Adds a source identifier to an existing RDS event notification subscription.
Specs:
- add_source_identifier_to_subscription!(client :: ExAws.RDS.t, input :: add_source_identifier_to_subscription_message) :: ExAws.Request.Query.success_t | no_return
Same as add_source_identifier_to_subscription/2
but raise on error.
Specs:
- add_tags_to_resource(client :: ExAws.RDS.t, input :: add_tags_to_resource_message) :: ExAws.Request.Query.response_t
AddTagsToResource
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
Specs:
- add_tags_to_resource!(client :: ExAws.RDS.t, input :: add_tags_to_resource_message) :: ExAws.Request.Query.success_t | no_return
Same as add_tags_to_resource/2
but raise on error.
Specs:
- apply_pending_maintenance_action(client :: ExAws.RDS.t, input :: apply_pending_maintenance_action_message) :: ExAws.Request.Query.response_t
ApplyPendingMaintenanceAction
Applies a pending maintenance action to a resource (for example, to a DB instance).
Specs:
- apply_pending_maintenance_action!(client :: ExAws.RDS.t, input :: apply_pending_maintenance_action_message) :: ExAws.Request.Query.success_t | no_return
Same as apply_pending_maintenance_action/2
but raise on error.
Specs:
- authorize_db_security_group_ingress(client :: ExAws.RDS.t, input :: authorize_db_security_group_ingress_message) :: ExAws.Request.Query.response_t
AuthorizeDBSecurityGroupIngress
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
Note: You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Specs:
- authorize_db_security_group_ingress!(client :: ExAws.RDS.t, input :: authorize_db_security_group_ingress_message) :: ExAws.Request.Query.success_t | no_return
Same as authorize_db_security_group_ingress/2
but raise on error.
Specs:
- copy_db_cluster_snapshot(client :: ExAws.RDS.t, input :: copy_db_cluster_snapshot_message) :: ExAws.Request.Query.response_t
CopyDBClusterSnapshot
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- copy_db_cluster_snapshot!(client :: ExAws.RDS.t, input :: copy_db_cluster_snapshot_message) :: ExAws.Request.Query.success_t | no_return
Same as copy_db_cluster_snapshot/2
but raise on error.
Specs:
- copy_db_parameter_group(client :: ExAws.RDS.t, input :: copy_db_parameter_group_message) :: ExAws.Request.Query.response_t
CopyDBParameterGroup
Copies the specified DB parameter group.
Specs:
- copy_db_parameter_group!(client :: ExAws.RDS.t, input :: copy_db_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as copy_db_parameter_group/2
but raise on error.
Specs:
- copy_db_snapshot(client :: ExAws.RDS.t, input :: copy_db_snapshot_message) :: ExAws.Request.Query.response_t
CopyDBSnapshot
Copies the specified DBSnapshot. The source DBSnapshot must be in the “available” state.
Specs:
- copy_db_snapshot!(client :: ExAws.RDS.t, input :: copy_db_snapshot_message) :: ExAws.Request.Query.success_t | no_return
Same as copy_db_snapshot/2
but raise on error.
Specs:
- copy_option_group(client :: ExAws.RDS.t, input :: copy_option_group_message) :: ExAws.Request.Query.response_t
CopyOptionGroup
Copies the specified option group.
Specs:
- copy_option_group!(client :: ExAws.RDS.t, input :: copy_option_group_message) :: ExAws.Request.Query.success_t | no_return
Same as copy_option_group/2
but raise on error.
Specs:
- create_db_cluster(client :: ExAws.RDS.t, input :: create_db_cluster_message) :: ExAws.Request.Query.response_t
CreateDBCluster
Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- create_db_cluster!(client :: ExAws.RDS.t, input :: create_db_cluster_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_cluster/2
but raise on error.
Specs:
- create_db_cluster_parameter_group(client :: ExAws.RDS.t, input :: create_db_cluster_parameter_group_message) :: ExAws.Request.Query.response_t
CreateDBClusterParameterGroup
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default
parameters for the database engine used by instances in the DB cluster. To
provide custom values for any of the parameters, you must modify the group
after creating it using ModifyDBClusterParameterGroup
. Once you’ve
created a DB cluster parameter group, you need to associate it with your DB
cluster using ModifyDBCluster
. When you associate a new DB cluster
parameter group with a running DB cluster, you need to reboot the DB
instances in the DB cluster without failover for the new DB cluster
parameter group and associated settings to take effect.
* After you create a DB cluster parameter group, you should wait at least
5 minutes before creating your first DB cluster that uses that DB cluster
parameter group as the default parameter group. This allows Amazon RDS to
fully complete the create action before the DB cluster parameter group is
used as the default for a new DB cluster. This is especially important for
parameters that are critical when creating the default database for a DB
cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups*
option of the Amazon RDS console or
the DescribeDBClusterParameters
command to verify that your DB cluster
parameter group has been created or modified.
* For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.*
Specs:
- create_db_cluster_parameter_group!(client :: ExAws.RDS.t, input :: create_db_cluster_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_cluster_parameter_group/2
but raise on error.
Specs:
- create_db_cluster_snapshot(client :: ExAws.RDS.t, input :: create_db_cluster_snapshot_message) :: ExAws.Request.Query.response_t
CreateDBClusterSnapshot
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- create_db_cluster_snapshot!(client :: ExAws.RDS.t, input :: create_db_cluster_snapshot_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_cluster_snapshot/2
but raise on error.
Specs:
- create_db_instance(client :: ExAws.RDS.t, input :: create_db_instance_message) :: ExAws.Request.Query.response_t
CreateDBInstance
Creates a new DB instance.
Specs:
- create_db_instance!(client :: ExAws.RDS.t, input :: create_db_instance_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_instance/2
but raise on error.
Specs:
- create_db_instance_read_replica(client :: ExAws.RDS.t, input :: create_db_instance_read_replica_message) :: ExAws.Request.Query.response_t
CreateDBInstanceReadReplica
Creates a DB instance for a DB instance running MySQL or PostgreSQL that acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
** The source DB instance must have backup retention enabled.
**
Specs:
- create_db_instance_read_replica!(client :: ExAws.RDS.t, input :: create_db_instance_read_replica_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_instance_read_replica/2
but raise on error.
Specs:
- create_db_parameter_group(client :: ExAws.RDS.t, input :: create_db_parameter_group_message) :: ExAws.Request.Query.response_t
CreateDBParameterGroup
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you’ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
* After you create a DB parameter group, you should wait at least 5
minutes before creating your first DB instance that uses that DB parameter
group as the default parameter group. This allows Amazon RDS to fully
complete the create action before the parameter group is used as the
default for a new DB instance. This is especially important for parameters
that are critical when creating the default database for a DB instance,
such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups
option of the Amazon RDS console or
the DescribeDBParameters* command to verify that your DB parameter group
has been created or modified.
**
Specs:
- create_db_parameter_group!(client :: ExAws.RDS.t, input :: create_db_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_parameter_group/2
but raise on error.
Specs:
- create_db_security_group(client :: ExAws.RDS.t, input :: create_db_security_group_message) :: ExAws.Request.Query.response_t
CreateDBSecurityGroup
Creates a new DB security group. DB security groups control access to a DB instance.
Specs:
- create_db_security_group!(client :: ExAws.RDS.t, input :: create_db_security_group_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_security_group/2
but raise on error.
Specs:
- create_db_snapshot(client :: ExAws.RDS.t, input :: create_db_snapshot_message) :: ExAws.Request.Query.response_t
CreateDBSnapshot
Creates a DBSnapshot. The source DBInstance must be in “available” state.
Specs:
- create_db_snapshot!(client :: ExAws.RDS.t, input :: create_db_snapshot_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_snapshot/2
but raise on error.
Specs:
- create_db_subnet_group(client :: ExAws.RDS.t, input :: create_db_subnet_group_message) :: ExAws.Request.Query.response_t
CreateDBSubnetGroup
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
Specs:
- create_db_subnet_group!(client :: ExAws.RDS.t, input :: create_db_subnet_group_message) :: ExAws.Request.Query.success_t | no_return
Same as create_db_subnet_group/2
but raise on error.
Specs:
- create_event_subscription(client :: ExAws.RDS.t, input :: create_event_subscription_message) :: ExAws.Request.Query.response_t
CreateEventSubscription
Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
Specs:
- create_event_subscription!(client :: ExAws.RDS.t, input :: create_event_subscription_message) :: ExAws.Request.Query.success_t | no_return
Same as create_event_subscription/2
but raise on error.
Specs:
- create_option_group(client :: ExAws.RDS.t, input :: create_option_group_message) :: ExAws.Request.Query.response_t
CreateOptionGroup
Creates a new option group. You can create up to 20 option groups.
Specs:
- create_option_group!(client :: ExAws.RDS.t, input :: create_option_group_message) :: ExAws.Request.Query.success_t | no_return
Same as create_option_group/2
but raise on error.
Specs:
- delete_db_cluster(client :: ExAws.RDS.t, input :: delete_db_cluster_message) :: ExAws.Request.Query.response_t
DeleteDBCluster
The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- delete_db_cluster!(client :: ExAws.RDS.t, input :: delete_db_cluster_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_db_cluster/2
but raise on error.
Specs:
- delete_db_cluster_parameter_group(client :: ExAws.RDS.t, input :: delete_db_cluster_parameter_group_message) :: ExAws.Request.Query.response_t
DeleteDBClusterParameterGroup
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- delete_db_cluster_parameter_group!(client :: ExAws.RDS.t, input :: delete_db_cluster_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_db_cluster_parameter_group/2
but raise on error.
Specs:
- delete_db_cluster_snapshot(client :: ExAws.RDS.t, input :: delete_db_cluster_snapshot_message) :: ExAws.Request.Query.response_t
DeleteDBClusterSnapshot
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
Note:The DB cluster snapshot must be in the available
state to be
deleted. For more information on Amazon Aurora, see Aurora on Amazon
RDS
in the Amazon RDS User Guide.
Specs:
- delete_db_cluster_snapshot!(client :: ExAws.RDS.t, input :: delete_db_cluster_snapshot_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_db_cluster_snapshot/2
but raise on error.
Specs:
- delete_db_instance(client :: ExAws.RDS.t, input :: delete_db_instance_message) :: ExAws.Request.Query.response_t
DeleteDBInstance
The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance will be
“deleting” until the DB snapshot is created. The API action
DescribeDBInstance
is used to monitor the status of this operation. The
action cannot be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of ‘failed’, ‘incompatible-restore’, or ‘incompatible-network’, it can only be deleted when the SkipFinalSnapshot parameter is set to “true”.
Specs:
- delete_db_instance!(client :: ExAws.RDS.t, input :: delete_db_instance_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_db_instance/2
but raise on error.
Specs:
- delete_db_parameter_group(client :: ExAws.RDS.t, input :: delete_db_parameter_group_message) :: ExAws.Request.Query.response_t
DeleteDBParameterGroup
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
Specs:
- delete_db_parameter_group!(client :: ExAws.RDS.t, input :: delete_db_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_db_parameter_group/2
but raise on error.
Specs:
- delete_db_security_group(client :: ExAws.RDS.t, input :: delete_db_security_group_message) :: ExAws.Request.Query.response_t
DeleteDBSecurityGroup
Deletes a DB security group.
Note:The specified DB security group must not be associated with any DB instances.
Specs:
- delete_db_security_group!(client :: ExAws.RDS.t, input :: delete_db_security_group_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_db_security_group/2
but raise on error.
Specs:
- delete_db_snapshot(client :: ExAws.RDS.t, input :: delete_db_snapshot_message) :: ExAws.Request.Query.response_t
DeleteDBSnapshot
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
Note:The DBSnapshot must be in the available
state to be deleted.
Specs:
- delete_db_snapshot!(client :: ExAws.RDS.t, input :: delete_db_snapshot_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_db_snapshot/2
but raise on error.
Specs:
- delete_db_subnet_group(client :: ExAws.RDS.t, input :: delete_db_subnet_group_message) :: ExAws.Request.Query.response_t
DeleteDBSubnetGroup
Deletes a DB subnet group.
Note:The specified database subnet group must not be associated with any DB instances.
Specs:
- delete_db_subnet_group!(client :: ExAws.RDS.t, input :: delete_db_subnet_group_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_db_subnet_group/2
but raise on error.
Specs:
- delete_event_subscription(client :: ExAws.RDS.t, input :: delete_event_subscription_message) :: ExAws.Request.Query.response_t
DeleteEventSubscription
Deletes an RDS event notification subscription.
Specs:
- delete_event_subscription!(client :: ExAws.RDS.t, input :: delete_event_subscription_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_event_subscription/2
but raise on error.
Specs:
- delete_option_group(client :: ExAws.RDS.t, input :: delete_option_group_message) :: ExAws.Request.Query.response_t
DeleteOptionGroup
Deletes an existing option group.
Specs:
- delete_option_group!(client :: ExAws.RDS.t, input :: delete_option_group_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_option_group/2
but raise on error.
Specs:
- describe_account_attributes(client :: ExAws.RDS.t, input :: describe_account_attributes_message) :: ExAws.Request.Query.response_t
DescribeAccountAttributes
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota’s maximum value.
This command does not take any parameters.
Specs:
- describe_account_attributes!(client :: ExAws.RDS.t, input :: describe_account_attributes_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_account_attributes/2
but raise on error.
Specs:
- describe_certificates(client :: ExAws.RDS.t, input :: describe_certificates_message) :: ExAws.Request.Query.response_t
DescribeCertificates
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
Specs:
- describe_certificates!(client :: ExAws.RDS.t, input :: describe_certificates_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_certificates/2
but raise on error.
Specs:
- describe_db_cluster_parameter_groups(client :: ExAws.RDS.t, input :: describe_db_cluster_parameter_groups_message) :: ExAws.Request.Query.response_t
DescribeDBClusterParameterGroups
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
parameter is specified, the list will contain
only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- describe_db_cluster_parameter_groups!(client :: ExAws.RDS.t, input :: describe_db_cluster_parameter_groups_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_cluster_parameter_groups/2
but raise on error.
Specs:
- describe_db_cluster_parameters(client :: ExAws.RDS.t, input :: describe_db_cluster_parameters_message) :: ExAws.Request.Query.response_t
DescribeDBClusterParameters
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- describe_db_cluster_parameters!(client :: ExAws.RDS.t, input :: describe_db_cluster_parameters_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_cluster_parameters/2
but raise on error.
Specs:
- describe_db_cluster_snapshots(client :: ExAws.RDS.t, input :: describe_db_cluster_snapshots_message) :: ExAws.Request.Query.response_t
DescribeDBClusterSnapshots
Returns information about DB cluster snapshots. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- describe_db_cluster_snapshots!(client :: ExAws.RDS.t, input :: describe_db_cluster_snapshots_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_cluster_snapshots/2
but raise on error.
Specs:
- describe_db_clusters(client :: ExAws.RDS.t, input :: describe_db_clusters_message) :: ExAws.Request.Query.response_t
DescribeDBClusters
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- describe_db_clusters!(client :: ExAws.RDS.t, input :: describe_db_clusters_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_clusters/2
but raise on error.
Specs:
- describe_db_engine_versions(client :: ExAws.RDS.t, input :: describe_db_engine_versions_message) :: ExAws.Request.Query.response_t
DescribeDBEngineVersions
Returns a list of the available DB engines.
Specs:
- describe_db_engine_versions!(client :: ExAws.RDS.t, input :: describe_db_engine_versions_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_engine_versions/2
but raise on error.
Specs:
- describe_db_instances(client :: ExAws.RDS.t, input :: describe_db_instances_message) :: ExAws.Request.Query.response_t
DescribeDBInstances
Returns information about provisioned RDS instances. This API supports pagination.
Specs:
- describe_db_instances!(client :: ExAws.RDS.t, input :: describe_db_instances_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_instances/2
but raise on error.
Specs:
- describe_db_log_files(client :: ExAws.RDS.t, input :: describe_db_log_files_message) :: ExAws.Request.Query.response_t
DescribeDBLogFiles
Returns a list of DB log files for the DB instance.
Specs:
- describe_db_log_files!(client :: ExAws.RDS.t, input :: describe_db_log_files_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_log_files/2
but raise on error.
Specs:
- describe_db_parameter_groups(client :: ExAws.RDS.t, input :: describe_db_parameter_groups_message) :: ExAws.Request.Query.response_t
DescribeDBParameterGroups
Returns a list of DBParameterGroup
descriptions. If a
DBParameterGroupName
is specified, the list will contain only the
description of the specified DB parameter group.
Specs:
- describe_db_parameter_groups!(client :: ExAws.RDS.t, input :: describe_db_parameter_groups_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_parameter_groups/2
but raise on error.
Specs:
- describe_db_parameters(client :: ExAws.RDS.t, input :: describe_db_parameters_message) :: ExAws.Request.Query.response_t
DescribeDBParameters
Returns the detailed parameter list for a particular DB parameter group.
Specs:
- describe_db_parameters!(client :: ExAws.RDS.t, input :: describe_db_parameters_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_parameters/2
but raise on error.
Specs:
- describe_db_security_groups(client :: ExAws.RDS.t, input :: describe_db_security_groups_message) :: ExAws.Request.Query.response_t
DescribeDBSecurityGroups
Returns a list of DBSecurityGroup
descriptions. If a
DBSecurityGroupName
is specified, the list will contain only the
descriptions of the specified DB security group.
Specs:
- describe_db_security_groups!(client :: ExAws.RDS.t, input :: describe_db_security_groups_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_security_groups/2
but raise on error.
Specs:
- describe_db_snapshots(client :: ExAws.RDS.t, input :: describe_db_snapshots_message) :: ExAws.Request.Query.response_t
DescribeDBSnapshots
Returns information about DB snapshots. This API supports pagination.
Specs:
- describe_db_snapshots!(client :: ExAws.RDS.t, input :: describe_db_snapshots_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_snapshots/2
but raise on error.
Specs:
- describe_db_subnet_groups(client :: ExAws.RDS.t, input :: describe_db_subnet_groups_message) :: ExAws.Request.Query.response_t
DescribeDBSubnetGroups
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Specs:
- describe_db_subnet_groups!(client :: ExAws.RDS.t, input :: describe_db_subnet_groups_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_db_subnet_groups/2
but raise on error.
Specs:
- describe_engine_default_cluster_parameters(client :: ExAws.RDS.t, input :: describe_engine_default_cluster_parameters_message) :: ExAws.Request.Query.response_t
DescribeEngineDefaultClusterParameters
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- describe_engine_default_cluster_parameters!(client :: ExAws.RDS.t, input :: describe_engine_default_cluster_parameters_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_engine_default_cluster_parameters/2
but raise on error.
Specs:
- describe_engine_default_parameters(client :: ExAws.RDS.t, input :: describe_engine_default_parameters_message) :: ExAws.Request.Query.response_t
DescribeEngineDefaultParameters
Returns the default engine and system parameter information for the specified database engine.
Specs:
- describe_engine_default_parameters!(client :: ExAws.RDS.t, input :: describe_engine_default_parameters_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_engine_default_parameters/2
but raise on error.
Specs:
- describe_event_categories(client :: ExAws.RDS.t, input :: describe_event_categories_message) :: ExAws.Request.Query.response_t
DescribeEventCategories
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
Specs:
- describe_event_categories!(client :: ExAws.RDS.t, input :: describe_event_categories_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_event_categories/2
but raise on error.
Specs:
- describe_event_subscriptions(client :: ExAws.RDS.t, input :: describe_event_subscriptions_message) :: ExAws.Request.Query.response_t
DescribeEventSubscriptions
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
Specs:
- describe_event_subscriptions!(client :: ExAws.RDS.t, input :: describe_event_subscriptions_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_event_subscriptions/2
but raise on error.
Specs:
- describe_events(client :: ExAws.RDS.t, input :: describe_events_message) :: ExAws.Request.Query.response_t
DescribeEvents
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
Specs:
- describe_events!(client :: ExAws.RDS.t, input :: describe_events_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_events/2
but raise on error.
Specs:
- describe_option_group_options(client :: ExAws.RDS.t, input :: describe_option_group_options_message) :: ExAws.Request.Query.response_t
DescribeOptionGroupOptions
Describes all available options.
Specs:
- describe_option_group_options!(client :: ExAws.RDS.t, input :: describe_option_group_options_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_option_group_options/2
but raise on error.
Specs:
- describe_option_groups(client :: ExAws.RDS.t, input :: describe_option_groups_message) :: ExAws.Request.Query.response_t
DescribeOptionGroups
Describes the available option groups.
Specs:
- describe_option_groups!(client :: ExAws.RDS.t, input :: describe_option_groups_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_option_groups/2
but raise on error.
Specs:
- describe_orderable_db_instance_options(client :: ExAws.RDS.t, input :: describe_orderable_db_instance_options_message) :: ExAws.Request.Query.response_t
DescribeOrderableDBInstanceOptions
Returns a list of orderable DB instance options for the specified engine.
Specs:
- describe_orderable_db_instance_options!(client :: ExAws.RDS.t, input :: describe_orderable_db_instance_options_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_orderable_db_instance_options/2
but raise on error.
Specs:
- describe_pending_maintenance_actions(client :: ExAws.RDS.t, input :: describe_pending_maintenance_actions_message) :: ExAws.Request.Query.response_t
DescribePendingMaintenanceActions
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
Specs:
- describe_pending_maintenance_actions!(client :: ExAws.RDS.t, input :: describe_pending_maintenance_actions_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_pending_maintenance_actions/2
but raise on error.
Specs:
- describe_reserved_db_instances(client :: ExAws.RDS.t, input :: describe_reserved_db_instances_message) :: ExAws.Request.Query.response_t
DescribeReservedDBInstances
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
Specs:
- describe_reserved_db_instances!(client :: ExAws.RDS.t, input :: describe_reserved_db_instances_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_reserved_db_instances/2
but raise on error.
Specs:
- describe_reserved_db_instances_offerings(client :: ExAws.RDS.t, input :: describe_reserved_db_instances_offerings_message) :: ExAws.Request.Query.response_t
DescribeReservedDBInstancesOfferings
Lists available reserved DB instance offerings.
Specs:
- describe_reserved_db_instances_offerings!(client :: ExAws.RDS.t, input :: describe_reserved_db_instances_offerings_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_reserved_db_instances_offerings/2
but raise on error.
Specs:
- download_db_log_file_portion(client :: ExAws.RDS.t, input :: download_db_log_file_portion_message) :: ExAws.Request.Query.response_t
DownloadDBLogFilePortion
Downloads all or a portion of the specified log file, up to 1 MB in size.
Specs:
- download_db_log_file_portion!(client :: ExAws.RDS.t, input :: download_db_log_file_portion_message) :: ExAws.Request.Query.success_t | no_return
Same as download_db_log_file_portion/2
but raise on error.
Specs:
- failover_db_cluster(client :: ExAws.RDS.t, input :: failover_db_cluster_message) :: ExAws.Request.Query.response_t
FailoverDBCluster
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.
Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- failover_db_cluster!(client :: ExAws.RDS.t, input :: failover_db_cluster_message) :: ExAws.Request.Query.success_t | no_return
Same as failover_db_cluster/2
but raise on error.
Specs:
- list_tags_for_resource(client :: ExAws.RDS.t, input :: list_tags_for_resource_message) :: ExAws.Request.Query.response_t
ListTagsForResource
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
Specs:
- list_tags_for_resource!(client :: ExAws.RDS.t, input :: list_tags_for_resource_message) :: ExAws.Request.Query.success_t | no_return
Same as list_tags_for_resource/2
but raise on error.
Specs:
- modify_db_cluster(client :: ExAws.RDS.t, input :: modify_db_cluster_message) :: ExAws.Request.Query.response_t
ModifyDBCluster
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- modify_db_cluster!(client :: ExAws.RDS.t, input :: modify_db_cluster_message) :: ExAws.Request.Query.success_t | no_return
Same as modify_db_cluster/2
but raise on error.
Specs:
- modify_db_cluster_parameter_group(client :: ExAws.RDS.t, input :: modify_db_cluster_parameter_group_message) :: ExAws.Request.Query.response_t
ModifyDBClusterParameterGroup
Modifies the parameters of a DB cluster parameter group. To modify more
than one parameter, submit a list of the following: ParameterName
,
ParameterValue
, and ApplyMethod
. A maximum of 20 parameters can be
modified in a single request.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Note: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
* After you create a DB cluster parameter group, you should wait at least
5 minutes before creating your first DB cluster that uses that DB cluster
parameter group as the default parameter group. This allows Amazon RDS to
fully complete the create action before the parameter group is used as the
default for a new DB cluster. This is especially important for parameters
that are critical when creating the default database for a DB cluster, such
as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups*
option of the Amazon RDS console or
the DescribeDBClusterParameters
command to verify that your DB cluster
parameter group has been created or modified.
**
Specs:
- modify_db_cluster_parameter_group!(client :: ExAws.RDS.t, input :: modify_db_cluster_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as modify_db_cluster_parameter_group/2
but raise on error.
Specs:
- modify_db_instance(client :: ExAws.RDS.t, input :: modify_db_instance_message) :: ExAws.Request.Query.response_t
ModifyDBInstance
Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
Specs:
- modify_db_instance!(client :: ExAws.RDS.t, input :: modify_db_instance_message) :: ExAws.Request.Query.success_t | no_return
Same as modify_db_instance/2
but raise on error.
Specs:
- modify_db_parameter_group(client :: ExAws.RDS.t, input :: modify_db_parameter_group_message) :: ExAws.Request.Query.response_t
ModifyDBParameterGroup
Modifies the parameters of a DB parameter group. To modify more than one
parameter, submit a list of the following: ParameterName
,
ParameterValue
, and ApplyMethod
. A maximum of 20 parameters can be
modified in a single request.
Note: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
* After you modify a DB parameter group, you should wait at least 5
minutes before creating your first DB instance that uses that DB parameter
group as the default parameter group. This allows Amazon RDS to fully
complete the modify action before the parameter group is used as the
default for a new DB instance. This is especially important for parameters
that are critical when creating the default database for a DB instance,
such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups
option of the Amazon RDS console or
the DescribeDBParameters* command to verify that your DB parameter group
has been created or modified.
**
Specs:
- modify_db_parameter_group!(client :: ExAws.RDS.t, input :: modify_db_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as modify_db_parameter_group/2
but raise on error.
Specs:
- modify_db_subnet_group(client :: ExAws.RDS.t, input :: modify_db_subnet_group_message) :: ExAws.Request.Query.response_t
ModifyDBSubnetGroup
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
Specs:
- modify_db_subnet_group!(client :: ExAws.RDS.t, input :: modify_db_subnet_group_message) :: ExAws.Request.Query.success_t | no_return
Same as modify_db_subnet_group/2
but raise on error.
Specs:
- modify_event_subscription(client :: ExAws.RDS.t, input :: modify_event_subscription_message) :: ExAws.Request.Query.response_t
ModifyEventSubscription
Modifies an existing RDS event notification subscription. Note that you
cannot modify the source identifiers using this call; to change source
identifiers for a subscription, use the AddSourceIdentifierToSubscription
and RemoveSourceIdentifierFromSubscription
calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
Specs:
- modify_event_subscription!(client :: ExAws.RDS.t, input :: modify_event_subscription_message) :: ExAws.Request.Query.success_t | no_return
Same as modify_event_subscription/2
but raise on error.
Specs:
- modify_option_group(client :: ExAws.RDS.t, input :: modify_option_group_message) :: ExAws.Request.Query.response_t
ModifyOptionGroup
Modifies an existing option group.
Specs:
- modify_option_group!(client :: ExAws.RDS.t, input :: modify_option_group_message) :: ExAws.Request.Query.success_t | no_return
Same as modify_option_group/2
but raise on error.
Specs:
- promote_read_replica(client :: ExAws.RDS.t, input :: promote_read_replica_message) :: ExAws.Request.Query.response_t
PromoteReadReplica
Promotes a Read Replica DB instance to a standalone DB instance.
Note: We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
Specs:
- promote_read_replica!(client :: ExAws.RDS.t, input :: promote_read_replica_message) :: ExAws.Request.Query.success_t | no_return
Same as promote_read_replica/2
but raise on error.
Specs:
- purchase_reserved_db_instances_offering(client :: ExAws.RDS.t, input :: purchase_reserved_db_instances_offering_message) :: ExAws.Request.Query.response_t
PurchaseReservedDBInstancesOffering
Purchases a reserved DB instance offering.
Specs:
- purchase_reserved_db_instances_offering!(client :: ExAws.RDS.t, input :: purchase_reserved_db_instances_offering_message) :: ExAws.Request.Query.success_t | no_return
Same as purchase_reserved_db_instances_offering/2
but raise on error.
Specs:
- reboot_db_instance(client :: ExAws.RDS.t, input :: reboot_db_instance_message) :: ExAws.Request.Query.response_t
RebootDBInstance
Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine’s crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
Specs:
- reboot_db_instance!(client :: ExAws.RDS.t, input :: reboot_db_instance_message) :: ExAws.Request.Query.success_t | no_return
Same as reboot_db_instance/2
but raise on error.
Specs:
- remove_source_identifier_from_subscription(client :: ExAws.RDS.t, input :: remove_source_identifier_from_subscription_message) :: ExAws.Request.Query.response_t
RemoveSourceIdentifierFromSubscription
Removes a source identifier from an existing RDS event notification subscription.
Specs:
- remove_source_identifier_from_subscription!(client :: ExAws.RDS.t, input :: remove_source_identifier_from_subscription_message) :: ExAws.Request.Query.success_t | no_return
Same as remove_source_identifier_from_subscription/2
but raise on error.
Specs:
- remove_tags_from_resource(client :: ExAws.RDS.t, input :: remove_tags_from_resource_message) :: ExAws.Request.Query.response_t
RemoveTagsFromResource
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
Specs:
- remove_tags_from_resource!(client :: ExAws.RDS.t, input :: remove_tags_from_resource_message) :: ExAws.Request.Query.success_t | no_return
Same as remove_tags_from_resource/2
but raise on error.
Specs:
- reset_db_cluster_parameter_group(client :: ExAws.RDS.t, input :: reset_db_cluster_parameter_group_message) :: ExAws.Request.Query.response_t
ResetDBClusterParameterGroup
Modifies the parameters of a DB cluster parameter group to the default
value. To reset specific parameters submit a list of the following:
ParameterName
and ApplyMethod
. To reset the entire DB cluster parameter
group, specify the DBClusterParameterGroupName
and ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated immediately
and static parameters are set to pending-reboot
to take effect on the
next DB instance restart or RebootDBInstance
request. You must call
RebootDBInstance
for every DB instance in your DB cluster that you want
the updated static parameter to apply to.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- reset_db_cluster_parameter_group!(client :: ExAws.RDS.t, input :: reset_db_cluster_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as reset_db_cluster_parameter_group/2
but raise on error.
Specs:
- reset_db_parameter_group(client :: ExAws.RDS.t, input :: reset_db_parameter_group_message) :: ExAws.Request.Query.response_t
ResetDBParameterGroup
Modifies the parameters of a DB parameter group to the engine/system
default value. To reset specific parameters submit a list of the following:
ParameterName
and ApplyMethod
. To reset the entire DB parameter group,
specify the DBParameterGroup
name and ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated immediately
and static parameters are set to pending-reboot
to take effect on the
next DB instance restart or RebootDBInstance
request.
Specs:
- reset_db_parameter_group!(client :: ExAws.RDS.t, input :: reset_db_parameter_group_message) :: ExAws.Request.Query.success_t | no_return
Same as reset_db_parameter_group/2
but raise on error.
Specs:
- restore_db_cluster_from_snapshot(client :: ExAws.RDS.t, input :: restore_db_cluster_from_snapshot_message) :: ExAws.Request.Query.response_t
RestoreDBClusterFromSnapshot
Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- restore_db_cluster_from_snapshot!(client :: ExAws.RDS.t, input :: restore_db_cluster_from_snapshot_message) :: ExAws.Request.Query.success_t | no_return
Same as restore_db_cluster_from_snapshot/2
but raise on error.
Specs:
- restore_db_cluster_to_point_in_time(client :: ExAws.RDS.t, input :: restore_db_cluster_to_point_in_time_message) :: ExAws.Request.Query.response_t
RestoreDBClusterToPointInTime
Restores a DB cluster to an arbitrary point in time. Users can restore to
any point in time before LatestRestorableTime
for up to
BackupRetentionPeriod
days. The target DB cluster is created from the
source DB cluster with the same configuration as the original DB cluster,
except that the new DB cluster is created with the default DB security
group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Specs:
- restore_db_cluster_to_point_in_time!(client :: ExAws.RDS.t, input :: restore_db_cluster_to_point_in_time_message) :: ExAws.Request.Query.success_t | no_return
Same as restore_db_cluster_to_point_in_time/2
but raise on error.
Specs:
- restore_db_instance_from_db_snapshot(client :: ExAws.RDS.t, input :: restore_db_instance_from_db_snapshot_message) :: ExAws.Request.Query.response_t
RestoreDBInstanceFromDBSnapshot
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
Specs:
- restore_db_instance_from_db_snapshot!(client :: ExAws.RDS.t, input :: restore_db_instance_from_db_snapshot_message) :: ExAws.Request.Query.success_t | no_return
Same as restore_db_instance_from_db_snapshot/2
but raise on error.
Specs:
- restore_db_instance_to_point_in_time(client :: ExAws.RDS.t, input :: restore_db_instance_to_point_in_time_message) :: ExAws.Request.Query.response_t
RestoreDBInstanceToPointInTime
Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
Specs:
- restore_db_instance_to_point_in_time!(client :: ExAws.RDS.t, input :: restore_db_instance_to_point_in_time_message) :: ExAws.Request.Query.success_t | no_return
Same as restore_db_instance_to_point_in_time/2
but raise on error.
Specs:
- revoke_db_security_group_ingress(client :: ExAws.RDS.t, input :: revoke_db_security_group_ingress_message) :: ExAws.Request.Query.response_t
RevokeDBSecurityGroupIngress
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
Specs:
- revoke_db_security_group_ingress!(client :: ExAws.RDS.t, input :: revoke_db_security_group_ingress_message) :: ExAws.Request.Query.success_t | no_return
Same as revoke_db_security_group_ingress/2
but raise on error.