Skip to main content

environments_list_only

Lists environments in a region or regions, for all properties use environments

Overview

Nameenvironments_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.finspace.environments_list_only

Fields

NameDatatypeDescription
environment_idstringUnique identifier for representing FinSpace Environment
namestringName of the Environment
aws_account_idstringAWS account ID associated with the Environment
descriptionstringDescription of the Environment
statusstringState of the Environment
environment_urlstringURL used to login to the Environment
environment_arnstringARN of the Environment
sage_maker_studio_domain_urlstringSageMaker Studio Domain URL associated with the Environment
kms_key_idstringKMS key used to encrypt customer data within FinSpace Environment infrastructure
dedicated_service_account_idstringID for FinSpace created account used to store Environment artifacts
federation_modestringFederation mode used with the Environment
federation_parametersobjectAdditional parameters to identify Federation mode
superuser_parametersobjectParameters of the first Superuser for the FinSpace Environment
data_bundlesarrayARNs of FinSpace Data Bundles to install
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all environments in a region.

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

Permissions

For permissions required to operate on the environments_list_only resource, see environments