❤
npm
Sign UpSign In

@datafire/amazonaws_dax

5.0.0 • Public • Published

@datafire/amazonaws_dax

Client library for Amazon DynamoDB Accelerator (DAX)

Installation and Usage

npm install --save @datafire/amazonaws_dax
let amazonaws_dax = require('@datafire/amazonaws_dax').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_dax.CreateCluster({
  "ClusterName": "",
  "NodeType": "",
  "ReplicationFactor": 0,
  "IamRoleArn": ""
}).then(data => {
  console.log(data);
});

Description

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.

Actions

CreateCluster

amazonaws_dax.CreateCluster({
  "ClusterName": "",
  "NodeType": "",
  "ReplicationFactor": 0,
  "IamRoleArn": ""
}, context)

Input

Output

CreateParameterGroup

amazonaws_dax.CreateParameterGroup({
  "ParameterGroupName": ""
}, context)

Input

  • input object

Output

CreateSubnetGroup

amazonaws_dax.CreateSubnetGroup({
  "SubnetGroupName": "",
  "SubnetIds": []
}, context)

Input

Output

DecreaseReplicationFactor

amazonaws_dax.DecreaseReplicationFactor({
  "ClusterName": "",
  "NewReplicationFactor": 0
}, context)

Input

Output

DeleteCluster

amazonaws_dax.DeleteCluster({
  "ClusterName": ""
}, context)

Input

  • input object

Output

DeleteParameterGroup

amazonaws_dax.DeleteParameterGroup({
  "ParameterGroupName": ""
}, context)

Input

  • input object
    • ParameterGroupName required String

Output

DeleteSubnetGroup

amazonaws_dax.DeleteSubnetGroup({
  "SubnetGroupName": ""
}, context)

Input

  • input object
    • SubnetGroupName required String

Output

DescribeClusters

amazonaws_dax.DescribeClusters({}, context)

Input

Output

DescribeDefaultParameters

amazonaws_dax.DescribeDefaultParameters({}, context)

Input

Output

DescribeEvents

amazonaws_dax.DescribeEvents({}, context)

Input

Output

DescribeParameterGroups

amazonaws_dax.DescribeParameterGroups({}, context)

Input

Output

DescribeParameters

amazonaws_dax.DescribeParameters({
  "ParameterGroupName": ""
}, context)

Input

Output

DescribeSubnetGroups

amazonaws_dax.DescribeSubnetGroups({}, context)

Input

Output

IncreaseReplicationFactor

amazonaws_dax.IncreaseReplicationFactor({
  "ClusterName": "",
  "NewReplicationFactor": 0
}, context)

Input

Output

ListTags

amazonaws_dax.ListTags({
  "ResourceName": ""
}, context)

Input

  • input object

Output

RebootNode

amazonaws_dax.RebootNode({
  "ClusterName": "",
  "NodeId": ""
}, context)

Input

  • input object

Output

TagResource

amazonaws_dax.TagResource({
  "ResourceName": "",
  "Tags": []
}, context)

Input

  • input object

Output

UntagResource

amazonaws_dax.UntagResource({
  "ResourceName": "",
  "TagKeys": []
}, context)

Input

  • input object

Output

UpdateCluster

amazonaws_dax.UpdateCluster({
  "ClusterName": ""
}, context)

Input

Output

UpdateParameterGroup

amazonaws_dax.UpdateParameterGroup({
  "ParameterGroupName": "",
  "ParameterNameValues": []
}, context)

Input

Output

UpdateSubnetGroup

amazonaws_dax.UpdateSubnetGroup({
  "SubnetGroupName": ""
}, context)

Input

Output

Definitions

AvailabilityZoneList

  • AvailabilityZoneList array

AwsQueryErrorMessage

  • AwsQueryErrorMessage string

ChangeType

  • ChangeType string (values: IMMEDIATE, REQUIRES_REBOOT)

Cluster

ClusterAlreadyExistsFault

  • ClusterAlreadyExistsFault object: You already have a DAX cluster with the given identifier.

ClusterList

ClusterNameList

  • ClusterNameList array

ClusterNotFoundFault

  • ClusterNotFoundFault object: The requested cluster ID does not refer to an existing DAX cluster.

ClusterQuotaForCustomerExceededFault

  • ClusterQuotaForCustomerExceededFault object: You have attempted to exceed the maximum number of DAX clusters for your AWS account.

CreateClusterRequest

CreateClusterResponse

  • CreateClusterResponse object

CreateParameterGroupRequest

  • CreateParameterGroupRequest object

CreateParameterGroupResponse

CreateSubnetGroupRequest

CreateSubnetGroupResponse

  • CreateSubnetGroupResponse object

DecreaseReplicationFactorRequest

DecreaseReplicationFactorResponse

  • DecreaseReplicationFactorResponse object

DeleteClusterRequest

  • DeleteClusterRequest object

DeleteClusterResponse

  • DeleteClusterResponse object

DeleteParameterGroupRequest

  • DeleteParameterGroupRequest object
    • ParameterGroupName required String

DeleteParameterGroupResponse

  • DeleteParameterGroupResponse object

DeleteSubnetGroupRequest

  • DeleteSubnetGroupRequest object
    • SubnetGroupName required String

DeleteSubnetGroupResponse

  • DeleteSubnetGroupResponse object

DescribeClustersRequest

DescribeClustersResponse

DescribeDefaultParametersRequest

DescribeDefaultParametersResponse

DescribeEventsRequest

DescribeEventsResponse

DescribeParameterGroupsRequest

DescribeParameterGroupsResponse

DescribeParametersRequest

DescribeParametersResponse

DescribeSubnetGroupsRequest

DescribeSubnetGroupsResponse

Endpoint

  • Endpoint object: Represents the information required for client programs to connect to the configuration endpoint for a DAX cluster, or to an individual node within the cluster.

Event

  • Event object: Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.

EventList

  • EventList array

IncreaseReplicationFactorRequest

IncreaseReplicationFactorResponse

  • IncreaseReplicationFactorResponse object

InsufficientClusterCapacityFault

  • InsufficientClusterCapacityFault object: There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).

Integer

  • Integer integer

IntegerOptional

  • IntegerOptional integer

InvalidARNFault

  • InvalidARNFault object: The Amazon Resource Name (ARN) supplied in the request is not valid.

InvalidClusterStateFault

  • InvalidClusterStateFault object: The requested DAX cluster is not in the available state.

InvalidParameterCombinationException

  • InvalidParameterCombinationException object: Two or more incompatible parameters were specified.

InvalidParameterGroupStateFault

  • InvalidParameterGroupStateFault object: One or more parameters in a parameter group are in an invalid state.

InvalidParameterValueException

  • InvalidParameterValueException object: The value for a parameter is invalid.

InvalidSubnet

  • InvalidSubnet object: An invalid subnet identifier was specified.

InvalidVPCNetworkStateFault

  • InvalidVPCNetworkStateFault object: The VPC network is in an invalid state.

IsModifiable

  • IsModifiable string (values: TRUE, FALSE, CONDITIONAL)

KeyList

ListTagsRequest

  • ListTagsRequest object

ListTagsResponse

Node

  • Node object: Represents an individual node within a DAX cluster.

NodeIdentifierList

  • NodeIdentifierList array

NodeList

  • NodeList array

NodeNotFoundFault

  • NodeNotFoundFault object: None of the nodes in the cluster have the given node ID.

NodeQuotaForClusterExceededFault

  • NodeQuotaForClusterExceededFault object: You have attempted to exceed the maximum number of nodes for a DAX cluster.

NodeQuotaForCustomerExceededFault

  • NodeQuotaForCustomerExceededFault object: You have attempted to exceed the maximum number of nodes for your AWS account.

NodeTypeSpecificValue

  • NodeTypeSpecificValue object: Represents a parameter value that is applicable to a particular node type.

NodeTypeSpecificValueList

NotificationConfiguration

  • NotificationConfiguration object: Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

Parameter

ParameterGroup

  • ParameterGroup object: A named set of parameters that are applied to all of the nodes in a DAX cluster.

ParameterGroupAlreadyExistsFault

  • ParameterGroupAlreadyExistsFault object: The specified parameter group already exists.

ParameterGroupList

ParameterGroupNameList

  • ParameterGroupNameList array

ParameterGroupNotFoundFault

  • ParameterGroupNotFoundFault object: The specified parameter group does not exist.

ParameterGroupQuotaExceededFault

  • ParameterGroupQuotaExceededFault object: You have attempted to exceed the maximum number of parameter groups.

ParameterGroupStatus

  • ParameterGroupStatus object: The status of a parameter group.

ParameterList

ParameterNameValue

  • ParameterNameValue object: An individual DAX parameter.

ParameterNameValueList

ParameterType

  • ParameterType string (values: DEFAULT, NODE_TYPE_SPECIFIC)

RebootNodeRequest

  • RebootNodeRequest object

RebootNodeResponse

  • RebootNodeResponse object

SecurityGroupIdentifierList

  • SecurityGroupIdentifierList array

SecurityGroupMembership

  • SecurityGroupMembership object: An individual VPC security group and its status.

SecurityGroupMembershipList

SourceType

  • SourceType string (values: CLUSTER, PARAMETER_GROUP, SUBNET_GROUP)

String

  • String string

Subnet

  • Subnet object: Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.

SubnetGroup

  • SubnetGroup object:

    Represents the output of one of the following actions:

    • CreateSubnetGroup

    • ModifySubnetGroup

SubnetGroupAlreadyExistsFault

  • SubnetGroupAlreadyExistsFault object: The specified subnet group already exists.

SubnetGroupInUseFault

  • SubnetGroupInUseFault object: The specified subnet group is currently in use.

SubnetGroupList

SubnetGroupNameList

  • SubnetGroupNameList array

SubnetGroupNotFoundFault

  • SubnetGroupNotFoundFault object: The requested subnet group name does not refer to an existing subnet group.

SubnetGroupQuotaExceededFault

  • SubnetGroupQuotaExceededFault object: The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

SubnetIdentifierList

  • SubnetIdentifierList array

SubnetInUse

  • SubnetInUse object: The requested subnet is being used by another subnet group.

SubnetList

  • SubnetList array

SubnetQuotaExceededFault

  • SubnetQuotaExceededFault object: The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

TStamp

  • TStamp string

Tag

  • Tag object:

    A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

    AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user:.

    You cannot backdate the application of a tag.

TagList

  • TagList array

TagNotFoundFault

  • TagNotFoundFault object: The tag does not exist.

TagQuotaPerResourceExceeded

  • TagQuotaPerResourceExceeded object: You have exceeded the maximum number of tags for this DAX cluster.

TagResourceRequest

  • TagResourceRequest object

TagResourceResponse

  • TagResourceResponse object

UntagResourceRequest

  • UntagResourceRequest object

UntagResourceResponse

  • UntagResourceResponse object

UpdateClusterRequest

UpdateClusterResponse

  • UpdateClusterResponse object

UpdateParameterGroupRequest

UpdateParameterGroupResponse

UpdateSubnetGroupRequest

UpdateSubnetGroupResponse

  • UpdateSubnetGroupResponse object

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_dax

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

1

Version

5.0.0

License

MIT

Unpacked Size

130 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware