AWS::FinSpace::Environment

The AWS::FinSpace::Environment resource represents an Amazon FinSpace environment.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::FinSpace::Environment",
  "Properties" : {
      "Description" : String,
      "FederationMode" : String,
      "FederationParameters" : FederationParameters,
      "KmsKeyId" : String,
      "Name" : String,
      "SuperuserParameters" : SuperuserParameters,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::FinSpace::Environment
Properties:
  Description: String
  FederationMode: String
  FederationParameters: 
    FederationParameters
  KmsKeyId: String
  Name: String
  SuperuserParameters: 
    SuperuserParameters
  Tags: 
    - Tag

Properties

Description

The description of the FinSpace environment.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

Update requires: No interruption

FederationMode

The authentication mode for the environment.

Required: No

Type: String

Allowed values: LOCAL | FEDERATED

Update requires: No interruption

FederationParameters

Configuration information when authentication mode is FEDERATED.

Required: No

Type: FederationParameters

Update requires: Replacement

KmsKeyId

The KMS key id used to encrypt in the FinSpace environment.

Required: No

Type: String

Pattern: ^[a-zA-Z-0-9-:\/]*{1,1000}$

Update requires: Replacement

Name

The name of the FinSpace environment.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]{1,255}$

Update requires: No interruption

SuperuserParameters

Configuration information for the superuser.

Required: No

Type: SuperuserParameters

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{ "Ref": "myEnvironment" }

For the Amazon FinSpace environment group myEnvironment, Ref returns the name of the environment.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AwsAccountId

The ID of the AWS account in which the FinSpace environment is created.

DedicatedServiceAccountId

The AWS account ID of the dedicated service account associated with your FinSpace environment.

EnvironmentArn

The Amazon Resource Name (ARN) of your FinSpace environment.

EnvironmentId

The identifier of the FinSpace environment.

EnvironmentUrl

The sign-in url for the web application of your FinSpace environment.

SageMakerStudioDomainUrl

The url of the integrated FinSpace notebook environment in your web application.

Status

The current status of creation of the FinSpace environment.

Examples

Creating environments

The following examples create new FinSpace environments.

YAML

Resources:
  FinSpaceEnvironment:
    Type: 'AWS::FinSpace::Environment'
    Properties:
        Name: MyEnvironment
        KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524
        FederationMode: LOCAL
      

JSON

{
   "Resources": {
      "FinSpaceEnvironment": {
         "Type": "AWS::FinSpace::Environment",
         "Properties": {
            "Name": "MyEnvironment",
            "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524",
            "FederationMode": "LOCAL"
         }
      }
   }
}