Class: Aws::DAX::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DAX::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb
Overview
An API client for DAX. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::DAX::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
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a DAX cluster.
-
#create_parameter_group(params = {}) ⇒ Types::CreateParameterGroupResponse
Creates a new parameter group.
-
#create_subnet_group(params = {}) ⇒ Types::CreateSubnetGroupResponse
Creates a new subnet group.
-
#decrease_replication_factor(params = {}) ⇒ Types::DecreaseReplicationFactorResponse
Removes one or more nodes from a DAX cluster.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes a previously provisioned DAX cluster.
-
#delete_parameter_group(params = {}) ⇒ Types::DeleteParameterGroupResponse
Deletes the specified parameter group.
-
#delete_subnet_group(params = {}) ⇒ Types::DeleteSubnetGroupResponse
Deletes a subnet group.
-
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.
-
#describe_default_parameters(params = {}) ⇒ Types::DescribeDefaultParametersResponse
Returns the default system parameter information for the DAX caching software.
-
#describe_events(params = {}) ⇒ Types::DescribeEventsResponse
Returns events related to DAX clusters 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_subnet_groups(params = {}) ⇒ Types::DescribeSubnetGroupsResponse
Returns a list of subnet group descriptions.
-
#increase_replication_factor(params = {}) ⇒ Types::IncreaseReplicationFactorResponse
Adds one or more nodes to a DAX cluster.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
List all of the tags for a DAX cluster.
-
#reboot_node(params = {}) ⇒ Types::RebootNodeResponse
Reboots a single node of a DAX cluster.
-
#tag_resource(params = {}) ⇒ Types::TagResourceResponse
Associates a set of tags with a DAX resource.
-
#untag_resource(params = {}) ⇒ Types::UntagResourceResponse
Removes the association of tags from a DAX resource.
-
#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse
Modifies the settings for a DAX cluster.
-
#update_parameter_group(params = {}) ⇒ Types::UpdateParameterGroupResponse
Modifies the parameters of a parameter group.
-
#update_subnet_group(params = {}) ⇒ Types::UpdateSubnetGroupResponse
Modifies an existing subnet group.
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.
429 430 431 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 429 def initialize(*args) super end |
Instance Method Details
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
620 621 622 623 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 620 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_parameter_group(params = {}) ⇒ Types::CreateParameterGroupResponse
Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.
655 656 657 658 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 655 def create_parameter_group(params = {}, = {}) req = build_request(:create_parameter_group, params) req.send_request() end |
#create_subnet_group(params = {}) ⇒ Types::CreateSubnetGroupResponse
Creates a new subnet group.
697 698 699 700 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 697 def create_subnet_group(params = {}, = {}) req = build_request(:create_subnet_group, params) req.send_request() end |
#decrease_replication_factor(params = {}) ⇒ Types::DecreaseReplicationFactorResponse
Removes one or more nodes from a DAX cluster.
DecreaseReplicationFactor
to remove the last node in
a DAX cluster. If you need to do this, use DeleteCluster
instead.
776 777 778 779 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 776 def decrease_replication_factor(params = {}, = {}) req = build_request(:decrease_replication_factor, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.
841 842 843 844 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 841 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 DAX clusters.
870 871 872 873 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 870 def delete_parameter_group(params = {}, = {}) req = build_request(:delete_parameter_group, params) req.send_request() end |
#delete_subnet_group(params = {}) ⇒ Types::DeleteSubnetGroupResponse
Deletes a subnet group.
903 904 905 906 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 903 def delete_subnet_group(params = {}, = {}) req = build_request(:delete_subnet_group, params) req.send_request() end |
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use.
If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.
1001 1002 1003 1004 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1001 def describe_clusters(params = {}, = {}) req = build_request(:describe_clusters, params) req.send_request() end |
#describe_default_parameters(params = {}) ⇒ Types::DescribeDefaultParametersResponse
Returns the default system parameter information for the DAX caching software.
1056 1057 1058 1059 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1056 def describe_default_parameters(params = {}, = {}) req = build_request(:describe_default_parameters, params) req.send_request() end |
#describe_events(params = {}) ⇒ Types::DescribeEventsResponse
Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.
By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.
1132 1133 1134 1135 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1132 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 will contain only the descriptions for that group.
1182 1183 1184 1185 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1182 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.
1245 1246 1247 1248 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1245 def describe_parameters(params = {}, = {}) req = build_request(:describe_parameters, 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 will contain only the description of that group.
1298 1299 1300 1301 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1298 def describe_subnet_groups(params = {}, = {}) req = build_request(:describe_subnet_groups, params) req.send_request() end |
#increase_replication_factor(params = {}) ⇒ Types::IncreaseReplicationFactorResponse
Adds one or more nodes to a DAX cluster.
1371 1372 1373 1374 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1371 def increase_replication_factor(params = {}, = {}) req = build_request(:increase_replication_factor, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
List all of the tags for a DAX cluster. You can call ListTags
up to
10 times per second, per account.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1410 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#reboot_node(params = {}) ⇒ Types::RebootNodeResponse
Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.
RebootNode
restarts the DAX engine process and does not remove the
contents of the cache.
1483 1484 1485 1486 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1483 def reboot_node(params = {}, = {}) req = build_request(:reboot_node, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceResponse
Associates a set of tags with a DAX resource. You can call
TagResource
up to 5 times per second, per account.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1523 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Types::UntagResourceResponse
Removes the association of tags from a DAX resource. You can call
UntagResource
up to 5 times per second, per account.
1559 1560 1561 1562 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1559 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse
Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1654 def update_cluster(params = {}, = {}) req = build_request(:update_cluster, params) req.send_request() end |
#update_parameter_group(params = {}) ⇒ Types::UpdateParameterGroupResponse
Modifies 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.
1704 1705 1706 1707 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1704 def update_parameter_group(params = {}, = {}) req = build_request(:update_parameter_group, params) req.send_request() end |
#update_subnet_group(params = {}) ⇒ Types::UpdateSubnetGroupResponse
Modifies an existing subnet group.
1745 1746 1747 1748 |
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/client.rb', line 1745 def update_subnet_group(params = {}, = {}) req = build_request(:update_subnet_group, params) req.send_request() end |