aws-elixir

View Source AWS.DSQL (aws-elixir v1.0.4)

This is an interface reference for Amazon Aurora DSQL.

It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.

Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. Aurora DSQL is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL lets you focus on using your data to acquire new insights for your business and customers.

Link to this section Summary

Functions

create_cluster(client, input, options \\ [])

Creates a cluster in Amazon Aurora DSQL.

create_multi_region_clusters(client, input, options \\ [])

Creates multi-Region clusters in Amazon Aurora DSQL.

delete_cluster(client, identifier, input, options \\ [])

Deletes a cluster in Amazon Aurora DSQL.

delete_multi_region_clusters(client, input, options \\ [])

Deletes a multi-Region cluster in Amazon Aurora DSQL.

get_cluster(client, identifier, options \\ [])

Retrieves information about a cluster.

list_clusters(client, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves information about a list of clusters.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists all of the tags for a resource.

metadata()
tag_resource(client, resource_arn, input, options \\ [])

Tags a resource with a map of key and value pairs.

untag_resource(client, resource_arn, input, options \\ [])

Removes a tag from a resource.

update_cluster(client, identifier, input, options \\ [])

Updates a cluster.

Link to this section Functions

Link to this function

create_cluster(client, input, options \\ [])

View Source

Creates a cluster in Amazon Aurora DSQL.

Link to this function

create_multi_region_clusters(client, input, options \\ [])

View Source

Creates multi-Region clusters in Amazon Aurora DSQL.

Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.

Link to this function

delete_cluster(client, identifier, input, options \\ [])

View Source

Deletes a cluster in Amazon Aurora DSQL.

Link to this function

delete_multi_region_clusters(client, input, options \\ [])

View Source

Deletes a multi-Region cluster in Amazon Aurora DSQL.

Link to this function

get_cluster(client, identifier, options \\ [])

View Source

Retrieves information about a cluster.

Link to this function

list_clusters(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves information about a list of clusters.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists all of the tags for a resource.

Link to this function

metadata()

View Source
Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Tags a resource with a map of key and value pairs.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a resource.

Link to this function

update_cluster(client, identifier, input, options \\ [])

View Source

Updates a cluster.