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	awscc.finspace.environments

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
environment_id	string	Unique identifier for representing FinSpace Environment
region	string	AWS region.

For more information, see AWS::FinSpace::Environment.

Methods

Name	Resource	Accessible by	Required Params
create_resource	environments	INSERT	Name, region
delete_resource	environments	DELETE	Identifier, region
update_resource	environments	UPDATE	Identifier, PatchDocument, region
list_resources	environments_list_only	SELECT	region
get_resource	environments	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.finspace.environments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ environment_id }}';

list (identifiers only)

Lists all environments in a region.

SELECT
  region,
  environment_id
FROM awscc.finspace.environments_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.finspace.environments (
  Name,
  Description,
  KmsKeyId,
  FederationMode,
  FederationParameters,
  SuperuserParameters,
  DataBundles,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ kms_key_id }}',
  '{{ federation_mode }}',
  '{{ federation_parameters }}',
  '{{ superuser_parameters }}',
  '{{ data_bundles }}',
  '{{ 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: kms_key_id
        value: '{{ kms_key_id }}'
      - name: federation_mode
        value: '{{ federation_mode }}'
      - name: federation_parameters
        value:
          saml_metadata_url: '{{ saml_metadata_url }}'
          federation_provider_name: '{{ federation_provider_name }}'
          saml_metadata_document: '{{ saml_metadata_document }}'
          application_call_back_url: '{{ application_call_back_url }}'
          federation_ur_n: '{{ federation_ur_n }}'
          attribute_map:
            - key: '{{ key }}'
              value: '{{ value }}'
      - name: superuser_parameters
        value:
          first_name: '{{ first_name }}'
          last_name: '{{ last_name }}'
          email_address: '{{ email_address }}'
      - name: data_bundles
        value:
          - '{{ data_bundles[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.finspace.environments
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "FederationMode": federation_mode
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ environment_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.finspace.environments
WHERE
  Identifier = '{{ environment_id }}' 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