AWS::FinSpace::Environment

FinSpace Environment

An example resource schema demonstrating some basic constructs and validation rules.

Properties

8 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	Required
`DataBundles`	`Array<string>`	Create-onlyDeprecated
`Description`	`string`
`FederationMode`	`string`
`FederationParameters`	`FederationParameters`	Create-only
`KmsKeyId`	`string`	Create-only
`SuperuserParameters`	`SuperuserParameters`	Create-onlyWrite-only
`Tags`	`Array<Tag>`	Create-onlyWrite-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AwsAccountId`	`string`	AWS account ID associated with the Environment
`DedicatedServiceAccountId`	`string`	ID for FinSpace created account used to store Environment artifacts
`EnvironmentArn`	`string`	ARN of the Environment
`EnvironmentId`	`string`	Unique identifier for representing FinSpace Environment
`EnvironmentUrl`	`string`	URL used to login to the Environment
`SageMakerStudioDomainUrl`	`string`	SageMaker Studio Domain URL associated with the Environment
`Status`	`string`	State of the Environment

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::FinSpace::Environment

Resources:
  MyResource:
    Type: AWS::FinSpace::Environment
    Properties:
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

finspace:CreateEnvironmentfinspace:GetEnvironmentfinspace:ListEnvironmentssts:AssumeRole

read

finspace:GetEnvironment

update

finspace:UpdateEnvironment

delete

finspace:DeleteEnvironmentfinspace:GetEnvironment

list

finspace:ListEnvironments

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceFinSpace

Properties15

Required1

TaggingSupported

Primary IDEnvironmentId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

KmsKeyIdSuperuserParametersFederationParametersDataBundlesTags

External Links

AWS Documentation