CreateFileSystem - Amazon Elastic File System

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateFileSystem

空のファイルシステムを新しく作成します。このオペレーションでは、Amazon EFS がべき等の作成を保証するために使用するリクエストに作成トークンが必要です (同じ作成トークンを使用してオペレーションを呼び出しても効果はありません)。指定された作成 トークンを持つ発信者の AWS アカウント が所有するファイルシステムが現在存在しない場合、このオペレーションは次のことを行います。

  • 空のファイルシステムを新しく作成します。ファイルシステムには、Amazon EFS に割り当てられた ID と、初期ライフサイクル状態 creating があります。

  • 作成したファイルシステムの説明を返します。

それ以外の場合、このオペレーションは既存のファイルシステムの ID とともに FileSystemAlreadyExists エラーを返します。

注記

基本的なユースケースでは、作成トークンにランダムに生成された UUID を使用できます。

べき等のオペレーションを使用すると、余分なファイルシステムを作成するリスクなしに CreateFileSystem コールを再試行できます。これは、ファイルシステムが実際に作成されたかどうかが不明確なまま、最初のコールが失敗したときに発生する可能性があります。例としては、トランスポートレベルのタイムアウトが発生したか、接続がリセットされたことが挙げられます。同じ作成 トークンを使用している限り、最初のコールでファイルシステムの作成に成功した場合、クライアントは FileSystemAlreadyExists エラーからその存在を知ることができます。

詳細については、Amazon EFS ユーザーガイドの「ファイルシステムの作成」を参照してください。

注記

CreateFileSystem コールは、ファイルシステムのライフサイクル状態がまだ creating である間に戻ります。DescribeFileSystems オペレーションをコールすることでファイルシステムの作成ステータスをチェックできます。これにより、ファイルシステムの状態が返されます。

このオペレーションでは、ファイルシステム用に選択したオプションの PerformanceMode パラメータを受け入れます。ほとんどのファイルシステムに generalPurpose パフォーマンスモードをお勧めします。maxIO パフォーマンスモードを使用しているファイルシステムでは、ほとんどのファイルオペレーションのレイテンシーがわずかに大きくなる代わりに、より高いレベルの集計スループットと 1 秒あたりのオペレーションにスケールできます。パフォーマンスモードは、ファイルシステムの作成後は変更できません。詳細については、「Amazon EFS パフォーマンスモード」を参照してください。

ファイルシステムのスループットモードは、ThroughputModeパラメータで設定できます。

ファイルシステムが完全に作成されると、Amazon EFS はそのライフサイクル状態を available に設定します。この時点で、VPC でファイルシステムの 1 つ以上のマウントターゲットを作成できます。詳細については、「CreateMountTarget」を参照してください。マウントターゲットを使用して、Amazon EFS ファイルシステムを VPC 内の EC2 インスタンスにマウントします。詳細については、「」を参照してください。Amazon EFS: 機能の説明

このオペレーションには、elasticfilesystem:CreateFileSystem アクションに対する許可が必要です。

リクエストの構文

POST /2015-02-01/file-systems HTTP/1.1 Content-type: application/json { "AvailabilityZoneName": "string", "Backup": boolean, "CreationToken": "string", "Encrypted": boolean, "KmsKeyId": "string", "PerformanceMode": "string", "ProvisionedThroughputInMibps": number, "Tags": [ { "Key": "string", "Value": "string" } ], "ThroughputMode": "string" }

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

AvailabilityZoneName

1 ゾーンストレージクラスを使用するファイルシステムを作成するために使用します。ファイルシステムを作成する AWS アベイラビリティーゾーンを指定します。形式 us-east-1a を使用して、アベイラビリティーゾーンを指定します。1 ゾーンストレージクラスの詳細については、Amazon EFS ユーザーガイドの「EFS ストレージクラスの使用」を参照してください。

注記

1 ゾーンストレージクラスは、Amazon EFS が利用できる AWS リージョン のすべてのアベイラビリティーゾーンで利用できるわけではありません。

Type: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

パターン: .+

: 必須 いいえ

Backup

作成するファイルシステム上で自動バックアップを有効にするかどうかを指定します。自動バックアップを有効にするには、値を true に設定します。1 ゾーンストレージクラスを使用するファイルシステムを作成している場合、デフォルトで自動バックアップが有効になります。詳細については、Amazon EFS ユーザーガイドの 「自動バックアップ」を参照してください。

デフォルトは false です。ただし、AvailabilityZoneName を指定した場合、デフォルトは true です。

注記

AWS Backupは、すべてでは使用できませんAWS リージョンAmazon EFS が利用できるの場所。

Type: [Boolean] (ブール値)

: 必須 いいえ

CreationToken

最大 64 バイトの ASCII 文字の文字列。Amazon EFS では、べき等の作成を保証するためにこれを使用します。

Type: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

パターン: .+

: 必須 はい

Encrypted

このブール値が true の場合、暗号化されたファイルシステムが作成されます。暗号化されたファイルシステムを作成するときに既存のAWS Key Management Serviceキー (KMS キー)。KMS キーを指定しない場合、Amazon EFS のデフォルトの KMS キー (/aws/elasticfilesystem) が暗号化されたファイルシステムの保護に使用されます。

Type: [Boolean] (ブール値)

: 必須 いいえ

KmsKeyId

暗号化されたファイルシステムの保護に使用する KMS キーの ID。このパラメータは、デフォルト以外の KMS キーを使用する場合にのみ必要です。このパラメータが指定されない場合、Amazon EFS のデフォルトの KMS キーが使用されます。KMS キー ID は、以下の形式を使用して指定できます。

  • キー ID - キーの一意の識別子 (例: 1234abcd-12ab-34cd-56ef-1234567890ab)。

  • ARN - キーの Amazon リソースネーム (ARN) (例: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab)。

  • キーエイリアス - 前に作成したキーの表示名 (例: alias/projectKey1)。

  • キー エイリアス ARN - キー エイリアスの ARN (例: arn:aws:kms:us-west-2:444455556666:alias/projectKey1)。

使用する場合KmsKeyIdでは、ファイルシステムの作成:暗号化パラメータを true に設定します。

重要

EFS は、対称 KMS キーのみを受け入れます。Amazon EFS ファイルシステムでは非対称 KMS キーを使用することはできません。

Type: 文字列

長さの制約: 最大長は 2,048 です。

パターン: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$

: 必須 いいえ

PerformanceMode

ファイル システムのパフォーマンス モード。ほとんどのファイルシステムに generalPurpose パフォーマンスモードをお勧めします。maxIO パフォーマンスモードを使用しているファイルシステムでは、ほとんどのファイルオペレーションのレイテンシーがわずかに大きくなる代わりに、より高いレベルの集計スループットと 1 秒あたりのオペレーションにスケールできます。パフォーマンスモードは、ファイルシステムの作成後は変更できません。

注記

maxIO モードは、1 ゾーンストレージクラスを使用するファイルシステムではサポートされません。

Type: 文字列

有効な値: generalPurpose | maxIO

: 必須 いいえ

ProvisionedThroughputInMibps

作成しているファイルシステムにプロビジョニングするスループット (MiB/秒単位で計測)。有効な値は、1~1024 です。ThroughputModeprovisioned に設定されている場合は必須です。スループットの上限は 1,024 MiB/ 秒です。この上限数を引き上げるには、AWS Support にお問い合わせください。詳細については、Amazon EFS ユーザーガイドの「引き上げ可能な Amazon EFS クォータ」を参照してください。

Type: Double

有効範囲: 最小値は 1.0 です。

: 必須 いいえ

Tags

ファイルシステムに関連付けられている 1 つ以上のタグを作成するために使用します。各タグはユーザー定義のキーバリューのペアです。"Key":"Name","Value":"{value}" キーバリューのペアを含めることで、作成時にファイルシステムに名前を付けます。各キーは一意である必要があります。詳細については、 AWS全般リファレンスガイドの「AWS リソースのタグ付け」を参照してください。

Type: の配列Tagオブジェクト

: 必須 いいえ

ThroughputMode

ファイルシステムのスループットモードを、bursting または provisioned のいずれかに指定します。ThroughputModeprovisioned に設定した場合、ProvisionedThroughputInMibps の値も設定する必要があります。ファイルシステムを作成した後、プロビジョンドスループットモードでファイルシステムのスループットを減らす場合や、スループットモード間の切り替えを行う場合は、前回減らした時点またはスループットモードの変更時点から 24 時間経過している必要があります。詳細については、Amazon EFS ユーザーガイド の「プロビジョニングモードでのスループットの指定」を参照してください。

デフォルトは bursting です。

Type: 文字列

有効な値: bursting | provisioned

: 必須 いいえ

レスポンスの構文

HTTP/1.1 201 Content-type: application/json { "AvailabilityZoneId": "string", "AvailabilityZoneName": "string", "CreationTime": number, "CreationToken": "string", "Encrypted": boolean, "FileSystemArn": "string", "FileSystemId": "string", "KmsKeyId": "string", "LifeCycleState": "string", "Name": "string", "NumberOfMountTargets": number, "OwnerId": "string", "PerformanceMode": "string", "ProvisionedThroughputInMibps": number, "SizeInBytes": { "Timestamp": number, "Value": number, "ValueInIA": number, "ValueInStandard": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThroughputMode": "string" }

レスポンス要素

アクションが成功すると、HTTP 201 レスポンスが返されます。

サービスから以下のデータが JSON 形式で返されます。

AvailabilityZoneId

ファイルシステムの 1 ゾーンストレージクラスが存在するアベイラビリティーゾーンの一意で一貫性のある識別子。たとえば、use1-az1 は us-east-1 AWS リージョン のアベイラビリティーゾーン ID であり、すべての AWS アカウント で同じ場所を示します。

Type: 文字列

AvailabilityZoneName

ファイルシステムが配置されている AWS アベイラビリティーゾーンについて説明します。これは、1ゾーンのストレージクラスを使用しているファイルシステムでのみ有効です。詳細については、『Amazon EFS ユーザーガイド』の「EFS ストレージクラスの使用」を参照してください。

Type: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

パターン: .+

CreationTime

ファイルシステムが作成された時間 (秒単位) (1970-01-01T00:00:00Z から)。

Type: タイムスタンプ

CreationToken

リクエストで指定された不透明な文字列。

Type: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

パターン: .+

Encrypted

true の場合はファイルシステムの暗号化を示すブール値。

Type: [Boolean] (ブール値)

FileSystemArn

EFS ファイルシステムの Amazon リソースネーム (ARN)、フォーマット arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id 。サンプルデータの例:arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

Type: 文字列

FileSystemId

Amazon EFS によって割り当てられたファイルシステムの ID。

Type: 文字列

長さの制約: 最大長は 128 です。

Pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

KmsKeyId

のIDAWS KMS key暗号化されたファイルシステムの保護に使用されます。

Type: 文字列

長さの制約: 最大長は 2,048 です。

パターン: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$

LifeCycleState

ファイルシステムのライフサイクルフェーズ。

Type: 文字列

有効な値: creating | available | updating | deleting | deleted | error

Name

Name タグを含むタグをファイルシステムに追加することができます。詳細については、「CreateFileSystem」を参照してください。ファイルシステムに Name タグがある場合、Amazon EFS はこのフィールドの値を返します。

Type: 文字列

長さの制約: 最大長は 256 です。

パターン: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

NumberOfMountTargets

ファイルシステムが持つ現在のマウントターゲットの数。詳細については、「CreateMountTarget」を参照してください。

Type: 整数

有効範囲: 最小値は 0 です。

OwnerId

ファイルシステムを作成した AWS アカウント。ファイルシステムが IAM ユーザーによって作成された場合、ユーザーが属する親アカウントが所有者です。

Type: 文字列

長さの制約: 最大長は 14 です。

パターン: ^(\d{12})|(\d{4}-\d{4}-\d{4})$

PerformanceMode

ファイル システムのパフォーマンス モード。

Type: 文字列

有効な値: generalPurpose | maxIO

ProvisionedThroughputInMibps

ファイルシステムのプロビジョニングされたスループットの量を MiB/s で表したもの。ThroughputModeprovisioned に設定したファイルシステムで有効です。

Type: Double

有効範囲: 最小値は 1.0 です。

SizeInBytes

ファイルシステムに保存されているデータの最新の既知の計測サイズ(バイト単位)を Value のフィールドに、そのサイズが決定された時刻を Timestamp のフィールドに入力しています。Timestamp 値は、1970-01-01T00:00:00Z 以降の整数秒数です。SizeInBytes値は、ファイルシステムの一貫したスナップショットのサイズを表すものではありませんが、ファイルシステムへの書き込みがない場合に結果整合性があります。つまり、SizeInBytesは、ファイルシステムが 2 時間以上変更されていない場合のみ、実際のサイズを表します。それ以外の場合、値はファイルシステムの特定の時点での正確なサイズではありません。

型: FileSystemSize オブジェクト

Tags

ファイルシステムに関連するタグで、Tag のオブジェクトの配列として表示されます。

Type: の配列Tagオブジェクト

ThroughputMode

ファイルシステムのスループットモードを表示します。詳細については、『Amazon EFS ユーザーガイド』の「スループットモード」を参照してください。

Type: 文字列

有効な値: bursting | provisioned

エラー

BadRequest

リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータがないなどのエラーが含まれている場合に返されます。

HTTP ステータスコード: 400

FileSystemAlreadyExists

作成しようとしているファイルシステムがすでに存在し、指定した作成トークンを使用して返されます。

HTTP ステータスコード: 409

FileSystemLimitExceeded

AWS アカウント がアカウントごとに許可されるファイルシステムの最大数をすでに作成している場合に返されます。

HTTP ステータスコード: 403

InsufficientThroughputCapacity

追加のスループットをプロビジョニングするのに十分な容量がない場合に返されます。この値は、プロビジョニングされたスループットモードでファイルシステムを作成しようとしたとき、既存のファイルシステムのプロビジョニングされたスループットを上げようとしたとき、または既存のファイルシステムをバーストスループットからプロビジョニングされたスループットモードに変更しようとしたときに返されることがあります。後ほどもう一度試してください。

HTTP ステータスコード: 503

InternalServerError

サーバー側でエラーが発生した場合に返されます。

HTTP ステータスコード: 500

ThroughputLimitExceeded

スループット制限の 1024 MiB/s に達したため、スループットモードまたはプロビジョニングされたスループットの量を変更できない場合に返されます。

HTTP ステータスコード: 400

UnsupportedAvailabilityZone

リクエストされた Amazon EFS 機能が指定されたアベイラビリティーゾーンで利用できない場合に返されます。

HTTP ステータスコード: 400

暗号化された EFS ファイルシステムの作成

次の例では、POST リクエストを送信して、自動バックアップが有効になっている us-west-2 リージョンにファイルシステムを作成します。このリクエストでは、べき等の作成トークンとして myFileSystem1 を指定します。

リクエスト例

POST /2015-02-01/file-systems HTTP/1.1 Host: elasticfilesystem.us-west-2.amazonaws.com x-amz-date: 20140620T215117Z Authorization: <...> Content-Type: application/json Content-Length: 42 { "CreationToken" : "myFileSystem1", "PerformanceMode" : "generalPurpose", "Backup": true, "Encrypted": true, "Tags":[ { "Key": "Name", "Value": "Test Group1" } ] }

レスポンス例

HTTP/1.1 201 Created x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: application/json Content-Length: 319 { "ownerId":"251839141158", "CreationToken":"myFileSystem1", "Encrypted": true, "PerformanceMode" : "generalPurpose", "fileSystemId":"fs-01234567", "CreationTime":"1403301078", "LifeCycleState":"creating", "numberOfMountTargets":0, "SizeInBytes":{ "Timestamp": 1403301078, "Value": 29313417216, "ValueInIA": 675432, "ValueInStandard": 29312741784 }, "Tags":[ { "Key": "Name", "Value": "Test Group1" } ], "ThroughputMode": "bursting" }

1 ゾーンストレージクラスを使用する暗号化 EFS ファイルシステムを作成する

次の例では、POST リクエストを送信して、自動バックアップが有効になっている us-west-2 リージョンにファイルシステムを作成します。ファイルシステムには、us-west-2b アベイラビリティーゾーンに 1 ゾーンストレージの冗長性があります。

リクエスト例

POST /2015-02-01/file-systems HTTP/1.1 Host: elasticfilesystem.us-west-2.amazonaws.com x-amz-date: 20140620T215117Z Authorization: <...> Content-Type: application/json Content-Length: 42 { "CreationToken" : "myFileSystem2", "PerformanceMode" : "generalPurpose", "Backup": true, "AvailabilityZoneName": "us-west-2b", "Encrypted": true, "ThroughputMode": "provisioned", "ProvisionedThroughputInMibps": 60, "Tags":[ { "Key": "Name", "Value": "Test Group1" } ] }

レスポンス例

HTTP/1.1 201 Created x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: application/json Content-Length: 319 { "ownerId":"251839141158", "CreationToken":"myFileSystem1", "Encrypted": true, "AvailabilityZoneId": "usew2-az2", "AvailabilityZoneName": "us-west-2b", "PerformanceMode" : "generalPurpose", "fileSystemId":"fs-01234567", "CreationTime":"1403301078", "LifeCycleState":"creating", "numberOfMountTargets":0, "ProvisionedThroughputInMibps": 60, "SizeInBytes":{ "Timestamp": 1403301078, "Value": 29313417216, "ValueInIA": 675432, "ValueInStandard": 29312741784 }, "Tags":[ { "Key": "Name", "Value": "Test Group1" } ], "ThroughputMode": "provisioned" }

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください: