Class: Aws::DocDBElastic::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DocDBElastic::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb
Overview
An API client for DocDBElastic. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::DocDBElastic::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#copy_cluster_snapshot(params = {}) ⇒ Types::CopyClusterSnapshotOutput
Copies a snapshot of an elastic cluster.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterOutput
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
-
#create_cluster_snapshot(params = {}) ⇒ Types::CreateClusterSnapshotOutput
Creates a snapshot of an elastic cluster.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterOutput
Delete an elastic cluster.
-
#delete_cluster_snapshot(params = {}) ⇒ Types::DeleteClusterSnapshotOutput
Delete an elastic cluster snapshot.
-
#get_cluster(params = {}) ⇒ Types::GetClusterOutput
Returns information about a specific elastic cluster.
-
#get_cluster_snapshot(params = {}) ⇒ Types::GetClusterSnapshotOutput
Returns information about a specific elastic cluster snapshot.
-
#list_cluster_snapshots(params = {}) ⇒ Types::ListClusterSnapshotsOutput
Returns information about snapshots for a specified elastic cluster.
-
#list_clusters(params = {}) ⇒ Types::ListClustersOutput
Returns information about provisioned Amazon DocumentDB elastic clusters.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags on a elastic cluster resource.
-
#restore_cluster_from_snapshot(params = {}) ⇒ Types::RestoreClusterFromSnapshotOutput
Restores an elastic cluster from a snapshot.
-
#start_cluster(params = {}) ⇒ Types::StartClusterOutput
Restarts the stopped elastic cluster that is specified by
clusterARN
. -
#stop_cluster(params = {}) ⇒ Types::StopClusterOutput
Stops the running elastic cluster that is specified by
clusterArn
. -
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to an elastic cluster resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from an elastic cluster resource.
-
#update_cluster(params = {}) ⇒ Types::UpdateClusterOutput
Modifies an elastic cluster.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#copy_cluster_snapshot(params = {}) ⇒ Types::CopyClusterSnapshotOutput
Copies a snapshot of an elastic cluster.
539 540 541 542 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 539 def copy_cluster_snapshot(params = {}, = {}) req = build_request(:copy_cluster_snapshot, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterOutput
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
706 707 708 709 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 706 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_cluster_snapshot(params = {}) ⇒ Types::CreateClusterSnapshotOutput
Creates a snapshot of an elastic cluster.
757 758 759 760 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 757 def create_cluster_snapshot(params = {}, = {}) req = build_request(:create_cluster_snapshot, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterOutput
Delete an elastic cluster.
806 807 808 809 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 806 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_cluster_snapshot(params = {}) ⇒ Types::DeleteClusterSnapshotOutput
Delete an elastic cluster snapshot.
847 848 849 850 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 847 def delete_cluster_snapshot(params = {}, = {}) req = build_request(:delete_cluster_snapshot, params) req.send_request() end |
#get_cluster(params = {}) ⇒ Types::GetClusterOutput
Returns information about a specific elastic cluster.
896 897 898 899 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 896 def get_cluster(params = {}, = {}) req = build_request(:get_cluster, params) req.send_request() end |
#get_cluster_snapshot(params = {}) ⇒ Types::GetClusterSnapshotOutput
Returns information about a specific elastic cluster snapshot
936 937 938 939 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 936 def get_cluster_snapshot(params = {}, = {}) req = build_request(:get_cluster_snapshot, params) req.send_request() end |
#list_cluster_snapshots(params = {}) ⇒ Types::ListClusterSnapshotsOutput
Returns information about snapshots for a specified elastic cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
998 999 1000 1001 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 998 def list_cluster_snapshots(params = {}, = {}) req = build_request(:list_cluster_snapshots, params) req.send_request() end |
#list_clusters(params = {}) ⇒ Types::ListClustersOutput
Returns information about provisioned Amazon DocumentDB elastic clusters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1044 1045 1046 1047 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1044 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags on a elastic cluster resource
1073 1074 1075 1076 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1073 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#restore_cluster_from_snapshot(params = {}) ⇒ Types::RestoreClusterFromSnapshotOutput
Restores an elastic cluster from a snapshot.
1168 1169 1170 1171 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1168 def restore_cluster_from_snapshot(params = {}, = {}) req = build_request(:restore_cluster_from_snapshot, params) req.send_request() end |
#start_cluster(params = {}) ⇒ Types::StartClusterOutput
Restarts the stopped elastic cluster that is specified by
clusterARN
.
1218 1219 1220 1221 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1218 def start_cluster(params = {}, = {}) req = build_request(:start_cluster, params) req.send_request() end |
#stop_cluster(params = {}) ⇒ Types::StopClusterOutput
Stops the running elastic cluster that is specified by clusterArn
.
The elastic cluster must be in the available state.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1268 def stop_cluster(params = {}, = {}) req = build_request(:stop_cluster, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to an elastic cluster resource
1296 1297 1298 1299 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1296 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from an elastic cluster resource
1322 1323 1324 1325 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1322 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_cluster(params = {}) ⇒ Types::UpdateClusterOutput
Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window
1444 1445 1446 1447 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1444 def update_cluster(params = {}, = {}) req = build_request(:update_cluster, params) req.send_request() end |