Skip to content

Create a new FinSpace environment

Description

Create a new FinSpace environment.

Usage

finspace_create_environment(name, description, kmsKeyId, tags,
  federationMode, federationParameters, superuserParameters, dataBundles)

Arguments

  • name

    [required] The name of the FinSpace environment to be created.

  • description

    The description of the FinSpace environment to be created.

  • kmsKeyId

    The KMS key id to encrypt your data in the FinSpace environment.

  • tags

    Add tags to your FinSpace environment.

  • federationMode

    Authentication mode for the environment.

    • FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    • LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

  • federationParameters

    Configuration information when authentication mode is FEDERATED.

  • superuserParameters

    Configuration information for the superuser.

  • dataBundles

    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

    • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

Value

A list with the following syntax:

list(
  environmentId = "string",
  environmentArn = "string",
  environmentUrl = "string"
)

Request syntax

svc$create_environment(
  name = "string",
  description = "string",
  kmsKeyId = "string",
  tags = list(
    "string"
  ),
  federationMode = "FEDERATED"|"LOCAL",
  federationParameters = list(
    samlMetadataDocument = "string",
    samlMetadataURL = "string",
    applicationCallBackURL = "string",
    federationURN = "string",
    federationProviderName = "string",
    attributeMap = list(
      "string"
    )
  ),
  superuserParameters = list(
    emailAddress = "string",
    firstName = "string",
    lastName = "string"
  ),
  dataBundles = list(
    "string"
  )
)