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).

# AWS::FSx::StorageVirtualMachine
<a name="aws-resource-fsx-storagevirtualmachine"></a>

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

## Syntax
<a name="aws-resource-fsx-storagevirtualmachine-syntax"></a>

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

### JSON
<a name="aws-resource-fsx-storagevirtualmachine-syntax.json"></a>

```
{
  "Type" : "AWS::FSx::StorageVirtualMachine",
  "Properties" : {
      "[ActiveDirectoryConfiguration](#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration)" : ActiveDirectoryConfiguration,
      "[FileSystemId](#cfn-fsx-storagevirtualmachine-filesystemid)" : String,
      "[Name](#cfn-fsx-storagevirtualmachine-name)" : String,
      "[RootVolumeSecurityStyle](#cfn-fsx-storagevirtualmachine-rootvolumesecuritystyle)" : String,
      "[SvmAdminPassword](#cfn-fsx-storagevirtualmachine-svmadminpassword)" : String,
      "[Tags](#cfn-fsx-storagevirtualmachine-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-fsx-storagevirtualmachine-syntax.yaml"></a>

```
Type: AWS::FSx::StorageVirtualMachine
Properties:
  [ActiveDirectoryConfiguration](#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration): 
    ActiveDirectoryConfiguration
  [FileSystemId](#cfn-fsx-storagevirtualmachine-filesystemid): String
  [Name](#cfn-fsx-storagevirtualmachine-name): String
  [RootVolumeSecurityStyle](#cfn-fsx-storagevirtualmachine-rootvolumesecuritystyle): String
  [SvmAdminPassword](#cfn-fsx-storagevirtualmachine-svmadminpassword): String
  [Tags](#cfn-fsx-storagevirtualmachine-tags): 
    - Tag
```

## Properties
<a name="aws-resource-fsx-storagevirtualmachine-properties"></a>

`ActiveDirectoryConfiguration`  <a name="cfn-fsx-storagevirtualmachine-activedirectoryconfiguration"></a>
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.  
*Required*: No  
*Type*: [ActiveDirectoryConfiguration](aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FileSystemId`  <a name="cfn-fsx-storagevirtualmachine-filesystemid"></a>
Specifies the FSx for ONTAP file system on which to create the SVM.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-fsx-storagevirtualmachine-name"></a>
The name of the SVM.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[^\u0000\u0085\u2028\u2029\r\n]{1,47}$`  
*Minimum*: `1`  
*Maximum*: `47`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RootVolumeSecurityStyle`  <a name="cfn-fsx-storagevirtualmachine-rootvolumesecuritystyle"></a>
The security style of the root volume of the SVM. Specify one of the following values:  
+ `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
+ `NTFS` if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.
+ `MIXED` This is an advanced setting. For more information, see [Volume security style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html) in the Amazon FSx for NetApp ONTAP User Guide.
  
*Required*: No  
*Type*: String  
*Allowed values*: `UNIX | NTFS | MIXED`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SvmAdminPassword`  <a name="cfn-fsx-storagevirtualmachine-svmadminpassword"></a>
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's `fsxadmin` user to manage the SVM. For more information, see [ Managing SVMs using the NetApp ONTAP CLI](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html#vsadmin-ontap-cli) in the *FSx for ONTAP User Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-fsx-storagevirtualmachine-tags"></a>
A list of `Tag` values, with a maximum of 50 elements.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-fsx-storagevirtualmachine-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-fsx-storagevirtualmachine-return-values"></a>

### Ref
<a name="aws-resource-fsx-storagevirtualmachine-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ID, such as `svm-01234567890123456`. For example:

`{"Ref": "svm_logical_id"}` returns 

 `svm-01234567890123456` 

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-fsx-storagevirtualmachine-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-fsx-storagevirtualmachine-return-values-fn--getatt-fn--getatt"></a>

`ResourceARN`  <a name="ResourceARN-fn::getatt"></a>
Returns the storage virtual machine's Amazon Resource Name (ARN).  
Example: `arn:aws:fsx:us-east-2:111111111111:storage-virtual-machine/fs-0123456789abcdef1/svm-01234567890123456`

`StorageVirtualMachineId`  <a name="StorageVirtualMachineId-fn::getatt"></a>
Returns the storgage virtual machine's system generated ID.  
Example: `svm-0123456789abcedf1`

`UUID`  <a name="UUID-fn::getatt"></a>
Returns the storage virtual machine's system generated unique identifier (UUID).  
Example: `abcd0123-cd45-ef67-11aa-1111aaaa23bc`

## Examples
<a name="aws-resource-fsx-storagevirtualmachine--examples"></a>



### Create an Amazon FSx for NetApp ONTAP Storage Virtual Machine
<a name="aws-resource-fsx-storagevirtualmachine--examples--Create_an_Amazon_FSx_for_NetApp_ONTAP_Storage_Virtual_Machine"></a>

The following examples create an Amazon FSx for NetApp ONTAP storage virtual machine (SVN) that's joined to a self-managed Active Directory domain.

#### JSON
<a name="aws-resource-fsx-storagevirtualmachine--examples--Create_an_Amazon_FSx_for_NetApp_ONTAP_Storage_Virtual_Machine--json"></a>

```
{
  "OntapStorageVirtualMachineWithAllConfigs": {
    "Type": "AWS::FSx::StorageVirtualMachine",
    "Properties": {
      "ActiveDirectoryConfiguration": {
        "NetBiosName": "svm1",
        "SelfManagedActiveDirectoryConfiguration": {
          "DnsIps": [
            "10.0.10.67"
          ],
          "DomainName": "CFN-CUSTOMER-AD.SIMBA.LOCAL",
          "FileSystemAdministratorsGroup": "Domain Admins",
          "OrganizationalUnitDistinguishedName": "OU=cfn-customer-ad,DC=cfn-customer-ad,DC=simba,DC=local",
          "Password": {
            "Fn::Join": [
              ":",
              [
                "{{resolve:secretsmanager",
                {
                  "Fn::ImportValue": "CustomerADCredentialName"
              },
              "SecretString}}"
            ]
          ]
        },
        "UserName": "Admin"
      }
    },
    "FileSystemId": {
      "Ref": "OntapMultiAzFileSystemWithAllConfigs"
    },
    "Name": "svm1",
    "RootVolumeSecurityStyle": "UNIX",
    "SvmAdminPassword": {
      "Password": {
        "Fn::Join": [
        ":",
        [
          "{{resolve:secretsmanager",
            {
              "Fn::ImportValue": "CustomerADCredentialName"
              },
              "SecretString}}"
            ]
          ]
        }
      },
      "Tags": [
        {
          "Key": "Name",
          "Value": "OntapSvm"
        }
      ]
    }
  }
}
```

#### YAML
<a name="aws-resource-fsx-storagevirtualmachine--examples--Create_an_Amazon_FSx_for_NetApp_ONTAP_Storage_Virtual_Machine--yaml"></a>

```
OntapStorageVirtualMachineWithAllConfigs:
  Type: "AWS::FSx::StorageVirtualMachine"
  Properties:
    ActiveDirectoryConfiguration:
      NetBiosName: "svm1"
      SelfManagedActiveDirectoryConfiguration:
        DnsIps: ["10.0.10.67"]
        DomainName: "CFN-CUSTOMER-AD.SIMBA.LOCAL"
        FileSystemAdministratorsGroup: "Domain Admins"
        OrganizationalUnitDistinguishedName: "OU=cfn-customer-ad,DC=cfn-customer-ad,DC=simba,DC=local"
        Password:
          !Join
          - ':'
          - - '{{resolve:secretsmanager'
            - !ImportValue CustomerADCredentialName
            - 'SecretString}}'
        UserName: "Admin"
    FileSystemId: !Ref OntapMultiAzFileSystemWithAllConfigs
    Name: "svm1"
    RootVolumeSecurityStyle: "UNIX"
    SvmAdminPassword:
      Password:
        !Join
        - ':'
        - - '{{resolve:secretsmanager'
          - !ImportValue CustomerADCredentialName
          - 'SecretString}}'
    Tags:
      - Key: "Name"
        Value: "OntapSvm"
```

# AWS::FSx::StorageVirtualMachine ActiveDirectoryConfiguration
<a name="aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration"></a>

Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system.

## Syntax
<a name="aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-syntax.json"></a>

```
{
  "[NetBiosName](#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-netbiosname)" : String,
  "[SelfManagedActiveDirectoryConfiguration](#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration)" : SelfManagedActiveDirectoryConfiguration
}
```

### YAML
<a name="aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-syntax.yaml"></a>

```
  [NetBiosName](#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-netbiosname): String
  [SelfManagedActiveDirectoryConfiguration](#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration): 
    SelfManagedActiveDirectoryConfiguration
```

## Properties
<a name="aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-properties"></a>

`NetBiosName`  <a name="cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-netbiosname"></a>
The NetBIOS name of the Active Directory computer object that will be created for your SVM.  
*Required*: No  
*Type*: String  
*Pattern*: `^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$`  
*Minimum*: `1`  
*Maximum*: `15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SelfManagedActiveDirectoryConfiguration`  <a name="cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration"></a>
The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.  
*Required*: No  
*Type*: [SelfManagedActiveDirectoryConfiguration](aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::FSx::StorageVirtualMachine SelfManagedActiveDirectoryConfiguration
<a name="aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration"></a>

The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.

## Syntax
<a name="aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-syntax.json"></a>

```
{
  "[DnsIps](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-dnsips)" : [ String, ... ],
  "[DomainJoinServiceAccountSecret](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-domainjoinserviceaccountsecret)" : String,
  "[DomainName](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-domainname)" : String,
  "[FileSystemAdministratorsGroup](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-filesystemadministratorsgroup)" : String,
  "[OrganizationalUnitDistinguishedName](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-organizationalunitdistinguishedname)" : String,
  "[Password](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-password)" : String,
  "[UserName](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-username)" : String
}
```

### YAML
<a name="aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-syntax.yaml"></a>

```
  [DnsIps](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-dnsips): 
    - String
  [DomainJoinServiceAccountSecret](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-domainjoinserviceaccountsecret): String
  [DomainName](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-domainname): String
  [FileSystemAdministratorsGroup](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-filesystemadministratorsgroup): String
  [OrganizationalUnitDistinguishedName](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-organizationalunitdistinguishedname): String
  [Password](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-password): String
  [UserName](#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-username): String
```

## Properties
<a name="aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-properties"></a>

`DnsIps`  <a name="cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-dnsips"></a>
A list of IP addresses of DNS servers or domain controllers in the self-managed AD directory. FSx for ONTAP SVMs support up to three IP addresses, FSx for Windows supports up to two.   
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `3`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DomainJoinServiceAccountSecret`  <a name="cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-domainjoinserviceaccountsecret"></a>
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the self-managed Active Directory domain join service account credentials. When provided, Amazon FSx uses the credentials stored in this secret to join the file system to your self-managed Active Directory domain.  
The secret must contain two key-value pairs:  
+ `CUSTOMER_MANAGED_ACTIVE_DIRECTORY_USERNAME` - The username for the service account
+ `CUSTOMER_MANAGED_ACTIVE_DIRECTORY_PASSWORD` - The password for the service account
For more information, see [ Using Amazon FSx for Windows with your self-managed Microsoft Active Directory](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-manage-prereqs.html) or [ Using Amazon FSx for ONTAP with your self-managed Microsoft Active Directory](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/self-manage-prereqs.html).  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:[^:]{1,63}:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+-[a-zA-Z0-9]{6}$`  
*Minimum*: `64`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DomainName`  <a name="cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-domainname"></a>
The fully qualified domain name of the self-managed AD directory, such as `corp.example.com`.  
*Required*: No  
*Type*: String  
*Pattern*: `^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FileSystemAdministratorsGroup`  <a name="cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-filesystemadministratorsgroup"></a>
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.  
*Required*: No  
*Type*: String  
*Pattern*: `^[^\u0000\u0085\u2028\u2029\r\n]{1,256}$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OrganizationalUnitDistinguishedName`  <a name="cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-organizationalunitdistinguishedname"></a>
(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is `OU=FSx,DC=yourdomain,DC=corp,DC=com`. To learn more, see [RFC 2253](https://tools.ietf.org/html/rfc2253). If none is provided, the FSx file system is created in the default location of your self-managed AD directory.   
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
*Required*: No  
*Type*: String  
*Pattern*: `^[^\u0000\u0085\u2028\u2029\r\n]{1,2000}$`  
*Minimum*: `1`  
*Maximum*: `2000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Password`  <a name="cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-password"></a>
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.  
*Required*: No  
*Type*: String  
*Pattern*: `^.{1,256}$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserName`  <a name="cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-username"></a>
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in `OrganizationalUnitDistinguishedName`, or in the default location of your AD domain.  
*Required*: No  
*Type*: String  
*Pattern*: `^[^\u0000\u0085\u2028\u2029\r\n]{1,256}$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::FSx::StorageVirtualMachine Tag
<a name="aws-properties-fsx-storagevirtualmachine-tag"></a>

Specifies a key-value pair for a resource tag.

## Syntax
<a name="aws-properties-fsx-storagevirtualmachine-tag-syntax"></a>

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

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

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

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

```
  [Key](#cfn-fsx-storagevirtualmachine-tag-key): String
  [Value](#cfn-fsx-storagevirtualmachine-tag-value): String
```

## Properties
<a name="aws-properties-fsx-storagevirtualmachine-tag-properties"></a>

`Key`  <a name="cfn-fsx-storagevirtualmachine-tag-key"></a>
A value that specifies the `TagKey`, the name of the tag. Tag keys must be unique for the resource to which they are attached.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-fsx-storagevirtualmachine-tag-value"></a>
A value that specifies the `TagValue`, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of `finances : April` and also of `payroll : April`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)