Class: Aws::DAX::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DAX::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-dax/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
212 213 214 |
# File 'lib/aws-sdk-dax/client.rb', line 212 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1510 1511 1512 |
# File 'lib/aws-sdk-dax/client.rb', line 1510 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1513 1514 1515 |
# File 'lib/aws-sdk-dax/client.rb', line 1513 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 |
# File 'lib/aws-sdk-dax/client.rb', line 1488 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-dax' context[:gem_version] = '1.8.0' Seahorse::Client::Request.new(handlers, context) end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
388 389 390 391 |
# File 'lib/aws-sdk-dax/client.rb', line 388 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.
423 424 425 426 |
# File 'lib/aws-sdk-dax/client.rb', line 423 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.
465 466 467 468 |
# File 'lib/aws-sdk-dax/client.rb', line 465 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.
<note markdown=“1”> You cannot use ‘DecreaseReplicationFactor` to remove the last node in a DAX cluster. If you need to do this, use `DeleteCluster` instead.
</note>
541 542 543 544 |
# File 'lib/aws-sdk-dax/client.rb', line 541 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.
603 604 605 606 |
# File 'lib/aws-sdk-dax/client.rb', line 603 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.
632 633 634 635 |
# File 'lib/aws-sdk-dax/client.rb', line 632 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.
<note markdown=“1”> You cannot delete a subnet group if it is associated with any DAX clusters.
</note>
665 666 667 668 |
# File 'lib/aws-sdk-dax/client.rb', line 665 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.
760 761 762 763 |
# File 'lib/aws-sdk-dax/client.rb', line 760 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.
815 816 817 818 |
# File 'lib/aws-sdk-dax/client.rb', line 815 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 hour are returned; however, you can retrieve up to 14 days’ worth of events if necessary.
891 892 893 894 |
# File 'lib/aws-sdk-dax/client.rb', line 891 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.
941 942 943 944 |
# File 'lib/aws-sdk-dax/client.rb', line 941 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.
1004 1005 1006 1007 |
# File 'lib/aws-sdk-dax/client.rb', line 1004 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.
1057 1058 1059 1060 |
# File 'lib/aws-sdk-dax/client.rb', line 1057 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.
1127 1128 1129 1130 |
# File 'lib/aws-sdk-dax/client.rb', line 1127 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.
1166 1167 1168 1169 |
# File 'lib/aws-sdk-dax/client.rb', line 1166 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.
1231 1232 1233 1234 |
# File 'lib/aws-sdk-dax/client.rb', line 1231 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.
1271 1272 1273 1274 |
# File 'lib/aws-sdk-dax/client.rb', line 1271 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.
1307 1308 1309 1310 |
# File 'lib/aws-sdk-dax/client.rb', line 1307 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.
1397 1398 1399 1400 |
# File 'lib/aws-sdk-dax/client.rb', line 1397 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.
1438 1439 1440 1441 |
# File 'lib/aws-sdk-dax/client.rb', line 1438 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.
1479 1480 1481 1482 |
# File 'lib/aws-sdk-dax/client.rb', line 1479 def update_subnet_group(params = {}, = {}) req = build_request(:update_subnet_group, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1503 1504 1505 |
# File 'lib/aws-sdk-dax/client.rb', line 1503 def waiter_names [] end |