class Aws::DocDB::Client
def add_tags_to_resource(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
add_tags_to_resource(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddTagsToResource - AWS API Documentation
Other tags:
- Example: Request syntax with placeholder values -
Returns:
-
(Struct)- Returns an empty {Seahorse::Client::Response response}.
Options Hash:
(**params)-
:tags(required, Array) -- -
:resource_name(required, String) --
def add_tags_to_resource(params = {}, options = {}) req = build_request(:add_tags_to_resource, params) req.send_request(options) end
def apply_pending_maintenance_action(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
apply_pending_maintenance_action(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ApplyPendingMaintenanceAction - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ApplyPendingMaintenanceActionResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:opt_in_type(required, String) -- -
:apply_action(required, String) -- -
:resource_identifier(required, String) --
def apply_pending_maintenance_action(params = {}, options = {}) req = build_request(:apply_pending_maintenance_action, params) req.send_request(options) end
def build_request(operation_name, params = {})
- Api: - private
Parameters:
-
params({}) --
def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-docdb' context[:gem_version] = '1.2.0' Seahorse::Client::Request.new(handlers, context) end
def copy_db_cluster_parameter_group(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
copy_db_cluster_parameter_group(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CopyDBClusterParameterGroupResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:tags(Array) -- -
:target_db_cluster_parameter_group_description(required, String) -- -
:target_db_cluster_parameter_group_identifier(required, String) -- -
:source_db_cluster_parameter_group_identifier(required, String) --
def copy_db_cluster_parameter_group(params = {}, options = {}) req = build_request(:copy_db_cluster_parameter_group, params) req.send_request(options) end
def copy_db_cluster_snapshot(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
copy_db_cluster_snapshot(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshot - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CopyDBClusterSnapshotResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:tags(Array) -- -
:copy_tags(Boolean) -- -
:pre_signed_url(String) -- -
:kms_key_id(String) -- -
:target_db_cluster_snapshot_identifier(required, String) -- -
:source_db_cluster_snapshot_identifier(required, String) --
def copy_db_cluster_snapshot(params = {}, options = {}) req = build_request(:copy_db_cluster_snapshot, params) req.send_request(options) end
def create_db_cluster(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
create_db_cluster(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBCluster - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CreateDBClusterResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:enable_cloudwatch_logs_exports(Array) -- -
:kms_key_id(String) -- -
:storage_encrypted(Boolean) -- -
:tags(Array) -- -
:preferred_maintenance_window(String) -- -
:preferred_backup_window(String) -- -
:master_user_password(String) -- -
:master_username(String) -- -
:port(Integer) -- -
:engine_version(String) -- -
:engine(required, String) -- -
:db_subnet_group_name(String) -- -
:vpc_security_group_ids(Array) -- -
:db_cluster_parameter_group_name(String) -- -
:db_cluster_identifier(required, String) -- -
:backup_retention_period(Integer) -- -
:availability_zones(Array) --
def create_db_cluster(params = {}, options = {}) req = build_request(:create_db_cluster, params) req.send_request(options) end
def create_db_cluster_parameter_group(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
create_db_cluster_parameter_group(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CreateDBClusterParameterGroupResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:tags(Array) -- -
:description(required, String) -- -
:db_parameter_group_family(required, String) -- -
:db_cluster_parameter_group_name(required, String) --
def create_db_cluster_parameter_group(params = {}, options = {}) req = build_request(:create_db_cluster_parameter_group, params) req.send_request(options) end
def create_db_cluster_snapshot(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
create_db_cluster_snapshot(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshot - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CreateDBClusterSnapshotResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:tags(Array) -- -
:db_cluster_identifier(required, String) -- -
:db_cluster_snapshot_identifier(required, String) --
def create_db_cluster_snapshot(params = {}, options = {}) req = build_request(:create_db_cluster_snapshot, params) req.send_request(options) end
def create_db_instance(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
create_db_instance(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstance - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CreateDBInstanceResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:promotion_tier(Integer) -- -
:db_cluster_identifier(required, String) -- -
:tags(Array) -- -
:auto_minor_version_upgrade(Boolean) -- -
:preferred_maintenance_window(String) -- -
:availability_zone(String) -- -
:engine(required, String) -- -
:db_instance_class(required, String) -- -
:db_instance_identifier(required, String) --
def create_db_instance(params = {}, options = {}) req = build_request(:create_db_instance, params) req.send_request(options) end
def create_db_subnet_group(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
create_db_subnet_group(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CreateDBSubnetGroupResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:tags(Array) -- -
:subnet_ids(required, Array) -- -
:db_subnet_group_description(required, String) -- -
:db_subnet_group_name(required, String) --
def create_db_subnet_group(params = {}, options = {}) req = build_request(:create_db_subnet_group, params) req.send_request(options) end
def delete_db_cluster(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_db_cluster(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBCluster - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DeleteDBClusterResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:final_db_snapshot_identifier(String) -- -
:skip_final_snapshot(Boolean) -- -
:db_cluster_identifier(required, String) --
def delete_db_cluster(params = {}, options = {}) req = build_request(:delete_db_cluster, params) req.send_request(options) end
def delete_db_cluster_parameter_group(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_db_cluster_parameter_group(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterParameterGroup - AWS API Documentation
Other tags:
- Example: Request syntax with placeholder values -
Returns:
-
(Struct)- Returns an empty {Seahorse::Client::Response response}.
Options Hash:
(**params)-
:db_cluster_parameter_group_name(required, String) --
def delete_db_cluster_parameter_group(params = {}, options = {}) req = build_request(:delete_db_cluster_parameter_group, params) req.send_request(options) end
def delete_db_cluster_snapshot(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_db_cluster_snapshot(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshot - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DeleteDBClusterSnapshotResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:db_cluster_snapshot_identifier(required, String) --
def delete_db_cluster_snapshot(params = {}, options = {}) req = build_request(:delete_db_cluster_snapshot, params) req.send_request(options) end
def delete_db_instance(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_db_instance(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstance - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DeleteDBInstanceResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:db_instance_identifier(required, String) --
def delete_db_instance(params = {}, options = {}) req = build_request(:delete_db_instance, params) req.send_request(options) end
def delete_db_subnet_group(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_db_subnet_group(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBSubnetGroup - AWS API Documentation
Other tags:
- Example: Request syntax with placeholder values -
Returns:
-
(Struct)- Returns an empty {Seahorse::Client::Response response}.
Options Hash:
(**params)-
:db_subnet_group_name(required, String) --
def delete_db_subnet_group(params = {}, options = {}) req = build_request(:delete_db_subnet_group, params) req.send_request(options) end
def describe_db_cluster_parameter_groups(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_db_cluster_parameter_groups(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameterGroups - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBClusterParameterGroupsMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:db_cluster_parameter_group_name(String) --
def describe_db_cluster_parameter_groups(params = {}, options = {}) req = build_request(:describe_db_cluster_parameter_groups, params) req.send_request(options) end
def describe_db_cluster_parameters(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_db_cluster_parameters(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameters - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBClusterParameterGroupDetails)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:source(String) -- -
:db_cluster_parameter_group_name(required, String) --
def describe_db_cluster_parameters(params = {}, options = {}) req = build_request(:describe_db_cluster_parameters, params) req.send_request(options) end
def describe_db_cluster_snapshot_attributes(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_db_cluster_snapshot_attributes(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeDBClusterSnapshotAttributesResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:db_cluster_snapshot_identifier(required, String) --
def describe_db_cluster_snapshot_attributes(params = {}, options = {}) req = build_request(:describe_db_cluster_snapshot_attributes, params) req.send_request(options) end
def describe_db_cluster_snapshots(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_db_cluster_snapshots(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshots - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBClusterSnapshotMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:include_public(Boolean) -- -
:include_shared(Boolean) -- -
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:snapshot_type(String) -- -
:db_cluster_snapshot_identifier(String) -- -
:db_cluster_identifier(String) --
def describe_db_cluster_snapshots(params = {}, options = {}) req = build_request(:describe_db_cluster_snapshots, params) req.send_request(options) end
def describe_db_clusters(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_db_clusters(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusters - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBClusterMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:db_cluster_identifier(String) --
def describe_db_clusters(params = {}, options = {}) req = build_request(:describe_db_clusters, params) req.send_request(options) end
def describe_db_engine_versions(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_db_engine_versions(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBEngineVersions - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBEngineVersionMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:list_supported_timezones(Boolean) -- -
:list_supported_character_sets(Boolean) -- -
:default_only(Boolean) -- -
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:db_parameter_group_family(String) -- -
:engine_version(String) -- -
:engine(String) --
def describe_db_engine_versions(params = {}, options = {}) req = build_request(:describe_db_engine_versions, params) req.send_request(options) end
def describe_db_instances(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_db_instances(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBInstances - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBInstanceMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:db_instance_identifier(String) --
def describe_db_instances(params = {}, options = {}) req = build_request(:describe_db_instances, params) req.send_request(options) end
def describe_db_subnet_groups(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_db_subnet_groups(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBSubnetGroups - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBSubnetGroupMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:db_subnet_group_name(String) --
def describe_db_subnet_groups(params = {}, options = {}) req = build_request(:describe_db_subnet_groups, params) req.send_request(options) end
def describe_engine_default_cluster_parameters(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_engine_default_cluster_parameters(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEngineDefaultClusterParameters - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeEngineDefaultClusterParametersResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:db_parameter_group_family(required, String) --
def describe_engine_default_cluster_parameters(params = {}, options = {}) req = build_request(:describe_engine_default_cluster_parameters, params) req.send_request(options) end
def describe_event_categories(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_event_categories(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventCategories - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::EventCategoriesMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:filters(Array) -- -
:source_type(String) --
def describe_event_categories(params = {}, options = {}) req = build_request(:describe_event_categories, params) req.send_request(options) end
def describe_events(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_events(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEvents - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::EventsMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:event_categories(Array) -- -
:duration(Integer) -- -
:end_time(Time, DateTime, Date, Integer, String) -- -
:start_time(Time, DateTime, Date, Integer, String) -- -
:source_type(String) -- -
:source_identifier(String) --
def describe_events(params = {}, options = {}) req = build_request(:describe_events, params) req.send_request(options) end
def describe_orderable_db_instance_options(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_orderable_db_instance_options(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeOrderableDBInstanceOptions - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::OrderableDBInstanceOptionsMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:marker(String) -- -
:max_records(Integer) -- -
:filters(Array) -- -
:vpc(Boolean) -- -
:license_model(String) -- -
:db_instance_class(String) -- -
:engine_version(String) -- -
:engine(required, String) --
def describe_orderable_db_instance_options(params = {}, options = {}) req = build_request(:describe_orderable_db_instance_options, params) req.send_request(options) end
def describe_pending_maintenance_actions(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_pending_maintenance_actions(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribePendingMaintenanceActions - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::PendingMaintenanceActionsMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:max_records(Integer) -- -
:marker(String) -- -
:filters(Array) -- -
:resource_identifier(String) --
def describe_pending_maintenance_actions(params = {}, options = {}) req = build_request(:describe_pending_maintenance_actions, params) req.send_request(options) end
def errors_module
- Api: - private
def errors_module Errors end
def failover_db_cluster(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
failover_db_cluster(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBCluster - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::FailoverDBClusterResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:target_db_instance_identifier(String) -- -
:db_cluster_identifier(String) --
def failover_db_cluster(params = {}, options = {}) req = build_request(:failover_db_cluster, params) req.send_request(options) end
def initialize(*args)
(**options)-
:validate_params(Boolean) -- -
:stub_responses(Boolean) -- -
:session_token(String) -- -
:secret_access_key(String) -- -
:retry_max_delay(Integer) -- -
:retry_limit(Integer) -- -
:retry_jitter(Symbol) -- -
:retry_base_delay(Float) -- -
:profile(String) -- -
:logger(Logger) -- -
:log_level(Symbol) -- -
:log_formatter(Aws::Log::Formatter) -- -
:endpoint_discovery(Boolean) -- -
:endpoint_cache_poll_interval(Integer) -- -
:endpoint_cache_max_threads(Integer) -- -
:endpoint_cache_max_entries(Integer) -- -
:endpoint(String) -- -
:disable_host_prefix_injection(Boolean) -- -
:convert_params(Boolean) -- -
:client_side_monitoring_publisher(Aws::ClientSideMonitoring::Publisher) -- -
:client_side_monitoring_port(Integer) -- -
:client_side_monitoring_client_id(String) -- -
:client_side_monitoring(Boolean) -- -
:active_endpoint_cache(Boolean) -- -
:access_key_id(String) -- -
:region(required, String) -- -
:credentials(required, Aws::CredentialProvider) --
Other tags:
- See: https://www.awsarchitectureblog.com/2015/03/backoff.html -
Parameters:
-
options(Hash) --
Overloads:
-
initialize(options)
def initialize(*args) super end
def list_tags_for_resource(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
list_tags_for_resource(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ListTagsForResource - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::TagListMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:filters(Array) -- -
:resource_name(required, String) --
def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end
def modify_db_cluster(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
modify_db_cluster(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBCluster - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ModifyDBClusterResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:engine_version(String) -- -
:cloudwatch_logs_export_configuration(Types::CloudwatchLogsExportConfiguration) -- -
:preferred_maintenance_window(String) -- -
:preferred_backup_window(String) -- -
:master_user_password(String) -- -
:port(Integer) -- -
:vpc_security_group_ids(Array) -- -
:db_cluster_parameter_group_name(String) -- -
:backup_retention_period(Integer) -- -
:apply_immediately(Boolean) -- -
:new_db_cluster_identifier(String) -- -
:db_cluster_identifier(required, String) --
def modify_db_cluster(params = {}, options = {}) req = build_request(:modify_db_cluster, params) req.send_request(options) end
def modify_db_cluster_parameter_group(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
modify_db_cluster_parameter_group(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterParameterGroup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBClusterParameterGroupNameMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:parameters(required, Array) -- -
:db_cluster_parameter_group_name(required, String) --
def modify_db_cluster_parameter_group(params = {}, options = {}) req = build_request(:modify_db_cluster_parameter_group, params) req.send_request(options) end
def modify_db_cluster_snapshot_attribute(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
modify_db_cluster_snapshot_attribute(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ModifyDBClusterSnapshotAttributeResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:values_to_remove(Array) -- -
:values_to_add(Array) -- -
:attribute_name(required, String) -- -
:db_cluster_snapshot_identifier(required, String) --
def modify_db_cluster_snapshot_attribute(params = {}, options = {}) req = build_request(:modify_db_cluster_snapshot_attribute, params) req.send_request(options) end
def modify_db_instance(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
modify_db_instance(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstance - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ModifyDBInstanceResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:promotion_tier(Integer) -- -
:new_db_instance_identifier(String) -- -
:auto_minor_version_upgrade(Boolean) -- -
:preferred_maintenance_window(String) -- -
:apply_immediately(Boolean) -- -
:db_instance_class(String) -- -
:db_instance_identifier(required, String) --
def modify_db_instance(params = {}, options = {}) req = build_request(:modify_db_instance, params) req.send_request(options) end
def modify_db_subnet_group(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
modify_db_subnet_group(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ModifyDBSubnetGroupResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:subnet_ids(required, Array) -- -
:db_subnet_group_description(String) -- -
:db_subnet_group_name(required, String) --
def modify_db_subnet_group(params = {}, options = {}) req = build_request(:modify_db_subnet_group, params) req.send_request(options) end
def reboot_db_instance(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
reboot_db_instance(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstance - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::RebootDBInstanceResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:force_failover(Boolean) -- -
:db_instance_identifier(required, String) --
def reboot_db_instance(params = {}, options = {}) req = build_request(:reboot_db_instance, params) req.send_request(options) end
def remove_tags_from_resource(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
remove_tags_from_resource(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveTagsFromResource - AWS API Documentation
Other tags:
- Example: Request syntax with placeholder values -
Returns:
-
(Struct)- Returns an empty {Seahorse::Client::Response response}.
Options Hash:
(**params)-
:tag_keys(required, Array) -- -
:resource_name(required, String) --
def remove_tags_from_resource(params = {}, options = {}) req = build_request(:remove_tags_from_resource, params) req.send_request(options) end
def reset_db_cluster_parameter_group(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
reset_db_cluster_parameter_group(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResetDBClusterParameterGroup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DBClusterParameterGroupNameMessage)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:parameters(Array) -- -
:reset_all_parameters(Boolean) -- -
:db_cluster_parameter_group_name(required, String) --
def reset_db_cluster_parameter_group(params = {}, options = {}) req = build_request(:reset_db_cluster_parameter_group, params) req.send_request(options) end
def restore_db_cluster_from_snapshot(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
restore_db_cluster_from_snapshot(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshot - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::RestoreDBClusterFromSnapshotResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:enable_cloudwatch_logs_exports(Array) -- -
:kms_key_id(String) -- -
:tags(Array) -- -
:vpc_security_group_ids(Array) -- -
:db_subnet_group_name(String) -- -
:port(Integer) -- -
:engine_version(String) -- -
:engine(required, String) -- -
:snapshot_identifier(required, String) -- -
:db_cluster_identifier(required, String) -- -
:availability_zones(Array) --
def restore_db_cluster_from_snapshot(params = {}, options = {}) req = build_request(:restore_db_cluster_from_snapshot, params) req.send_request(options) end
def restore_db_cluster_to_point_in_time(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
restore_db_cluster_to_point_in_time(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTime - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::RestoreDBClusterToPointInTimeResult)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:enable_cloudwatch_logs_exports(Array) -- -
:kms_key_id(String) -- -
:tags(Array) -- -
:vpc_security_group_ids(Array) -- -
:db_subnet_group_name(String) -- -
:port(Integer) -- -
:use_latest_restorable_time(Boolean) -- -
:restore_to_time(Time, DateTime, Date, Integer, String) -- -
:source_db_cluster_identifier(required, String) -- -
:db_cluster_identifier(required, String) --
def restore_db_cluster_to_point_in_time(params = {}, options = {}) req = build_request(:restore_db_cluster_to_point_in_time, params) req.send_request(options) end
def wait_until(waiter_name, params = {}, options = {})
(**options)-
:before_wait(Proc) -- -
:before_attempt(Proc) -- -
:delay(Integer) -- -
:max_attempts(Integer) --
Parameters:
-
options(Hash) -- ({}) -
params(Hash) -- ({}) -
waiter_name(Symbol) --
Returns:
-
(Boolean)- Returns `true` if the waiter was successful.
Raises:
-
(Errors::NoSuchWaiterError)- Raised when you request to wait -
(Errors::UnexpectedError)- Raised when an error is encounted -
(Errors::TooManyAttemptsError)- Raised when the configured -
(Errors::FailureStateError)- Raised when the waiter terminates
def wait_until(waiter_name, params = {}, options = {}) w = waiter(waiter_name, options) yield(w.waiter) if block_given? # deprecated w.wait(params) end
def waiter(waiter_name, options = {})
-
options(Hash) -- ({}) -
waiter_name(Symbol) --
def waiter(waiter_name, options = {}) waiter_class = waiters[waiter_name] if waiter_class waiter_class.new(options.merge(client: self)) else raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys) end end
def waiter_names
Other tags:
- Api: - private
def waiter_names waiters.keys end
def waiters
def waiters { db_instance_available: Waiters::DBInstanceAvailable, db_instance_deleted: Waiters::DBInstanceDeleted } end