environments

Creates, updates, deletes or gets an environment resource or lists environments in a region

Overview

Name	environments
Type	Resource
Description	An example resource schema demonstrating some basic constructs and validation rules.
Id	aws.finspace.environments

Fields

Name	Datatype	Description
environment_id	string	Unique identifier for representing FinSpace Environment
name	string	Name of the Environment
aws_account_id	string	AWS account ID associated with the Environment
description	string	Description of the Environment
status	string	State of the Environment
environment_url	string	URL used to login to the Environment
environment_arn	string	ARN of the Environment
sage_maker_studio_domain_url	string	SageMaker Studio Domain URL associated with the Environment
kms_key_id	string	KMS key used to encrypt customer data within FinSpace Environment infrastructure
dedicated_service_account_id	string	ID for FinSpace created account used to store Environment artifacts
federation_mode	string	Federation mode used with the Environment
federation_parameters	object	Additional parameters to identify Federation mode
superuser_parameters	object	Parameters of the first Superuser for the FinSpace Environment
data_bundles	array	ARNs of FinSpace Data Bundles to install
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all environments in a region.

SELECT
region,
environment_id,
name,
aws_account_id,
description,
status,
environment_url,
environment_arn,
sage_maker_studio_domain_url,
kms_key_id,
dedicated_service_account_id,
federation_mode,
federation_parameters,
superuser_parameters,
data_bundles,
tags
FROM aws.finspace.environments
WHERE region = 'us-east-1';

Gets all properties from an individual environment.

SELECT
region,
environment_id,
name,
aws_account_id,
description,
status,
environment_url,
environment_arn,
sage_maker_studio_domain_url,
kms_key_id,
dedicated_service_account_id,
federation_mode,
federation_parameters,
superuser_parameters,
data_bundles,
tags
FROM aws.finspace.environments
WHERE region = 'us-east-1' AND data__Identifier = '<EnvironmentId>';

INSERT example

Use the following StackQL query and manifest file to create a new environment resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.finspace.environments (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.finspace.environments (
 Name,
 Description,
 KmsKeyId,
 FederationMode,
 FederationParameters,
 SuperuserParameters,
 DataBundles,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ KmsKeyId }}',
 '{{ FederationMode }}',
 '{{ FederationParameters }}',
 '{{ SuperuserParameters }}',
 '{{ DataBundles }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: environment
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: FederationMode
        value: '{{ FederationMode }}'
      - name: FederationParameters
        value:
          SamlMetadataURL: '{{ SamlMetadataURL }}'
          FederationProviderName: '{{ FederationProviderName }}'
          SamlMetadataDocument: '{{ SamlMetadataDocument }}'
          ApplicationCallBackURL: '{{ ApplicationCallBackURL }}'
          FederationURN: '{{ FederationURN }}'
          AttributeMap:
            - Key: '{{ Key }}'
              Value: '{{ Value }}'
      - name: SuperuserParameters
        value:
          FirstName: '{{ FirstName }}'
          LastName: '{{ LastName }}'
          EmailAddress: '{{ EmailAddress }}'
      - name: DataBundles
        value:
          - '{{ DataBundles[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.finspace.environments
WHERE data__Identifier = '<EnvironmentId>'
AND region = 'us-east-1';

Permissions

To operate on the environments resource, the following permissions are required:

Create

finspace:CreateEnvironment,
finspace:GetEnvironment,
finspace:ListEnvironments,
sts:AssumeRole

Read

finspace:GetEnvironment

Update

finspace:UpdateEnvironment

Delete

finspace:DeleteEnvironment,
finspace:GetEnvironment

List

finspace:ListEnvironments