Class: Aws::MemoryDB::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MemoryDB::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb
Overview
An API client for MemoryDB. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MemoryDB::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
-
#batch_update_cluster(params = {}) ⇒ Types::BatchUpdateClusterResponse
Apply the service update to a list of clusters supplied.
-
#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResponse
Makes a copy of an existing snapshot.
-
#create_acl(params = {}) ⇒ Types::CreateACLResponse
Creates an Access Control List.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a cluster.
-
#create_parameter_group(params = {}) ⇒ Types::CreateParameterGroupResponse
Creates a new MemoryDB parameter group.
-
#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResponse
Creates a copy of an entire cluster at a specific moment in time.
-
#create_subnet_group(params = {}) ⇒ Types::CreateSubnetGroupResponse
Creates a subnet group.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a MemoryDB user.
-
#delete_acl(params = {}) ⇒ Types::DeleteACLResponse
Deletes an Access Control List.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes a cluster.
-
#delete_parameter_group(params = {}) ⇒ Types::DeleteParameterGroupResponse
Deletes the specified parameter group.
-
#delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResponse
Deletes an existing snapshot.
-
#delete_subnet_group(params = {}) ⇒ Types::DeleteSubnetGroupResponse
Deletes a subnet group.
-
#delete_user(params = {}) ⇒ Types::DeleteUserResponse
Deletes a user.
-
#describe_acls(params = {}) ⇒ Types::DescribeACLsResponse
Returns a list of ACLs.
-
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
-
#describe_engine_versions(params = {}) ⇒ Types::DescribeEngineVersionsResponse
Returns a list of the available Redis engine versions.
-
#describe_events(params = {}) ⇒ Types::DescribeEventsResponse
Returns events related to clusters, security groups, and parameter groups.
-
#describe_parameter_groups(params = {}) ⇒ Types::DescribeParameterGroupsResponse
Returns a list of parameter group descriptions.
-
#describe_parameters(params = {}) ⇒ Types::DescribeParametersResponse
Returns the detailed parameter list for a particular parameter group.
-
#describe_reserved_nodes(params = {}) ⇒ Types::DescribeReservedNodesResponse
Returns information about reserved nodes for this account, or about a specified reserved node.
-
#describe_reserved_nodes_offerings(params = {}) ⇒ Types::DescribeReservedNodesOfferingsResponse
Lists available reserved node offerings.
-
#describe_service_updates(params = {}) ⇒ Types::DescribeServiceUpdatesResponse
Returns details of the service updates.
-
#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResponse
Returns information about cluster snapshots.
-
#describe_subnet_groups(params = {}) ⇒ Types::DescribeSubnetGroupsResponse
Returns a list of subnet group descriptions.
-
#describe_users(params = {}) ⇒ Types::DescribeUsersResponse
Returns a list of users.
-
#failover_shard(params = {}) ⇒ Types::FailoverShardResponse
Used to failover a shard.
-
#list_allowed_node_type_updates(params = {}) ⇒ Types::ListAllowedNodeTypeUpdatesResponse
Lists all available node types that you can scale to from your cluster's current node type.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists all tags currently on a named resource.
-
#purchase_reserved_nodes_offering(params = {}) ⇒ Types::PurchaseReservedNodesOfferingResponse
Allows you to purchase a reserved node offering.
-
#reset_parameter_group(params = {}) ⇒ Types::ResetParameterGroupResponse
Modifies the parameters of a parameter group to the engine or system default value.
-
#tag_resource(params = {}) ⇒ Types::TagResourceResponse
A tag is a key-value pair where the key and value are case-sensitive.
-
#untag_resource(params = {}) ⇒ Types::UntagResourceResponse
Use this operation to remove tags on a resource.
-
#update_acl(params = {}) ⇒ Types::UpdateACLResponse
Changes the list of users that belong to the Access Control List.
-
#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse
Modifies the settings for a cluster.
-
#update_parameter_group(params = {}) ⇒ Types::UpdateParameterGroupResponse
Updates the parameters of a parameter group.
-
#update_subnet_group(params = {}) ⇒ Types::UpdateSubnetGroupResponse
Updates a subnet group.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Changes user password(s) and/or access string.
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.
420 421 422 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#batch_update_cluster(params = {}) ⇒ Types::BatchUpdateClusterResponse
Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
510 511 512 513 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 510 def batch_update_cluster(params = {}, = {}) req = build_request(:batch_update_cluster, params) req.send_request() end |
#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResponse
Makes a copy of an existing snapshot.
595 596 597 598 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 595 def copy_snapshot(params = {}, = {}) req = build_request(:copy_snapshot, params) req.send_request() end |
#create_acl(params = {}) ⇒ Types::CreateACLResponse
Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
654 655 656 657 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 654 def create_acl(params = {}, = {}) req = build_request(:create_acl, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
863 864 865 866 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 863 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_parameter_group(params = {}) ⇒ Types::CreateParameterGroupResponse
Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.
921 922 923 924 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 921 def create_parameter_group(params = {}, = {}) req = build_request(:create_parameter_group, params) req.send_request() end |
#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResponse
Creates a copy of an entire cluster at a specific moment in time.
992 993 994 995 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 992 def create_snapshot(params = {}, = {}) req = build_request(:create_snapshot, params) req.send_request() end |
#create_subnet_group(params = {}) ⇒ Types::CreateSubnetGroupResponse
Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1055 def create_subnet_group(params = {}, = {}) req = build_request(:create_subnet_group, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
1120 1121 1122 1123 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1120 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_acl(params = {}) ⇒ Types::DeleteACLResponse
Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
1165 1166 1167 1168 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1165 def delete_acl(params = {}, = {}) req = build_request(:delete_acl, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes a cluster. It also deletes all associated nodes and node endpoints
1243 1244 1245 1246 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1243 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_parameter_group(params = {}) ⇒ Types::DeleteParameterGroupResponse
Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account.
1276 1277 1278 1279 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1276 def delete_parameter_group(params = {}, = {}) req = build_request(:delete_parameter_group, params) req.send_request() end |
#delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResponse
Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
1330 1331 1332 1333 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1330 def delete_snapshot(params = {}, = {}) req = build_request(:delete_snapshot, params) req.send_request() end |
#delete_subnet_group(params = {}) ⇒ Types::DeleteSubnetGroupResponse
Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
1365 1366 1367 1368 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1365 def delete_subnet_group(params = {}, = {}) req = build_request(:delete_subnet_group, params) req.send_request() end |
#delete_user(params = {}) ⇒ Types::DeleteUserResponse
Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1402 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#describe_acls(params = {}) ⇒ Types::DescribeACLsResponse
Returns a list of ACLs
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1460 1461 1462 1463 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1460 def describe_acls(params = {}, = {}) req = build_request(:describe_acls, params) req.send_request() end |
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1557 def describe_clusters(params = {}, = {}) req = build_request(:describe_clusters, params) req.send_request() end |
#describe_engine_versions(params = {}) ⇒ Types::DescribeEngineVersionsResponse
Returns a list of the available Redis engine versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1615 1616 1617 1618 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1615 def describe_engine_versions(params = {}, = {}) req = build_request(:describe_engine_versions, params) req.send_request() end |
#describe_events(params = {}) ⇒ Types::DescribeEventsResponse
Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1690 1691 1692 1693 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1690 def describe_events(params = {}, = {}) req = build_request(:describe_events, params) req.send_request() end |
#describe_parameter_groups(params = {}) ⇒ Types::DescribeParameterGroupsResponse
Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1742 1743 1744 1745 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1742 def describe_parameter_groups(params = {}, = {}) req = build_request(:describe_parameter_groups, params) req.send_request() end |
#describe_parameters(params = {}) ⇒ Types::DescribeParametersResponse
Returns the detailed parameter list for a particular parameter group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1794 1795 1796 1797 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1794 def describe_parameters(params = {}, = {}) req = build_request(:describe_parameters, params) req.send_request() end |
#describe_reserved_nodes(params = {}) ⇒ Types::DescribeReservedNodesResponse
Returns information about reserved nodes for this account, or about a specified reserved node.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1881 1882 1883 1884 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1881 def describe_reserved_nodes(params = {}, = {}) req = build_request(:describe_reserved_nodes, params) req.send_request() end |
#describe_reserved_nodes_offerings(params = {}) ⇒ Types::DescribeReservedNodesOfferingsResponse
Lists available reserved node offerings.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1957 1958 1959 1960 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1957 def describe_reserved_nodes_offerings(params = {}, = {}) req = build_request(:describe_reserved_nodes_offerings, params) req.send_request() end |
#describe_service_updates(params = {}) ⇒ Types::DescribeServiceUpdatesResponse
Returns details of the service updates
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2019 2020 2021 2022 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2019 def describe_service_updates(params = {}, = {}) req = build_request(:describe_service_updates, params) req.send_request() end |
#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResponse
Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2111 2112 2113 2114 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2111 def describe_snapshots(params = {}, = {}) req = build_request(:describe_snapshots, params) req.send_request() end |
#describe_subnet_groups(params = {}) ⇒ Types::DescribeSubnetGroupsResponse
Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2165 2166 2167 2168 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2165 def describe_subnet_groups(params = {}, = {}) req = build_request(:describe_subnet_groups, params) req.send_request() end |
#describe_users(params = {}) ⇒ Types::DescribeUsersResponse
Returns a list of users.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2229 2230 2231 2232 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2229 def describe_users(params = {}, = {}) req = build_request(:describe_users, params) req.send_request() end |
#failover_shard(params = {}) ⇒ Types::FailoverShardResponse
Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon may block this API.
2309 2310 2311 2312 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2309 def failover_shard(params = {}, = {}) req = build_request(:failover_shard, params) req.send_request() end |
#list_allowed_node_type_updates(params = {}) ⇒ Types::ListAllowedNodeTypeUpdatesResponse
Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
2346 2347 2348 2349 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2346 def list_allowed_node_type_updates(params = {}, = {}) req = build_request(:list_allowed_node_type_updates, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources
2384 2385 2386 2387 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2384 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#purchase_reserved_nodes_offering(params = {}) ⇒ Types::PurchaseReservedNodesOfferingResponse
Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.
2444 2445 2446 2447 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2444 def purchase_reserved_nodes_offering(params = {}, = {}) req = build_request(:purchase_reserved_nodes_offering, params) req.send_request() end |
#reset_parameter_group(params = {}) ⇒ Types::ResetParameterGroupResponse
Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.
2490 2491 2492 2493 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2490 def reset_parameter_group(params = {}, = {}) req = build_request(:reset_parameter_group, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceResponse
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions.
For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags.
2549 2550 2551 2552 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2549 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Types::UntagResourceResponse
Use this operation to remove tags on a resource
2584 2585 2586 2587 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2584 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_acl(params = {}) ⇒ Types::UpdateACLResponse
Changes the list of users that belong to the Access Control List.
2631 2632 2633 2634 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2631 def update_acl(params = {}, = {}) req = build_request(:update_acl, params) req.send_request() end |
#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
2790 2791 2792 2793 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2790 def update_cluster(params = {}, = {}) req = build_request(:update_cluster, params) req.send_request() end |
#update_parameter_group(params = {}) ⇒ Types::UpdateParameterGroupResponse
Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
2835 2836 2837 2838 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2835 def update_parameter_group(params = {}, = {}) req = build_request(:update_parameter_group, params) req.send_request() end |
#update_subnet_group(params = {}) ⇒ Types::UpdateSubnetGroupResponse
Updates a subnet group. For more information, see Updating a subnet group
2882 2883 2884 2885 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2882 def update_subnet_group(params = {}, = {}) req = build_request(:update_subnet_group, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Changes user password(s) and/or access string.
2930 2931 2932 2933 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2930 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |