ExAws v1.1.4 ExAws.RDS View Source

Operations on AWS RDS

Link to this section Summary

Functions

Adds a source identifier to an existing RDS event notification subscription

Applies a pending maintenance action to a resource

Returns information about provisioned RDS instances

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days

Modify settings for a DB instance

Link to this section Types

Link to this type amazon_aurora_port_rage() View Source
amazon_aurora_port_rage() :: 1150..65535
Link to this type apply_pending_maintenance_actions() View Source
apply_pending_maintenance_actions() :: :system_upgrade | :db_upgrade
Link to this type apply_pending_maintenance_opt_in_types() View Source
apply_pending_maintenance_opt_in_types ::
  :immediate |
  :next_maintenance |
  :undo_opt_in
Link to this type create_db_instance_opts() View Source
create_db_instance_opts() :: [{:auto_minor_version_upgrade, boolean} | {:availability_zone, binary} | {:backup_retention_period, integer} | {:character_set_name, binary} | {:copy_tags_to_snapshot, boolean} | {:db_cluster_identifier, binary} | {:db_name, binary} | {:db_parameter_group_name, binary} | [{:db_security_groups_member_1, [binary]}, ...] | {:db_subnet_group_name, binary} | {:domain, binary} | {:domain_iam_role_name, binary} | {:engine_version, binary} | {:iops, integer} | {:kms_key_id, binary} | {:license_model, :license_included | :bring_your_own_license | :general_public_license} | {:monitoring_interval, 0 | 1 | 5 | 10 | 15 | 30 | 60} | {:monitoring_role_arn, binary} | {:multi_az, boolean} | {:option_group_name, binary} | {:port, mysql_port_range | maria_db_port_range | postgres_sql_port_range | oracle_port_range | sql_server_port_range | amazon_aurora_port_rage} | {:preferred_backup_window, binary} | {:preferred_maintenance_window, binary} | {:promotion_tier, 0..15} | {:publicly_accessible, boolean} | {:storage_encrypted, boolean} | {:storage_type, :standard | :gp2 | :io1} | [{:tags_member_1, [tag]}, ...] | {:tde_credential_arn, binary} | {:tde_credential_password, binary} | [{:vpc_security_group_ids_member_1, [binary]}, ...]]
Link to this type db_instance_classes() View Source
db_instance_classes() :: [:db_t1_micro | :db_m1_small | :db_m1_medium | :db_m1_large | :db_m1_xlarge | :db_m2_xlarge | :db_m2_2xlarge | :db_m2_4xlarge | :db_m3_medium | :db_m3_large | :db_m3_xlarge | :db_m3_2xlarge | :db_m4_large | :db_m4_xlarge | :db_m4_2xlarge | :db_m4_4xlarge | :db_m4_10xlarge | :db_r3_large | :db_r3_xlarge | :db_r3_2xlarge | :db_r3_4xlarge | :db_r3_8xlarge | :db_t2_micro | :db_t2_small | :db_t2_medium | :db_t2_large]
Link to this type delete_db_instance_opts() View Source
delete_db_instance_opts() :: [final_db_snapshot_identifier: binary, skip_final_snapshot: boolean]
Link to this type describe_db_instances_opts() View Source
describe_db_instances_opts() :: [{:db_instance_identifier, binary} | [{:filter_member_1, filter}, ...] | {:marker, binary} | {:max_records, 20..100}]
Link to this type describe_events_opts() View Source
describe_events_opts() :: [{:duration, integer} | {:end_time, binary} | [{:event_categories_member_1, [binary]}, ...] | [{:filter_member_1, filter}, ...] | {:marker, binary} | {:max_records, 20..100} | {:source_identifier, binary} | {:source_type, :db_instance | :db_parameter_group | :db_security_group | :db_snapshot | :db_cluster | :db_cluster_snapsot} | {:start_time, binary}]
Link to this type filter() View Source
filter() :: {name :: binary, values :: [binary]}
Link to this type maria_db_allowed_storage() View Source
maria_db_allowed_storage() :: 5..6144
Link to this type maria_db_port_range() View Source
maria_db_port_range() :: 1150..65535
Link to this type modify_db_instance_opts() View Source
modify_db_instance_opts() :: [{:allocated_storage, mysql_allowed_storage | maria_db_allowed_storage | postgres_sql_allowed_storage | oracle_allowed_storage} | {:allow_major_version_upgrade, boolean} | {:apply_immediately, boolean} | {:auto_minor_version_upgrade, boolean} | {:backup_retention_period, integer} | {:ca_certificate_identifier, binary} | {:copy_tags_to_snapshot, boolean} | {:db_instance_class, db_instance_classes} | {:db_parameter_group_name, binary} | {:db_port_number, mysql_port_range | maria_db_port_range | postgres_sql_port_range | oracle_port_range | sql_server_port_range} | [{:sb_security_groups_member_1, [binary]}, ...] | {:domain, binary} | {:domain_iam_role_name, binary} | {:engine_version, binary} | {:iops, integer} | {:master_user_password, binary} | {:monitoring_interval, 0 | 1 | 5 | 10 | 15 | 30 | 60} | {:monitoring_role_arn, binary} | {:multi_az, boolean} | {:new_db_instance_identifier, binary} | {:option_group_name, binary} | {:preferred_backup_window, binary} | {:preferred_maintenance_window, binary} | {:promotion_tier, 0..15} | {:publicly_accessible, boolean} | {:storage_type, :standard | :gp2 | :io1} | {:tde_credential_arn, binary} | {:tde_credential_password, binary} | [{:vpc_security_group_ids_member_1, [binary]}, ...]]
Link to this type mysql_allowed_storage() View Source
mysql_allowed_storage() :: 5..6144
Link to this type mysql_port_range() View Source
mysql_port_range() :: 1150..65535
Link to this type oracle_allowed_storage() View Source
oracle_allowed_storage() :: 10..6144
Link to this type oracle_port_range() View Source
oracle_port_range() :: 1150..65535
Link to this type postgres_sql_allowed_storage() View Source
postgres_sql_allowed_storage() :: 5..6144
Link to this type postgres_sql_port_range() View Source
postgres_sql_port_range() :: 1150..65535
Link to this type reboot_db_instance_opts() View Source
reboot_db_instance_opts() :: [{:force_failover, boolean}]
Link to this type sql_server_port_range() View Source
sql_server_port_range() :: 1150..65535
Link to this type tag() View Source
tag() :: {key :: binary, value :: binary}

Link to this section Functions

Link to this function add_source_id_to_subscription(source_id, subscription) View Source
add_source_id_to_subscription(source_id :: binary, subscription :: binary) :: ExAws.Operation.RestQuery.t

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

Link to this function add_tags_to_resource(resource, tags) View Source
Link to this function apply_pending_maintenance(resource_id, action, opt_in_type) View Source
apply_pending_maintenance(resource_id :: binary, action :: apply_pending_maintenance_actions, opt_in_type :: apply_pending_maintenance_opt_in_types) :: ExAws.Operation.RestQuery.t

Applies a pending maintenance action to a resource.

Link to this function create_db_instance(instance_id, username, password, storage, class, engine, opts \\ []) View Source
create_db_instance(instance_id :: binary, username :: binary, password :: binary, storage :: integer, class :: binary, engine :: binary, opts :: create_db_instance_opts) :: ExAws.Operation.RestQuery.t

Creates a new DB instance.

Link to this function delete_db_instance(instance_id, opts \\ []) View Source
delete_db_instance(instance_id :: binary, opts :: delete_db_instance_opts) :: ExAws.Operation.RestQuery.t

Deletes a DB instance.

Link to this function describe_db_instances(opts \\ []) View Source
describe_db_instances(opts :: describe_db_instances_opts) :: ExAws.Operation.RestQuery.t

Returns information about provisioned RDS instances.

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.

Link to this function modify_db_instance(instance_id, opts \\ []) View Source
modify_db_instance(instance_id :: binary, opts :: modify_db_instance_opts) :: ExAws.Operation.RestQuery.t

Modify settings for a DB instance.

Link to this function reboot_db_instance(instance_id, opts \\ []) View Source
reboot_db_instance(instance_id :: binary, opts :: reboot_db_instance_opts) :: ExAws.Operation.RestQuery.t

Reboots a DB instance.