environments

Creates, updates, deletes, gets or lists an environments resource.

Overview

Name	environments
Type	Resource
Id	aws.finspace.environments

Fields

The following fields are returned by SELECT queries:

get_environment

Name	Datatype	Description
name	string	The name of the FinSpace environment. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$</code>)
aws_account_id	string	The ID of the AWS account in which the FinSpace environment is created. (pattern: <code>^[a-zA-Z0-9]{1,26}$</code>)
dedicated_service_account_id	string	The AWS account ID of the dedicated service account associated with your FinSpace environment. (pattern: <code>^[a-zA-Z0-9]{1,26}$</code>)
description	string	The description of the FinSpace environment. (pattern: <code>^[a-zA-Z0-9. ]{1,1000}$</code>)
environment_arn	string	The Amazon Resource Name (ARN) of your FinSpace environment. (pattern: <code>^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za-z_-]{1,128}$</code>)
environment_id	string	The identifier of the FinSpace environment. (pattern: <code>^[a-zA-Z0-9]{1,26}$</code>)
environment_url	string	The sign-in URL for the web application of your FinSpace environment. (pattern: <code>^https?:​//[-a-zA-Z0-9+&@#/%?=_|!:,.;]*[-a-zA-Z0-9+&@#/%=_|]</code>)
federation_mode	string	The authentication mode for the environment. (FEDERATED, LOCAL)
federation_parameters	object	Configuration information when authentication mode is FEDERATED.
kms_key_id	string	The KMS key id used to encrypt in the FinSpace environment. (pattern: <code>^[a-zA-Z-0-9-:/]*$</code>)
sage_maker_studio_domain_url	string	The URL of the integrated FinSpace notebook environment in your web application. (pattern: <code>^[a-zA-Z-0-9-:/.]*$</code>)
status	string	The current status of creation of the FinSpace environment. (CREATE_REQUESTED, CREATING, CREATED, DELETE_REQUESTED, DELETING, DELETED, FAILED_CREATION, RETRY_DELETION, FAILED_DELETION, UPDATE_NETWORK_REQUESTED, UPDATING_NETWORK, FAILED_UPDATING_NETWORK, SUSPENDED)

list_environments

Name	Datatype	Description
environments	array	A list of all of your FinSpace environments.
next_token	string	A token that you can use in a subsequent call to retrieve the next set of results. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_environment	select	environment_id, region		Returns the FinSpace environment object.
list_environments	select	region	nextToken, maxResults	A list of all of your FinSpace environments.
create_environment	insert	region, name		Create a new FinSpace environment.
update_environment	update	environment_id, region		Update your FinSpace environment.
delete_environment	delete	environment_id, region		Delete an FinSpace environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment_id	string	The identifier for the FinSpace environment.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in this request.
nextToken	string	A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the response object of the previous page call.

SELECT examples

get_environment

Returns the FinSpace environment object.

SELECT
name,
aws_account_id,
dedicated_service_account_id,
description,
environment_arn,
environment_id,
environment_url,
federation_mode,
federation_parameters,
kms_key_id,
sage_maker_studio_domain_url,
status
FROM aws.finspace.environments
WHERE environment_id = '{{ environment_id }}' -- required
AND region = '{{ region }}' -- required
;

list_environments

A list of all of your FinSpace environments.

SELECT
environments,
next_token
FROM aws.finspace.environments
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_environment

Create a new FinSpace environment.

INSERT INTO aws.finspace.environments (
name,
description,
kmsKeyId,
tags,
federationMode,
federationParameters,
superuserParameters,
dataBundles,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ kmsKeyId }}',
'{{ tags }}',
'{{ federationMode }}',
'{{ federationParameters }}',
'{{ superuserParameters }}',
'{{ dataBundles }}',
'{{ region }}'
RETURNING
environment_arn,
environment_id,
environment_url
;

Manifest

# Description fields are for documentation purposes
- name: environments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the environments resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: kmsKeyId
    value: "{{ kmsKeyId }}"
  - name: tags
    value: "{{ tags }}"
  - name: federationMode
    value: "{{ federationMode }}"
    valid_values: ['FEDERATED', 'LOCAL']
  - name: federationParameters
    description: |
      Configuration information when authentication mode is FEDERATED.
    value:
      samlMetadataDocument: "{{ samlMetadataDocument }}"
      samlMetadataURL: "{{ samlMetadataURL }}"
      applicationCallBackURL: "{{ applicationCallBackURL }}"
      federationURN: "{{ federationURN }}"
      federationProviderName: "{{ federationProviderName }}"
      attributeMap: "{{ attributeMap }}"
  - name: superuserParameters
    description: |
      Configuration information for the superuser.
    value:
      emailAddress: "{{ emailAddress }}"
      firstName: "{{ firstName }}"
      lastName: "{{ lastName }}"
  - name: dataBundles
    value:
      - "{{ dataBundles }}"

UPDATE examples

update_environment

Update your FinSpace environment.

UPDATE aws.finspace.environments
SET 
name = '{{ name }}',
description = '{{ description }}',
federationMode = '{{ federationMode }}',
federationParameters = '{{ federationParameters }}'
WHERE 
environment_id = '{{ environment_id }}' --required
AND region = '{{ region }}' --required
RETURNING
environment;

DELETE examples

delete_environment

Delete an FinSpace environment.

DELETE FROM aws.finspace.environments
WHERE environment_id = '{{ environment_id }}' --required
AND region = '{{ region }}' --required
;