View on GitHub
DAX Structure Reference
DAX
public struct DAXClient object for interacting with AWS DAX service.
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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the DAX client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
Declaration
Swift
public func createCluster(_ input: CreateClusterRequest) -> EventLoopFuture<CreateClusterResponse> -
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.
Declaration
Swift
public func createParameterGroup(_ input: CreateParameterGroupRequest) -> EventLoopFuture<CreateParameterGroupResponse> -
Creates a new subnet group.
Declaration
Swift
public func createSubnetGroup(_ input: CreateSubnetGroupRequest) -> EventLoopFuture<CreateSubnetGroupResponse> -
Removes one or more nodes from a DAX cluster. You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.
Declaration
Swift
public func decreaseReplicationFactor(_ input: DecreaseReplicationFactorRequest) -> EventLoopFuture<DecreaseReplicationFactorResponse> -
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.
Declaration
Swift
public func deleteCluster(_ input: DeleteClusterRequest) -> EventLoopFuture<DeleteClusterResponse> -
Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
Declaration
Swift
public func deleteParameterGroup(_ input: DeleteParameterGroupRequest) -> EventLoopFuture<DeleteParameterGroupResponse> -
Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters.
Declaration
Swift
public func deleteSubnetGroup(_ input: DeleteSubnetGroupRequest) -> EventLoopFuture<DeleteSubnetGroupResponse> -
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.
Declaration
Swift
public func describeClusters(_ input: DescribeClustersRequest) -> EventLoopFuture<DescribeClustersResponse> -
Returns the default system parameter information for the DAX caching software.
Declaration
Swift
public func describeDefaultParameters(_ input: DescribeDefaultParametersRequest) -> EventLoopFuture<DescribeDefaultParametersResponse> -
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.
Declaration
Swift
public func describeEvents(_ input: DescribeEventsRequest) -> EventLoopFuture<DescribeEventsResponse> -
Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
Declaration
Swift
public func describeParameterGroups(_ input: DescribeParameterGroupsRequest) -> EventLoopFuture<DescribeParameterGroupsResponse> -
Returns the detailed parameter list for a particular parameter group.
Declaration
Swift
public func describeParameters(_ input: DescribeParametersRequest) -> EventLoopFuture<DescribeParametersResponse> -
Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
Declaration
Swift
public func describeSubnetGroups(_ input: DescribeSubnetGroupsRequest) -> EventLoopFuture<DescribeSubnetGroupsResponse> -
Adds one or more nodes to a DAX cluster.
Declaration
Swift
public func increaseReplicationFactor(_ input: IncreaseReplicationFactorRequest) -> EventLoopFuture<IncreaseReplicationFactorResponse> -
List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.
Declaration
Swift
public func listTags(_ input: ListTagsRequest) -> EventLoopFuture<ListTagsResponse> -
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. RebootNode restarts the DAX engine process and does not remove the contents of the cache.
Declaration
Swift
public func rebootNode(_ input: RebootNodeRequest) -> EventLoopFuture<RebootNodeResponse> -
Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse> -
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.
Declaration
Swift
public func updateCluster(_ input: UpdateClusterRequest) -> EventLoopFuture<UpdateClusterResponse> -
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.
Declaration
Swift
public func updateParameterGroup(_ input: UpdateParameterGroupRequest) -> EventLoopFuture<UpdateParameterGroupResponse> -
Modifies an existing subnet group.
Declaration
Swift
public func updateSubnetGroup(_ input: UpdateSubnetGroupRequest) -> EventLoopFuture<UpdateSubnetGroupResponse>
-
Undocumented
See moreDeclaration
Swift
public enum ChangeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IsModifiable : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ParameterType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SSEStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SourceType : String, CustomStringConvertible, Codable