View Source AWS.Finspace (aws-elixir v0.14.1)

The FinSpace management service provides the APIs for managing FinSpace environments.

Summary

Functions

Create a new FinSpace environment.

Creates a new kdb database in the environment.

Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters.

Creates a managed kdb environment for the account.

Creates a user in FinSpace kdb environment with an associated IAM role.

Creates a new volume with a specific amount of throughput and storage capacity.

Deletes the specified database and all of its associated data.

Deletes a user in the specified kdb environment.

Returns the FinSpace environment object.

Retrieves information about a kdb cluster.

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

Returns database information for the specified environment ID.

Retrieves all the information for the specified kdb environment.

Retrieves information about the specified kdb user.

Retrieves the information about the volume.

Returns a list of kdb environments created in an account.

Adds metadata tags to a FinSpace resource.

Removes metadata tags from a FinSpace resource.

Allows you to update code configuration on a running cluster.

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

Updates information for the given kdb environment.

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

Updates the throughput or capacity of a volume.

Functions

Link to this function

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

View Source

Create a new FinSpace environment.

Link to this function

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

View Source

Creates a changeset for a kdb database.

A changeset allows you to add and delete existing files by using an ordered list of change requests.

Link to this function

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

View Source

Creates a new kdb cluster.

Link to this function

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

View Source

Creates a new kdb database in the environment.

Link to this function

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

View Source

Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters.

Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.

Link to this function

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

View Source

Creates a managed kdb environment for the account.

Link to this function

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

View Source

Creates a new scaling group.

Link to this function

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

View Source

Creates a user in FinSpace kdb environment with an associated IAM role.

Link to this function

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

View Source

Creates a new volume with a specific amount of throughput and storage capacity.

Link to this function

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

View Source

Delete an FinSpace environment.

Link to this function

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

View Source

Deletes a kdb cluster.

Link to this function

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

View Source

Deletes the specified database and all of its associated data.

This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.

Link to this function

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

View Source

Deletes the specified dataview.

Before deleting a dataview, make sure that it is not in use by any cluster.

Link to this function

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

View Source

Deletes the kdb environment.

This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.

Link to this function

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

View Source

Deletes the specified scaling group.

This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.

Link to this function

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

View Source

Deletes a user in the specified kdb environment.

Link to this function

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

View Source

Deletes a volume.

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.

Link to this function

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

View Source

Returns the FinSpace environment object.

Link to this function

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

View Source

Returns information about a kdb changeset.

Link to this function

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

View Source

Retrieves information about a kdb cluster.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Returns database information for the specified environment ID.

Link to this function

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

View Source

Retrieves details of the dataview.

Link to this function

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

View Source

Retrieves all the information for the specified kdb environment.

Link to this function

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

View Source

Retrieves details of a scaling group.

Link to this function

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

View Source

Retrieves information about the specified kdb user.

Link to this function

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

View Source

Retrieves the information about the volume.

Link to this function

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

View Source

A list of all of your FinSpace environments.

Link to this function

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

View Source

Returns a list of all the changesets for a database.

Link to this function

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

View Source

Lists all the nodes in a kdb cluster.

Link to this function

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

View Source

Returns a list of clusters.

Link to this function

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

View Source

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

Link to this function

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

View Source

Returns a list of all the dataviews in the database.

Link to this function

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

View Source

Returns a list of kdb environments created in an account.

Link to this function

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

View Source

Returns a list of scaling groups in a kdb environment.

Link to this function

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

View Source

Lists all the users in a kdb environment.

Link to this function

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

View Source

Lists all the volumes in a kdb environment.

Link to this function

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

View Source

A list of all tags for a resource.

Link to this function

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

View Source

Adds metadata tags to a FinSpace resource.

Link to this function

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

View Source

Removes metadata tags from a FinSpace resource.

Link to this function

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

View Source

Update your FinSpace environment.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Updates information for the given kdb database.

Link to this function

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

View Source

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

Link to this function

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

View Source

Updates information for the given kdb environment.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Updates the user details.

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

Link to this function

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

View Source

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.