dax/aws.sdk.kotlin.services.dax

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createCluster

inline suspend fun DaxClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse

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

createParameterGroup

inline suspend fun DaxClient.createParameterGroup(crossinline block: CreateParameterGroupRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.createSubnetGroup(crossinline block: CreateSubnetGroupRequest.Builder.() -> Unit): CreateSubnetGroupResponse

Creates a new subnet group.

decreaseReplicationFactor

inline suspend fun DaxClient.decreaseReplicationFactor(crossinline block: DecreaseReplicationFactorRequest.Builder.() -> Unit): DecreaseReplicationFactorResponse

Removes one or more nodes from a DAX cluster.

deleteCluster

inline suspend fun DaxClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.deleteParameterGroup(crossinline block: DeleteParameterGroupRequest.Builder.() -> Unit): DeleteParameterGroupResponse

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

deleteSubnetGroup

inline suspend fun DaxClient.deleteSubnetGroup(crossinline block: DeleteSubnetGroupRequest.Builder.() -> Unit): DeleteSubnetGroupResponse

Deletes a subnet group.

describeClusters

inline suspend fun DaxClient.describeClusters(crossinline block: DescribeClustersRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.describeDefaultParameters(crossinline block: DescribeDefaultParametersRequest.Builder.() -> Unit): DescribeDefaultParametersResponse

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

describeEvents

inline suspend fun DaxClient.describeEvents(crossinline block: DescribeEventsRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.describeParameterGroups(crossinline block: DescribeParameterGroupsRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.describeParameters(crossinline block: DescribeParametersRequest.Builder.() -> Unit): DescribeParametersResponse

Returns the detailed parameter list for a particular parameter group.

describeSubnetGroups

inline suspend fun DaxClient.describeSubnetGroups(crossinline block: DescribeSubnetGroupsRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.increaseReplicationFactor(crossinline block: IncreaseReplicationFactorRequest.Builder.() -> Unit): IncreaseReplicationFactorResponse

Adds one or more nodes to a DAX cluster.

listTags

inline suspend fun DaxClient.listTags(crossinline block: ListTagsRequest.Builder.() -> Unit): ListTagsResponse

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

rebootNode

inline suspend fun DaxClient.rebootNode(crossinline block: RebootNodeRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun DaxClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

updateCluster

inline suspend fun DaxClient.updateCluster(crossinline block: UpdateClusterRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.updateParameterGroup(crossinline block: UpdateParameterGroupRequest.Builder.() -> Unit): 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

inline suspend fun DaxClient.updateSubnetGroup(crossinline block: UpdateSubnetGroupRequest.Builder.() -> Unit): UpdateSubnetGroupResponse

Modifies an existing subnet group.

withConfig

fun DaxClient.withConfig(block: DaxClient.Config.Builder.() -> Unit): DaxClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.