DAX class

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.

Constructors

DAX({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createCluster({required String clusterName, required String iamRoleArn, required String nodeType, required int replicationFactor, List<String>? availabilityZones, String? description, String? notificationTopicArn, String? parameterGroupName, String? preferredMaintenanceWindow, SSESpecification? sSESpecification, List<String>? securityGroupIds, String? subnetGroupName, List<Tag>? tags}) → Future<CreateClusterResponse>
Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
createParameterGroup({required String parameterGroupName, String? description}) → Future<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.
createSubnetGroup({required String subnetGroupName, required List<String> subnetIds, String? description}) → Future<CreateSubnetGroupResponse>
Creates a new subnet group.
decreaseReplicationFactor({required String clusterName, required int newReplicationFactor, List<String>? availabilityZones, List<String>? nodeIdsToRemove}) → Future<DecreaseReplicationFactorResponse>
Removes one or more nodes from a DAX cluster.
deleteCluster({required String clusterName}) → Future<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.
deleteParameterGroup({required String parameterGroupName}) → Future<DeleteParameterGroupResponse>
Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
deleteSubnetGroup({required String subnetGroupName}) → Future<DeleteSubnetGroupResponse>
Deletes a subnet group.
describeClusters({List<String>? clusterNames, int? maxResults, String? nextToken}) → Future<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.
describeDefaultParameters({int? maxResults, String? nextToken}) → Future<DescribeDefaultParametersResponse>
Returns the default system parameter information for the DAX caching software.
describeEvents({int? duration, DateTime? endTime, int? maxResults, String? nextToken, String? sourceName, SourceType? sourceType, DateTime? startTime}) → Future<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.
describeParameterGroups({int? maxResults, String? nextToken, List<String>? parameterGroupNames}) → Future<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.
describeParameters({required String parameterGroupName, int? maxResults, String? nextToken, String? source}) → Future<DescribeParametersResponse>
Returns the detailed parameter list for a particular parameter group.
describeSubnetGroups({int? maxResults, String? nextToken, List<String>? subnetGroupNames}) → Future<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.
increaseReplicationFactor({required String clusterName, required int newReplicationFactor, List<String>? availabilityZones}) → Future<IncreaseReplicationFactorResponse>
Adds one or more nodes to a DAX cluster.
listTags({required String resourceName, String? nextToken}) → Future<ListTagsResponse>
List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebootNode({required String clusterName, required String nodeId}) → Future<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.
tagResource({required String resourceName, required List<Tag> tags}) → Future<TagResourceResponse>
Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceName, required List<String> tagKeys}) → Future<UntagResourceResponse>
Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.
updateCluster({required String clusterName, String? description, String? notificationTopicArn, String? notificationTopicStatus, String? parameterGroupName, String? preferredMaintenanceWindow, List<String>? securityGroupIds}) → Future<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.
updateParameterGroup({required String parameterGroupName, required List<ParameterNameValue> parameterNameValues}) → Future<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.
updateSubnetGroup({required String subnetGroupName, String? description, List<String>? subnetIds}) → Future<UpdateSubnetGroupResponse>
Modifies an existing subnet group.

Operators

operator ==(Object other) → bool
The equality operator.
inherited