Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

DAX

import { DAX } from "https://aws-api.deno.dev/v0.4/services/dax.ts?docs=full";
class DAX {
constructor(apiFactory: client.ApiFactory);
async createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>;
async createParameterGroup(params: CreateParameterGroupRequest, opts?: client.RequestOptions): Promise<CreateParameterGroupResponse>;
async createSubnetGroup(params: CreateSubnetGroupRequest, opts?: client.RequestOptions): Promise<CreateSubnetGroupResponse>;
async decreaseReplicationFactor(params: DecreaseReplicationFactorRequest, opts?: client.RequestOptions): Promise<DecreaseReplicationFactorResponse>;
async deleteCluster(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<DeleteClusterResponse>;
async deleteParameterGroup(params: DeleteParameterGroupRequest, opts?: client.RequestOptions): Promise<DeleteParameterGroupResponse>;
async deleteSubnetGroup(params: DeleteSubnetGroupRequest, opts?: client.RequestOptions): Promise<DeleteSubnetGroupResponse>;
async describeClusters(params?: DescribeClustersRequest, opts?: client.RequestOptions): Promise<DescribeClustersResponse>;
async describeDefaultParameters(params?: DescribeDefaultParametersRequest, opts?: client.RequestOptions): Promise<DescribeDefaultParametersResponse>;
async describeEvents(params?: DescribeEventsRequest, opts?: client.RequestOptions): Promise<DescribeEventsResponse>;
async describeParameterGroups(params?: DescribeParameterGroupsRequest, opts?: client.RequestOptions): Promise<DescribeParameterGroupsResponse>;
async describeParameters(params: DescribeParametersRequest, opts?: client.RequestOptions): Promise<DescribeParametersResponse>;
async describeSubnetGroups(params?: DescribeSubnetGroupsRequest, opts?: client.RequestOptions): Promise<DescribeSubnetGroupsResponse>;
async increaseReplicationFactor(params: IncreaseReplicationFactorRequest, opts?: client.RequestOptions): Promise<IncreaseReplicationFactorResponse>;
async listTags(params: ListTagsRequest, opts?: client.RequestOptions): Promise<ListTagsResponse>;
async rebootNode(params: RebootNodeRequest, opts?: client.RequestOptions): Promise<RebootNodeResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<TagResourceResponse>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<UntagResourceResponse>;
async updateCluster(params: UpdateClusterRequest, opts?: client.RequestOptions): Promise<UpdateClusterResponse>;
async updateParameterGroup(params: UpdateParameterGroupRequest, opts?: client.RequestOptions): Promise<UpdateParameterGroupResponse>;
async updateSubnetGroup(params: UpdateSubnetGroupRequest, opts?: client.RequestOptions): Promise<UpdateSubnetGroupResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new DAX(apiFactory: client.ApiFactory)
[src]

§Methods

§

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

§

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.

§

Creates a new subnet group.

§

Removes one or more nodes from a DAX cluster.

Note: You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

§

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.

§

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.

§

Deletes a subnet group.

Note: You cannot delete a subnet group if it is associated with any DAX clusters.

§

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.

§

Returns the default system parameter information for the DAX caching software.

§

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.

§

Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.

§

Returns the detailed parameter list for a particular parameter group.

§

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

§

Adds one or more nodes to a DAX cluster.

§
listTags(params: ListTagsRequest, opts?: client.RequestOptions): Promise<ListTagsResponse>
[src]

List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.

§

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.

Note: RebootNode restarts the DAX engine process and does not remove the contents of the cache.

§

Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.

§

Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.

§

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.

§

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.

§

Modifies an existing subnet group.

§Static Properties