ストレージ認証情報の項目一覧
Amazon S3のストレージ認証情報の入出力ファイルの項目は以下のとおりです。
項目一覧
項目名 |
キー |
値の形式 |
備考 |
---|---|---|---|
ストレージ認証情報の配列 |
auth_info |
array |
|
ID |
id |
string |
3~63バイト以内 |
AWSアクセスキー |
access_key |
string |
1~255バイト以内 |
AWSシークレットアクセスキー |
secret_access_key |
string |
1~255バイト以内 |
セッショントークン |
session_token |
string |
1~2048バイト以内 |
IAMロール有効化 |
enable_iam_role |
boolean |
|
スイッチロールARN |
switch_role_arn |
string |
2~2048バイト以内 |
外部ID |
external_id |
string |
2~2048バイト以内 |
ロールセッション名 |
role_session_name |
string |
2~255バイト以内 |
各項目の説明
-
管理情報のインポートを行う場合、「IAMロール有効化」を指定すると、「AWSアクセスキー」、「AWSシークレットアクセスキー」および「セッショントークン」は指定できません。
AWSアクセスキーおよびAWSシークレットアクセスキーを使用する認証の「IAMユーザー認証」と「IAMロール有効化」の使用優先順位については、「ストレージ認証情報の設定」を参照してください。
AWSアクセスキー、AWSシークレットアクセスキーおよびセッショントークンを使用する認証の「一時的なセキュリティ認証」と「IAMロール有効化」の使用優先順位については、「ストレージ認証情報の設定」を参照してください。
-
管理情報のインポートを行う場合、「スイッチロールARN」、「外部ID」および「ロールセッション名」は必ず同時に指定してください。
それぞれの値を個別に指定することはできません。
-
管理情報のインポートを行う場合、「セッショントークン」を指定した際は、以下の値も必ず同時に指定してください。
-
AWSアクセスキー
-
AWSシークレットアクセスキー
-
-
ストレージ認証情報の配列(auth_info)
-
ストレージ認証情報の配列(省略不可)
ストレージ認証情報の配列です。
ストレージ認証情報の各項目については、この配列の中にIDごとに情報を記載します。
-
ID(id)
-
ID(省略不可)
ストレージ認証情報IDです。
3バイトから63バイトまでのASCII印字可能文字で指定します。
半角スペース、「/」、「*」の文字が含まれていた場合はエラーとなります。
-
AWSアクセスキー(access_key)
-
AWSアクセスキー(省略可)
Amazon Web Serviceに接続するために、アップロードまたはダウンロードするAWSユーザーに関連付けられたアクセスキーです。
管理情報のインポートを行う場合、1バイトから255バイトまでのASCII印字可能文字で指定します。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。
管理情報のエクスポートを行う場合、値が登録されていると出力されます。
登録されていない場合、何も出力されません。
-
AWSシークレットアクセスキー(secret_access_key)
-
AWSシークレットアクセスキー(省略可)
Amazon Web Serviceに接続するために、アクセスキーに関連付けられたシークレットキー(パスワード)です。
管理情報のインポートを行う場合、1バイトから255バイトまでのASCII印字可能文字で指定します。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。
管理情報のエクスポートを行う場合、値が登録されていると出力されます。
登録されていない場合、何も出力されません。
-
セッショントークン(session_token)
-
セッショントークン(省略可)
Amazon Web Serviceに接続するために、一時的セキュリティ認証情報を使用して接続を行うセッショントークンを指定します。
管理情報のインポートを行う場合、1バイトから2048バイトまでのASCII印字可能文字を指定します。
なお、“none”を設定した場合、セッショントークンは無効となります。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。
管理情報のエクスポートを行う場合、値が登録されていると出力されます。
登録されていない場合、何も出力されません。
-
IAMロール有効化(enable_iam_role)
-
IAMロール有効化(省略可)
Amazon EC2上にHULFTおよびHULFT クラウドストレージオプションがインストールされている場合、Amazon EC2に紐づけられたIAMロールを使用した認証を、有効にするかどうかです。
管理情報のインポートを行う場合、IAMロールを有効化する場合は“true”を指定してください。この場合、Amazon EC2に紐づけられているIAMロールの認証情報を使用します。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。
管理情報のエクスポートを行う場合、値が登録されていると出力されます。
登録されていない場合、何も出力されません。
= 備考 =HULFTおよびHULFT クラウドストレージオプションがAmazon EC2以外の環境にインストールされている場合、IAMロールを有効にすると転送時にエラーとなります。
-
スイッチロールARN(switch_role_arn)
-
スイッチロールARN(省略可)
IAMロールの切り替えの切り替え先のAmazon Resource Name(ARN)です。
管理情報のインポートを行う場合、2バイトから2048バイトまでのASCII印字可能文字で指定します。
なお、“none”を設定した場合、スイッチロールARNは無効となり、IAMロールの切り替えは行いません。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。
管理情報のエクスポートを行う場合、値が登録されていると出力されます。
登録されていない場合、何も出力されません。
-
外部ID(external_id)
-
外部ID(省略可)
IAMロールの切り替え時に使用する外部IDです。
管理情報のインポートを行う場合、2バイトから2048バイトまでのASCII印字可能文字で指定します。
なお、“none”を設定した場合、外部IDは無効となります。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。
管理情報のエクスポートを行う場合、値が登録されていると出力されます。
登録されていない場合、何も出力されません。
-
ロールセッション名(role_session_name)
-
ロールセッション名(省略可)
IAMロールの切り替え時に使用するロールセッション名です。
管理情報のインポートを行う場合、2バイトから255バイトまでのASCII印字可能文字で指定します。
なお、“none”を設定した場合、ロールセッション名は無効となり、転送時には以下の固定値が使用されます。
-
アップロードの場合:HULFT-S3-Upload
-
ダウンロードの場合:HULFT-S3-Download
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。
管理情報のエクスポートを行う場合、値が登録されていると出力されます。
登録されていない場合、何も出力されません。
-