Skip to content

Create Kx Environment

finspace_create_kx_environment R Documentation

Creates a managed kdb environment for the account

Description

Creates a managed kdb environment for the account.

Usage

finspace_create_kx_environment(name, description, kmsKeyId, tags,
  clientToken)

Arguments

name

[required] The name of the kdb environment that you want to create.

description

A description for the kdb environment.

kmsKeyId

[required] The KMS key ID to encrypt your data in the FinSpace environment.

tags

A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.

clientToken

A token that ensures idempotency. This token expires in 10 minutes.

Value

A list with the following syntax:

list(
  name = "string",
  status = "CREATE_REQUESTED"|"CREATING"|"CREATED"|"DELETE_REQUESTED"|"DELETING"|"DELETED"|"FAILED_CREATION"|"RETRY_DELETION"|"FAILED_DELETION"|"UPDATE_NETWORK_REQUESTED"|"UPDATING_NETWORK"|"FAILED_UPDATING_NETWORK"|"SUSPENDED",
  environmentId = "string",
  description = "string",
  environmentArn = "string",
  kmsKeyId = "string",
  creationTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_kx_environment(
  name = "string",
  description = "string",
  kmsKeyId = "string",
  tags = list(
    "string"
  ),
  clientToken = "string"
)