AWS::FSx::FileSystem - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::FSx::FileSystem

AWS::FSx::FileSystem 资源是一种 Amazon FSx 资源类型,它创建 Amazon FSx for Windows File Server 文件系统或 Amazon FSx for Lustre 文件系统。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::FSx::FileSystem", "Properties" : { "BackupId" : String, "FileSystemType" : String, "KmsKeyId" : String, "LustreConfiguration" : LustreConfiguration, "SecurityGroupIds" : [ String, ... ], "StorageCapacity" : Integer, "StorageType" : String, "SubnetIds" : [ String, ... ], "Tags" : [ Tag, ... ], "WindowsConfiguration" : WindowsConfiguration } }

YAML

Type: AWS::FSx::FileSystem Properties: BackupId: String FileSystemType: String KmsKeyId: String LustreConfiguration: LustreConfiguration SecurityGroupIds: - String StorageCapacity: Integer StorageType: String SubnetIds: - String Tags: - Tag WindowsConfiguration: WindowsConfiguration

属性

BackupId

备份的 ID。指定在从现有备份创建文件系统时使用的备份。

必需:否

类型:字符串

Update requires: Replacement

FileSystemType

Amazon FSx 文件系统的类型,即 LUSTREWINDOWS

必需:是

类型:字符串

允许的值LUSTRE | WINDOWS

Update requires: Replacement

KmsKeyId

用于静态加密 Amazon FSx for Windows File Server 文件系统和持久性 Amazon FSx for Lustre 文件系统的文件系统数据的 AWS Key Management Service (AWS KMS) 密钥的 ID。在任何一种情况下,如果未指定,则使用 Amazon FSx 托管密钥。新的 Amazon FSx for Lustre 文件系统始终使用 Amazon FSx 托管密钥静态加密。有关更多信息,请参阅 AWS Key Management Service API 参考 中的加密

必需:否

类型:字符串

Update requires: Replacement

LustreConfiguration

正在创建的文件系统的 Lustre 配置。

必需:否

类型LustreConfiguration

Update requires: No interruption

SecurityGroupIds

ID 列表,这些 ID 指定要应用于为文件系统访问创建的所有网络接口的安全组 。在以后的描述文件系统的请求中不会返回此列表。

必需:否

类型:字符串列表

最高50

Update requires: Replacement

StorageCapacity

设置要创建的文件系统的存储容量。

对于 Lustre 文件系统:

  • 对于 SCRATCH_2PERSISTENT_1 SSD 部署类型,有效值为 1200 GiB、2400 GiB,并以 2400 GiB 为增量。

  • 对于 PERSISTENT HDD 文件系统,如果是 12 MB/s/TiB 文件系统,则有效值是增量为 6000 GiB;而如果是 40 MB/s/TiB 文件系统,则有效值是增量为 1800 GiB。

  • 对于 SCRATCH_1 部署类型,有效值为 1200 GiB、2400 GiB,并以 3600 GiB 为增量。

对于 Windows 文件系统:

  • 如果是 StorageType=SSD,有效值为 32 Gib - 65,536 GiB(64 TiB)。

  • 如果是 StorageType=HDD,有效值为 2000 GiB - 65,536 GiB(64 TiB)。

必需:否

类型:整数

最低0

最高2147483647

Update requires: No interruption

StorageType

设置要创建的文件系统的存储类型。有效值为 SSDHDD

  • 设置为 SSD 以使用固态驱动器存储。所有 Windows 和 Lustre 部署类型都支持 SSD。

  • 设置为 HDD 可使用硬盘驱动器存储。SINGLE_AZ_2MULTI_AZ_1 Windows 文件系统部署类型和 PERSISTENT Lustre 文件系统部署类型支持 HDD。

默认值是 SSD.有关更多信息,请参阅 Amazon FSx for Windows 用户指南中的存储类型选项Amazon FSx for Lustre 用户指南中的多存储选项

必需:否

类型:字符串

允许的值HDD | SSD

Update requires: Replacement

SubnetIds

指定可以从中访问文件系统的子网的 ID。对于 Windows MULTI_AZ_1 文件系统部署类型,请恰好提供两个子网 ID,一个用于首选文件服务器,另一个用于备用文件服务器。您可以使用 WindowsConfiguration > PreferredSubnetID 属性将其中的一个子网指定为首选子网。

对于 Windows SINGLE_AZ_1SINGLE_AZ_2 文件系统部署类型和 Lustre 文件系统,仅恰好提供一个子网 ID。将在该子网的可用区中启动文件服务器。

必需:是

类型:字符串列表

最高50

Update requires: Replacement

Tags

要应用于此资源的键值对的数组。

有关更多信息,请参阅标签

必需:否

类型Tag 的列表

最高50

Update requires: No interruption

WindowsConfiguration

正在创建的 Microsoft Windows 文件系统的配置对象。如果 FileSystemType 设置为 WINDOWS,则此值为必填项。

必需:条件

类型WindowsConfiguration

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回文件系统资源 ID。例如:

{"Ref":"fs-01234567890123456"}

对于 Amazon FSx 文件系统 fs-01234567890123456,Ref 返回文件系统 ID。

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

Fn::GetAtt

Fn::GetAtt 内部函数返回此类型的一个指定属性的值。以下为可用属性和示例返回值。

有关使用 Fn::GetAtt 内部函数的更多信息,请参阅 Fn::GetAtt

LustreMountName

装载 Amazon FSx for Lustre 时,请使用 LustreMountName 值。对于 SCRATCH_1 部署类型,此值始终为“fsx”。对于 SCRATCH_2 和 PERSISTENT_1 部署类型,此值是 AWS 区域内具有唯一性的字符串。有关更多信息,请参阅从 Amazon EC2 实例装载

示例

创建 Amazon FSx for Lustre 文件系统

以下示例创建一个 1.2 TiB 的持久性 Amazon FSx for Lustre 文件系统,PerUnitStorageThroughput 为 200 MB/s/TiB。

JSON

{ "Resources": { "BasicS3LinkedLustreFileSystem": { "Type": "AWS::FSx::FileSystem", "Properties": { "FileSystemType": "LUSTRE", "StorageCapacity": 1200, "SubnetIds": [ { "Fn::ImportValue": "MySubnet01" } ], "SecurityGroupIds": [ { "Fn::ImportValue": "LustreIngressSecurityGroupId" } ], "Tags": [ { "Key": "Name", "Value": "CFNs3linkedLustre" } ], "LustreConfiguration": { "AutoImportPolicy" : "NEW", "CopyTagsToBackups" : true, "DeploymentType": "PERSISTENT_1", "PerUnitStorageThroughput": 200, "ImportPath": { "Fn::Join": [ "", [ "s3://", { "Fn::ImportValue": "LustreCFNS3ImportBucketName" } ] ] }, "ExportPath": { "Fn::Join": [ "", [ "s3://", { "Fn::ImportValue": "LustreCFNS3ExportPath" } ] ] }, "WeeklyMaintenanceStartTime": "2:20:30" } } } }, "Outputs": { "FileSystemId": { "Value": { "Ref": "BasicS3LinkedLustreFileSystem" } } } }

YAML

Resources: BasicS3LinkedLustreFileSystem: Type: AWS::FSx::FileSystem Properties: FileSystemType: "LUSTRE" StorageCapacity: 1200 SubnetIds: [!ImportValue MySubnet01] SecurityGroupIds: [!ImportValue LustreIngressSecurityGroupId] Tags: - Key: "Name" Value: "CFNs3linkedLustre" LustreConfiguration: AutoImportPolicy: "NEW" CopyTagsToBackups: true DeploymentType: "PERSISTENT_1" PerUnitStorageThroughput: 200 ImportPath: !Join ["", ["s3://", !ImportValue LustreCFNS3ImportBucketName]] ExportPath: !Join ["", ["s3://", !ImportValue LustreCFNS3ExportPath]] WeeklyMaintenanceStartTime: "2:20:30" Outputs: FileSystemId: Value: !Ref BasicS3LinkedLustreFileSystem

在自管理的 Active Directory 中创建 Amazon FSx for Windows File Server 文件系统

以下示例创建一个多可用区 Amazon FSx for Windows File Server 文件系统,它加入自管理的 Active Directory。

JSON

{ "Resources": { "WindowsSelfManagedADFileSystemWithAllConfigs": { "Type": "AWS::FSx::FileSystem", "Properties": { "FileSystemType": "WINDOWS", "StorageCapacity": 32, "StorageType": "SSD", "SubnetIds": [ { "Fn::ImportValue": "MySubnet01" }, { "Fn::ImportValue": "MySubnet02" } ], "SecurityGroupIds": [ { "Fn::ImportValue": "WindowsIngressSecurityGroupId" } ], "Tags": [ { "Key": "Name", "Value": "windows" } ], "WindowsConfiguration": { "ThroughputCapacity": 8, "WeeklyMaintenanceStartTime": "4:16:30", "DailyAutomaticBackupStartTime": "01:00", "AutomaticBackupRetentionDays": 30, "CopyTagsToBackups": false, "DeploymentType": "MULTI_AZ_1", "PreferredSubnetId": { "Fn:ImportValue": "MySubnet01" }, "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ { "Fn::Select": [ 0, { "Fn::Split": [ ",", { "Fn::ImportValue": "MySelfManagedADDnsIpAddresses" } ] } ] } ], "DomainName": { "Fn::ImportValue": "SelfManagedADDomainName" }, "FileSystemAdministratorsGroup": "MyDomainAdminGroup", "OrganizationalUnitDistinguishedName": "OU=FileSystems,DC=corp,DC=example,DC=com", "UserName": "Admin", "Password": { "Fn::Join": [ ":", [ "{{resolve:secretsmanager", { "Fn::ImportValue": "MySelfManagedADCredentialName" }, "SecretString}}" ] ] } } } } } }, "Outputs": { "FileSystemId": { "Value": { "Ref": "WindowsSelfManagedADFileSystemWithAllConfigs" } } } }

YAML

Resources: WindowsSelfManagedADFileSystemWithAllConfigs: Type: 'AWS::FSx::FileSystem' Properties: FileSystemType: WINDOWS StorageCapacity: 32 StorageType: SSD SubnetIds: - !ImportValue MySubnet01 - !ImportValue MySubnet02 SecurityGroupIds: - !ImportValue WindowsIngressSecurityGroupId Tags: - Key: Name Value: windows WindowsConfiguration: ThroughputCapacity: 8 WeeklyMaintenanceStartTime: '4:16:30' DailyAutomaticBackupStartTime: '01:00' AutomaticBackupRetentionDays: 30 CopyTagsToBackups: false DeploymentType: MULTI_AZ_1 PreferredSubnetId: !ImportValue MySubnet01 SelfManagedActiveDirectoryConfiguration: DnsIps: - !Select - 0 - !Split - ',' - !ImportValue MySelfManagedADDnsIpAddresses DomainName: 'Fn::ImportValue': SelfManagedADDomainName FileSystemAdministratorsGroup: MyDomainAdminGroup OrganizationalUnitDistinguishedName: 'OU=FileSystems,DC=corp,DC=example,DC=com' UserName: Admin Password: !Join - ':' - - '{{resolve:secretsmanager' - !ImportValue MySelfManagedADCredentialName - 'SecretString}}' Outputs: FileSystemId: Value: !Ref WindowsSelfManagedADFileSystemWithAllConfigs

在 AWS 托管 Active Directory 中创建 Amazon FSx for Windows File Server 文件系统

以下示例创建一个使用 HDD 存储的多可用区 Amazon FSx for Windows File Server 文件系统,它加入 AWS 托管 Active Directory。

JSON

{ "Resources": { "WindowsMadFileSystemWithAllConfigs": { "Type": "AWS::FSx::FileSystem", "Properties": { "FileSystemType": "WINDOWS", "StorageCapacity": 2000, "StorageType": "HDD", "SubnetIds": [ { "Fn::ImportValue": "CfnFsxMadSubnet01" }, { "Fn::ImportValue": "CfnFsxMadSubnet02" } ], "SecurityGroupIds": [ { "Fn::ImportValue": "WindowsIngressSecurityGroupId" } ], "Tags": [ { "Key": "Name", "Value": "windows" } ], "WindowsConfiguration": { "ActiveDirectoryId": { "Fn::ImportValue": "CfnFsxMadDirectoryServiceId" }, "ThroughputCapacity": 8, "WeeklyMaintenanceStartTime": "4:16:30", "DailyAutomaticBackupStartTime": "01:00", "AutomaticBackupRetentionDays": 90, "CopyTagsToBackups": false, "DeploymentType": "MULTI_AZ_1", "PreferredSubnetId": { "Fn:ImportValue": "CfnFsxMadSubnet01" } } } } }, "Outputs": { "FileSystemId": { "Value": { "Ref": "WindowsMadFileSystemWithAllConfigs" } } } }

YAML

Resources: WindowsMadFileSystemWithAllConfigs: Type: 'AWS::FSx::FileSystem' Properties: FileSystemType: WINDOWS StorageCapacity: 2000 StorageType: SSD SubnetIds: - !ImportValue CfnFsxMadSubnet01 - !ImportValue CfnFsxMadSubnet02 SecurityGroupIds: - !ImportValue WindowsIngressSecurityGroupId Tags: - Key: Name Value: windows WindowsConfiguration: ActiveDirectoryId: !ImportValue CfnFsxMadDirectoryServiceId ThroughputCapacity: 8 WeeklyMaintenanceStartTime: '4:16:30' DailyAutomaticBackupStartTime: '01:00' AutomaticBackupRetentionDays: 90 DeploymentType: MULTI_AZ_1 PreferredSubnetId: !ImportValue CfnFsxMadSubnet01 CopyTagsToBackups: false Outputs: FileSystemId: Value: !Ref WindowsMadFileSystemWithAllConfigs