メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::EFS::FileSystem

AWS::EFS::FileSystem リソースは、Amazon Elastic File System (Amazon EFS) に新しい空のファイルシステムを作成します。マウントターゲット (AWS::EFS::MountTarget) を作成して、Amazon EFS ファイルシステムを Amazon Elastic Compute Cloud (Amazon EC2) インスタンスにマウントする必要があります。詳細については、Amazon Elastic File System ユーザーガイドの「CreateFileSystem」の API を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::EFS::FileSystem", "Properties" : { "Encrypted" : Boolean, "FileSystemTags" : [ FileSystemTags, ... ], "KmsKeyId" : String, "PerformanceMode" : String } }

YAML

Copy
Type: "AWS::EFS::FileSystem" Properties: Encrypted: Boolean FileSystemTags: - FileSystemTags KmsKeyId: String PerformanceMode: String

プロパティ

FileSystemTags

ファイルシステムに関連付けるタグ。

Required: No

タイプ: Amazon Elastic File System ファイルシステム FileSystemTags

更新に伴う要件: 中断はありません。

Encrypted

このブール値が true の場合、暗号化されたファイルシステムが作成されます。詳細については、『Amazon Elastic File System ユーザーガイド』の「CreateFileSystem」を参照してください。

Required: No

Type: Boolean

更新に伴う要件: 置換

KmsKeyId

暗号化されたファイルシステムの保護に使用する AWS KMS カスタマーマスターキー (CMK) の ID。このパラメータは、デフォルト以外の CMK を使用する場合にのみ必要です。詳細については、『Amazon Elastic File System ユーザーガイド』の「CreateFileSystem」を参照してください。

Required: Conditional。このパラメータは、デフォルト以外の CMK を使用する場合に必要です。

Type: String

更新に伴う要件: 置換

PerformanceMode

ファイル システムのパフォーマンス モード。有効な値については、Amazon Elastic File System ユーザーガイドCreateFilesSystem アクションの PerformanceMode パラメーターを参照してください。

パフォーマンスモードの詳細については、Amazon Elastic File System ユーザーガイドAmazon EFS パフォーマンスを参照してください。

Required: No

Type: String

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により fs-47a2c22e のようなリソース ID が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

以下の例では、暗号化されたファイルシステムを宣言しています。

JSON

Copy
{ "Resources": { "filesystem": { "Type": "AWS::EFS::FileSystem", "Properties": { "Encrypted": true, "KmsKeyId": { "Fn::GetAtt": [ "key", "Arn" ] } } }, "key": { "Type": "AWS::KMS::Key", "Properties": { "KeyPolicy": { "Version": "2012-10-17", "Id": "key-default-1", "Statement": [ { "Sid": "Allow administration of the key", "Effect": "Allow", "Principal": { "AWS": { "Fn::Join": [ "", [ "arn:aws:iam::", { "Ref": "AWS::AccountId" }, ":root" ] ] } }, "Action": [ "kms:*" ], "Resource": "*" } ] } } } }, "Outputs": { "KeyId": { "Value": { "Fn::GetAtt": [ "key", "Arn" ] } } } }

YAML

Copy
Resources: filesystem: Type: 'AWS::EFS::FileSystem' Properties: Encrypted: true KmsKeyId: !GetAtt - key - Arn key: Type: 'AWS::KMS::Key' Properties: KeyPolicy: Version: 2012-10-17 Id: key-default-1 Statement: - Sid: Allow administration of the key Effect: Allow Principal: AWS: !Join - '' - - 'arn:aws:iam::' - !Ref 'AWS::AccountId' - ':root' Action: - 'kms:*' Resource: '*' Outputs: KeyId: Value: !GetAtt - key - Arn

その他のリソース

完全なサンプルテンプレートについては、「Amazon Elastic File System サンプルテンプレート」を参照してください。