ex_aws_rds v2.0.1 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
Creates a new DB instance
Deletes a DB instance
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
Generates an auth token used to connect to a db with IAM credentials. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.html
Modify settings for a DB instance
Reboots a DB instance
Link to this section Types
apply_pending_maintenance_actions() :: :system_upgrade | :db_upgrade
apply_pending_maintenance_opt_in_types() :: :immediate | :next_maintenance | :undo_opt_in
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()]}, ...]]
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]
delete_db_instance_opts() :: [final_db_snapshot_identifier: binary(), skip_final_snapshot: boolean()]
describe_db_instances_opts() :: [{:db_instance_identifier, binary()} | [{:filter_member_1, filter()}, ...] | {:marker, binary()} | {:max_records, 20..100}]
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()}]
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()]}, ...]]
postgres_sql_allowed_storage() :: 5..6144
reboot_db_instance_opts() :: [{:force_failover, boolean()}]
Link to this section Functions
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.
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.
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.
delete_db_instance(instance_id :: binary(), opts :: delete_db_instance_opts()) :: ExAws.Operation.RestQuery.t()
Deletes a DB instance.
describe_db_instances(opts :: describe_db_instances_opts()) :: ExAws.Operation.RestQuery.t()
Returns information about provisioned RDS instances.
describe_events(opts :: describe_db_instances_opts()) :: ExAws.Operation.RestQuery.t()
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.
generate_db_auth_token(hostname :: binary(), username :: binary(), port :: integer(), config :: map()) :: binary()
Generates an auth token used to connect to a db with IAM credentials. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.html
modify_db_instance(instance_id :: binary(), opts :: modify_db_instance_opts()) :: ExAws.Operation.RestQuery.t()
Modify settings for a DB instance.
reboot_db_instance(instance_id :: binary(), opts :: reboot_db_instance_opts()) :: ExAws.Operation.RestQuery.t()
Reboots a DB instance.