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

You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

get_environment(client, environment_id, options \\ [])

Returns the FinSpace environment object.

get_kx_changeset(client, changeset_id, database_name, environment_id, options \\ [])

Returns information about a kdb changeset.

get_kx_cluster(client, cluster_name, environment_id, options \\ [])

Retrieves information about a kdb cluster.

get_kx_connection_string(client, environment_id, cluster_name, user_arn, options \\ [])

Retrieves a connection string for a user to connect to a kdb cluster.

You must call this API using the same role that you have defined while creating a user.

get_kx_database(client, database_name, environment_id, options \\ [])

Returns database information for the specified environment ID.

get_kx_dataview(client, database_name, dataview_name, environment_id, options \\ [])

Retrieves details of the dataview.

get_kx_environment(client, environment_id, options \\ [])

Retrieves all the information for the specified kdb environment.

get_kx_scaling_group(client, environment_id, scaling_group_name, options \\ [])

Retrieves details of a scaling group.

get_kx_user(client, environment_id, user_name, options \\ [])

Retrieves information about the specified kdb user.

get_kx_volume(client, environment_id, volume_name, options \\ [])

Retrieves the information about the volume.

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

A list of all of your FinSpace environments.

list_kx_changesets(client, database_name, environment_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the changesets for a database.

list_kx_cluster_nodes(client, cluster_name, environment_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the nodes in a kdb cluster.

list_kx_clusters(client, environment_id, cluster_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of clusters.

list_kx_databases(client, environment_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the databases in the kdb environment.

list_kx_dataviews(client, database_name, environment_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the dataviews in the database.

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

Returns a list of kdb environments created in an account.

list_kx_scaling_groups(client, environment_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of scaling groups in a kdb environment.

list_kx_users(client, environment_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the users in a kdb environment.

list_kx_volumes(client, environment_id, max_results \\ nil, next_token \\ nil, volume_type \\ nil, options \\ [])

Lists all the volumes in a kdb environment.

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

A list of all tags for a resource.

metadata()

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

Adds metadata tags to a FinSpace resource.

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

Removes metadata tags from a FinSpace resource.

update_environment(client, environment_id, input, options \\ [])

Update your FinSpace environment.

update_kx_cluster_code_configuration(client, cluster_name, environment_id, input, options \\ [])

Allows you to update code configuration on a running cluster.

By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.

update_kx_cluster_databases(client, cluster_name, environment_id, input, options \\ [])

Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached.

This API does not allow you to change a database name or add a database if you created a cluster without one.

Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.

update_kx_database(client, database_name, environment_id, input, options \\ [])

Updates information for the given kdb database.

update_kx_dataview(client, database_name, dataview_name, environment_id, input, options \\ [])

Updates the specified dataview.

The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations

update_kx_environment(client, environment_id, input, options \\ [])

Updates information for the given kdb environment.

update_kx_environment_network(client, environment_id, input, options \\ [])

Updates environment network to connect to your internal network by using a transit gateway.

This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.

Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.

update_kx_user(client, environment_id, user_name, input, options \\ [])

Updates the user details.

You can only update the IAM role associated with a user.

update_kx_volume(client, environment_id, volume_name, input, options \\ [])

Updates the throughput or capacity of a volume.

During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.

Settings View Source AWS.Finspace (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

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

create_kx_changeset(client, database_name, environment_id, input, options \\ [])

create_kx_cluster(client, environment_id, input, options \\ [])

create_kx_database(client, environment_id, input, options \\ [])

create_kx_dataview(client, database_name, environment_id, input, options \\ [])

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

create_kx_scaling_group(client, environment_id, input, options \\ [])

create_kx_user(client, environment_id, input, options \\ [])

create_kx_volume(client, environment_id, input, options \\ [])

delete_environment(client, environment_id, input, options \\ [])

delete_kx_cluster(client, cluster_name, environment_id, input, options \\ [])

delete_kx_cluster_node(client, cluster_name, environment_id, node_id, input, options \\ [])

delete_kx_database(client, database_name, environment_id, input, options \\ [])

delete_kx_dataview(client, database_name, dataview_name, environment_id, input, options \\ [])

delete_kx_environment(client, environment_id, input, options \\ [])

delete_kx_scaling_group(client, environment_id, scaling_group_name, input, options \\ [])

delete_kx_user(client, environment_id, user_name, input, options \\ [])

delete_kx_volume(client, environment_id, volume_name, input, options \\ [])