This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Amazon FinSpace schemas
<a name="AWS_FinSpace"></a>

**Resource types**
+ [AWS::FinSpace::Environment](aws-resource-finspace-environment.md)

# AWS::FinSpace::Environment
<a name="aws-resource-finspace-environment"></a>

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

## Syntax
<a name="aws-resource-finspace-environment-syntax"></a>

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

### JSON
<a name="aws-resource-finspace-environment-syntax.json"></a>

```
{
  "Type" : "AWS::FinSpace::Environment",
  "Properties" : {
      "[Description](#cfn-finspace-environment-description)" : String,
      "[FederationMode](#cfn-finspace-environment-federationmode)" : String,
      "[FederationParameters](#cfn-finspace-environment-federationparameters)" : FederationParameters,
      "[KmsKeyId](#cfn-finspace-environment-kmskeyid)" : String,
      "[Name](#cfn-finspace-environment-name)" : String,
      "[SuperuserParameters](#cfn-finspace-environment-superuserparameters)" : SuperuserParameters,
      "[Tags](#cfn-finspace-environment-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-finspace-environment-syntax.yaml"></a>

```
Type: AWS::FinSpace::Environment
Properties:
  [Description](#cfn-finspace-environment-description): String
  [FederationMode](#cfn-finspace-environment-federationmode): String
  [FederationParameters](#cfn-finspace-environment-federationparameters): 
    FederationParameters
  [KmsKeyId](#cfn-finspace-environment-kmskeyid): String
  [Name](#cfn-finspace-environment-name): String
  [SuperuserParameters](#cfn-finspace-environment-superuserparameters): 
    SuperuserParameters
  [Tags](#cfn-finspace-environment-tags): 
    - Tag
```

## Properties
<a name="aws-resource-finspace-environment-properties"></a>

`Description`  <a name="cfn-finspace-environment-description"></a>
The description of the FinSpace environment.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9. ]{1,1000}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FederationMode`  <a name="cfn-finspace-environment-federationmode"></a>
The authentication mode for the environment.  
*Required*: No  
*Type*: String  
*Allowed values*: `LOCAL | FEDERATED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FederationParameters`  <a name="cfn-finspace-environment-federationparameters"></a>
Configuration information when authentication mode is FEDERATED.  
*Required*: No  
*Type*: [FederationParameters](aws-properties-finspace-environment-federationparameters.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KmsKeyId`  <a name="cfn-finspace-environment-kmskeyid"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-finspace-environment-name"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SuperuserParameters`  <a name="cfn-finspace-environment-superuserparameters"></a>
Configuration information for the superuser.  
*Required*: No  
*Type*: [SuperuserParameters](aws-properties-finspace-environment-superuserparameters.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-finspace-environment-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-finspace-environment-tag.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-finspace-environment-return-values"></a>

### Ref
<a name="aws-resource-finspace-environment-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-finspace-environment-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-finspace-environment-return-values-fn--getatt-fn--getatt"></a>

`AwsAccountId`  <a name="AwsAccountId-fn::getatt"></a>
The ID of the AWS account in which the FinSpace environment is created. 

`DedicatedServiceAccountId`  <a name="DedicatedServiceAccountId-fn::getatt"></a>
The AWS account ID of the dedicated service account associated with your FinSpace environment. 

`EnvironmentArn`  <a name="EnvironmentArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of your FinSpace environment. 

`EnvironmentId`  <a name="EnvironmentId-fn::getatt"></a>
The identifier of the FinSpace environment. 

`EnvironmentUrl`  <a name="EnvironmentUrl-fn::getatt"></a>
The sign-in url for the web application of your FinSpace environment. 

`SageMakerStudioDomainUrl`  <a name="SageMakerStudioDomainUrl-fn::getatt"></a>
The url of the integrated FinSpace notebook environment in your web application. 

`Status`  <a name="Status-fn::getatt"></a>
The current status of creation of the FinSpace environment. 

## Examples
<a name="aws-resource-finspace-environment--examples"></a>



### Creating environments
<a name="aws-resource-finspace-environment--examples--Creating_environments"></a>

The following examples create new FinSpace environments.

#### YAML
<a name="aws-resource-finspace-environment--examples--Creating_environments--yaml"></a>

```
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
<a name="aws-resource-finspace-environment--examples--Creating_environments--json"></a>

```
{
   "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"
         }
      }
   }
}
```

# AWS::FinSpace::Environment AttributeMapItems
<a name="aws-properties-finspace-environment-attributemapitems"></a>

<a name="aws-properties-finspace-environment-attributemapitems-description"></a>The `AttributeMapItems` property type specifies Property description not available. for an [AWS::FinSpace::Environment](aws-resource-finspace-environment.md).

## Syntax
<a name="aws-properties-finspace-environment-attributemapitems-syntax"></a>

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

### JSON
<a name="aws-properties-finspace-environment-attributemapitems-syntax.json"></a>

```
{
  "[Key](#cfn-finspace-environment-attributemapitems-key)" : String,
  "[Value](#cfn-finspace-environment-attributemapitems-value)" : String
}
```

### YAML
<a name="aws-properties-finspace-environment-attributemapitems-syntax.yaml"></a>

```
  [Key](#cfn-finspace-environment-attributemapitems-key): String
  [Value](#cfn-finspace-environment-attributemapitems-value): String
```

## Properties
<a name="aws-properties-finspace-environment-attributemapitems-properties"></a>

`Key`  <a name="cfn-finspace-environment-attributemapitems-key"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-finspace-environment-attributemapitems-value"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::FinSpace::Environment FederationParameters
<a name="aws-properties-finspace-environment-federationparameters"></a>

Configuration information when authentication mode is FEDERATED.

## Syntax
<a name="aws-properties-finspace-environment-federationparameters-syntax"></a>

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

### JSON
<a name="aws-properties-finspace-environment-federationparameters-syntax.json"></a>

```
{
  "[ApplicationCallBackURL](#cfn-finspace-environment-federationparameters-applicationcallbackurl)" : String,
  "[AttributeMap](#cfn-finspace-environment-federationparameters-attributemap)" : [ AttributeMapItems, ... ],
  "[FederationProviderName](#cfn-finspace-environment-federationparameters-federationprovidername)" : String,
  "[FederationURN](#cfn-finspace-environment-federationparameters-federationurn)" : String,
  "[SamlMetadataDocument](#cfn-finspace-environment-federationparameters-samlmetadatadocument)" : String,
  "[SamlMetadataURL](#cfn-finspace-environment-federationparameters-samlmetadataurl)" : String
}
```

### YAML
<a name="aws-properties-finspace-environment-federationparameters-syntax.yaml"></a>

```
  [ApplicationCallBackURL](#cfn-finspace-environment-federationparameters-applicationcallbackurl): String
  [AttributeMap](#cfn-finspace-environment-federationparameters-attributemap): 
    - AttributeMapItems
  [FederationProviderName](#cfn-finspace-environment-federationparameters-federationprovidername): String
  [FederationURN](#cfn-finspace-environment-federationparameters-federationurn): String
  [SamlMetadataDocument](#cfn-finspace-environment-federationparameters-samlmetadatadocument): String
  [SamlMetadataURL](#cfn-finspace-environment-federationparameters-samlmetadataurl): String
```

## Properties
<a name="aws-properties-finspace-environment-federationparameters-properties"></a>

`ApplicationCallBackURL`  <a name="cfn-finspace-environment-federationparameters-applicationcallbackurl"></a>
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).  
*Required*: No  
*Type*: String  
*Pattern*: `^https?://[-a-zA-Z0-9+&amp;@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&amp;@#/%=~_|]{1,1000}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`AttributeMap`  <a name="cfn-finspace-environment-federationparameters-attributemap"></a>
SAML attribute name and value. The name must always be `Email` and the value should be set to the attribute definition in which user email is set. For example, name would be `Email` and value `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.  
*Required*: No  
*Type*: Array of [AttributeMapItems](aws-properties-finspace-environment-attributemapitems.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FederationProviderName`  <a name="cfn-finspace-environment-federationparameters-federationprovidername"></a>
Name of the identity provider (IdP).  
*Required*: No  
*Type*: String  
*Pattern*: `[^_\p{Z}][\p{L}\p{M}\p{S}\p{N}\p{P}][^_\p{Z}]+`  
*Minimum*: `1`  
*Maximum*: `32`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FederationURN`  <a name="cfn-finspace-environment-federationparameters-federationurn"></a>
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.  
*Required*: No  
*Type*: String  
*Pattern*: `^[A-Za-z0-9._\-:\/#\+]+$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SamlMetadataDocument`  <a name="cfn-finspace-environment-federationparameters-samlmetadatadocument"></a>
SAML 2.0 Metadata document from identity provider (IdP).  
*Required*: No  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `1000`  
*Maximum*: `10000000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SamlMetadataURL`  <a name="cfn-finspace-environment-federationparameters-samlmetadataurl"></a>
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).  
*Required*: No  
*Type*: String  
*Pattern*: `^https?://[-a-zA-Z0-9+&amp;@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&amp;@#/%=~_|]{1,1000}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::FinSpace::Environment SuperuserParameters
<a name="aws-properties-finspace-environment-superuserparameters"></a>

Configuration information for the superuser.

## Syntax
<a name="aws-properties-finspace-environment-superuserparameters-syntax"></a>

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

### JSON
<a name="aws-properties-finspace-environment-superuserparameters-syntax.json"></a>

```
{
  "[EmailAddress](#cfn-finspace-environment-superuserparameters-emailaddress)" : String,
  "[FirstName](#cfn-finspace-environment-superuserparameters-firstname)" : String,
  "[LastName](#cfn-finspace-environment-superuserparameters-lastname)" : String
}
```

### YAML
<a name="aws-properties-finspace-environment-superuserparameters-syntax.yaml"></a>

```
  [EmailAddress](#cfn-finspace-environment-superuserparameters-emailaddress): String
  [FirstName](#cfn-finspace-environment-superuserparameters-firstname): String
  [LastName](#cfn-finspace-environment-superuserparameters-lastname): String
```

## Properties
<a name="aws-properties-finspace-environment-superuserparameters-properties"></a>

`EmailAddress`  <a name="cfn-finspace-environment-superuserparameters-emailaddress"></a>
The email address of the superuser.  
*Required*: No  
*Type*: String  
*Pattern*: `[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FirstName`  <a name="cfn-finspace-environment-superuserparameters-firstname"></a>
The first name of the superuser.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]{1,50}$`  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`LastName`  <a name="cfn-finspace-environment-superuserparameters-lastname"></a>
The last name of the superuser.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]{1,50}$`  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::FinSpace::Environment Tag
<a name="aws-properties-finspace-environment-tag"></a>

<a name="aws-properties-finspace-environment-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::FinSpace::Environment](aws-resource-finspace-environment.md).

## Syntax
<a name="aws-properties-finspace-environment-tag-syntax"></a>

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

### JSON
<a name="aws-properties-finspace-environment-tag-syntax.json"></a>

```
{
  "[Key](#cfn-finspace-environment-tag-key)" : String,
  "[Value](#cfn-finspace-environment-tag-value)" : String
}
```

### YAML
<a name="aws-properties-finspace-environment-tag-syntax.yaml"></a>

```
  [Key](#cfn-finspace-environment-tag-key): String
  [Value](#cfn-finspace-environment-tag-value): String
```

## Properties
<a name="aws-properties-finspace-environment-tag-properties"></a>

`Key`  <a name="cfn-finspace-environment-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-finspace-environment-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)