FinSpace User Environment Management service¶

Description¶

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

Usage¶

finspace(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- finspace(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`create_environment`	Create a new FinSpace environment
`create_kx_changeset`	Creates a changeset for a kdb database
`create_kx_cluster`	Creates a new kdb cluster
`create_kx_database`	Creates a new kdb database in the environment
`create_kx_dataview`	Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters
`create_kx_environment`	Creates a managed kdb environment for the account
`create_kx_scaling_group`	Creates a new scaling group
`create_kx_user`	Creates a user in FinSpace kdb environment with an associated IAM role
`create_kx_volume`	Creates a new volume with a specific amount of throughput and storage capacity
`delete_environment`	Delete an FinSpace environment
`delete_kx_cluster`	Deletes a kdb cluster
`delete_kx_cluster_node`	Deletes the specified nodes from a cluster
`delete_kx_database`	Deletes the specified database and all of its associated data
`delete_kx_dataview`	Deletes the specified dataview
`delete_kx_environment`	Deletes the kdb environment
`delete_kx_scaling_group`	Deletes the specified scaling group
`delete_kx_user`	Deletes a user in the specified kdb environment
`delete_kx_volume`	Deletes a volume
`get_environment`	Returns the FinSpace environment object
`get_kx_changeset`	Returns information about a kdb changeset
`get_kx_cluster`	Retrieves information about a kdb cluster
`get_kx_connection_string`	Retrieves a connection string for a user to connect to a kdb cluster
`get_kx_database`	Returns database information for the specified environment ID
`get_kx_dataview`	Retrieves details of the dataview
`get_kx_environment`	Retrieves all the information for the specified kdb environment
`get_kx_scaling_group`	Retrieves details of a scaling group
`get_kx_user`	Retrieves information about the specified kdb user
`get_kx_volume`	Retrieves the information about the volume
`list_environments`	A list of all of your FinSpace environments
`list_kx_changesets`	Returns a list of all the changesets for a database
`list_kx_cluster_nodes`	Lists all the nodes in a kdb cluster
`list_kx_clusters`	Returns a list of clusters
`list_kx_databases`	Returns a list of all the databases in the kdb environment
`list_kx_dataviews`	Returns a list of all the dataviews in the database
`list_kx_environments`	Returns a list of kdb environments created in an account
`list_kx_scaling_groups`	Returns a list of scaling groups in a kdb environment
`list_kx_users`	Lists all the users in a kdb environment
`list_kx_volumes`	Lists all the volumes in a kdb environment
`list_tags_for_resource`	A list of all tags for a resource
`tag_resource`	Adds metadata tags to a FinSpace resource
`untag_resource`	Removes metadata tags from a FinSpace resource
`update_environment`	Update your FinSpace environment
`update_kx_cluster_code_configuration`	Allows you to update code configuration on a running cluster
`update_kx_cluster_databases`	Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached
`update_kx_database`	Updates information for the given kdb database
`update_kx_dataview`	Updates the specified dataview
`update_kx_environment`	Updates information for the given kdb environment
`update_kx_environment_network`	Updates environment network to connect to your internal network by using a transit gateway
`update_kx_user`	Updates the user details
`update_kx_volume`	Updates the throughput or capacity of a volume

Examples¶

svc <- finspace()
svc$create_environment(
  Foo = 123
)