environment

Gets an individual environment resource

Overview

Name	environment
Type	Resource
Description	environment
Id	awscc.finspace.environment

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
superuser_parameters	object
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

Currently only SELECT is supported for this resource resource.

Example

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.environment
WHERE data__Identifier = '<EnvironmentId>';

Permissions

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

Read

finspace:GetEnvironment

Update

finspace:UpdateEnvironment

Delete

finspace:DeleteEnvironment,
finspace:GetEnvironment