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 ゾーンストレージクラスの詳細については、「」を参照してください。EFS ストレージクラスの使用Amazon EFS ユーザーガイド

注記

1 ゾーンストレージクラスは、のすべてのアベイラビリティーゾーンでは利用できません。AWS リージョンAmazon EFS が利用可能な場所。

Type: 文字列

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

Pattern: .+

: 必須 いいえ

Backup

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

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

注記

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

Type: ブール値

必須 いいえ

CreationToken

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

Type: 文字列

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

Pattern: .+

必須 あり

Encrypted

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

Type: ブール値

必須 いいえ

KmsKeyId

の ID。AWS KMS暗号化されたファイルシステムの保護に使用する CMK。このパラメータは、デフォルト以外の KMS キーを使用する場合にのみ必要です。このパラメータが指定されない場合、Amazon EFS のデフォルトの CMK が使用されます。この 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 キーのみを受け入れます。EFS ファイルシステムでは非対称 KMS キーを使用することはできません。

Type: 文字列

長さの制限: 最大長は 2048 です。

Pattern: ^([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: の配列Tagobjects

: 必須 いいえ

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-az1us-east-1 のアベイラビリティーゾーン ID ですかAWS リージョンであり、すべての場所で同じ場所になりますAWS アカウント。

Type: 文字列

AvailabilityZoneName

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

Type: 文字列

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

Pattern: .+

CreationTime

ファイルシステムが作成された時間 (1970-01-01T 00:00:00 Z) を秒単位で指定します。

Type: タイムスタンプ

CreationToken

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

Type: 文字列

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

Pattern: .+

Encrypted

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

Type: ブール値

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 Key Management Service暗号化されたファイルシステムの保護に使用されたカスタマーマスターキー (CMK)。

Type: 文字列

長さの制限: 最大長は 2048 です。

Pattern: ^([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 です。

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

NumberOfMountTargets

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

Type: 整数

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

OwnerId

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

Type: 文字列

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

Pattern: ^(\d{12})|(\d{4}-\d{4}-\d{4})$

PerformanceMode

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

Type: 文字列

有効な値: generalPurpose | maxIO

ProvisionedThroughputInMibps

ファイルシステムのプロビジョニングされたスループット (MiB/秒単位で計測)。を使ってファイルシステムに対して有効ThroughputModeに設定するprovisioned

Type: Double

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

SizeInBytes

ファイル・システムに格納されているデータの最新の既知のメーター・サイズ(バイト単位)。Valueフィールド、およびそのサイズがその中で決定された時刻Timestampフィールド。-Timestamp値は、1970-01T 00:00:00 Z からの整数秒数です。-SizeInBytes値は、ファイルシステムの整合したスナップショットのサイズを表すものではありませんが、最終的に、ファイルシステムへの書き込みがないときに整合されます。つまり、SizeInBytesは、ファイルシステムが 2 時間以上変更されていない場合のみ、実際のサイズを表します。それ以外の場合、値はファイルシステムの特定の時点での正確なサイズではありません。

タイプ: FileSystemSize オブジェクト

Tags

ファイルシステムに関連付けられたタグ。Tagオブジェクト。

Type: の配列Tagobjects

ThroughputMode

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

Type: 文字列

有効な値: bursting | provisioned

Errors

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

Examples

暗号化された 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自動バックアップが有効になっているリージョン。ファイルシステムには、1 つのゾーンストレージ冗長性がus-west-2bアベイラビリティーゾーン。

リクエスト例

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 を使用する方法の詳細については、次を参照してください。