ストレージ認証情報の登録コマンド

Amazon S3でのストレージ認証情報をクラウドストレージDBに登録します。

コマンド形式

utls3infoadd [COMMON-OPTIONS] -t auth --id ID [AUTH-OPTIONS]

パラメーター説明

[COMMON-OPTIONS]

ユーティリティーで共通のオプションです。

-r, --replace

置換（省略可）

既存のストレージ認証情報を上書きします。

このオプションを指定しないで既存のストレージ管理情報を上書きしようとした場合は、エラーとなります。

注意

既存のストレージ認証情報に上書きする場合、すでに設定されている値は[AUTH-OPTIONS]で指定してください。

設定済みの情報を再指定しなかった場合、未設定（Use the default value.）で上書きされます。

-f, --force

確認の省略（省略可）

登録する情報の確認を行わずに情報が登録されます。

既存のストレージ認証情報が指定された場合、「-r」または「--replace」が指定されていなくても情報が上書きされます。

省略すると、ストレージ認証情報を登録する前に以下の確認のメッセージが表示されます。

Are you sure to register? [y/n]:

“y”または”Y”を入力すると、コマンドで指定したストレージ認証情報が登録されます。

“y”または”Y”以外を入力した場合、エラーで終了されます。

[REQUIRED]

省略できないパラメーターです。

-t, --type auth

情報の種別（省略不可）

auth

: ストレージ認証情報

--id ID

ID（省略不可）

ストレージの認証情報を認識するためのIDです。

3バイトから63バイトまでのASCII印字可能文字で指定します。

半角スペース、「/」、「*」の文字が含まれていた場合はエラーとなります。

[AUTH-OPTIONS]

ストレージ認証情報を設定するオプションです。

注意

  • 「IAMロール有効化（--enable-iam-role）」を指定した場合、「AWSアクセスキー（--access-key KEY）」、「AWSシークレットアクセスキー（--secret-access-key KEY）」および「セッショントークン（--session-token TOKEN）」は指定できません。

    AWSアクセスキーおよびAWSシークレットアクセスキーを使用する認証の「IAMユーザー認証」と「IAMロール有効化」の使用優先順位については、「ストレージ認証情報の設定」を参照してください。

    AWSアクセスキー、AWSシークレットアクセスキーおよびセッショントークンを使用する認証の「一時的なセキュリティ認証」と「IAMロール有効化」の使用優先順位については、「ストレージ認証情報の設定」を参照してください。

  • 「スイッチロールARN（--switch-role-arn ARN）」、「外部ID（--external-id ID）」および「ロールセッション名（--role-session-name NAME）」は必ず同時に指定してください。

    それぞれの値を個別に指定することはできません。

  • 「セッショントークン（--session-token TOKEN）」を指定した場合、以下の値も必ず同時に指定してください。

    • AWSアクセスキー（--access-key KEY）

    • AWSシークレットアクセスキー（--secret-access-key KEY）

--access-key KEY

AWSアクセスキー（省略可）

Amazon Web Serviceに接続するために、アップロードまたはダウンロードするAWSユーザーに関連付けられたアクセスキーを指定します。

1バイトから255バイトまでのASCII印字可能文字で指定します。

省略すると、未設定（Use the default value.）となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。

--secret-access-key KEY

AWSシークレットアクセスキー（省略可）

Amazon Web Serviceに接続するために、アクセスキーに関連付けられたシークレットキー（パスワード）を指定します。

1バイトから255バイトまでのASCII印字可能文字で指定します。

省略すると、未設定（Use the default value.）となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。

--session-token TOKEN

セッショントークン（省略可）

Amazon Web Serviceに接続するために、一時的セキュリティ認証情報を使用して接続を行うセッショントークンを指定します。

1バイトから2048バイトまでのASCII印字可能文字を指定します。

なお、“none”を設定した場合、セッショントークンは無効となります。

省略すると、未設定（Use the default value.）となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。

--enable-iam-role

IAMロール有効化（省略可）

Amazon EC2上にHULFTおよびHULFT クラウドストレージオプションがインストールされている場合、Amazon EC2に紐づけられたIAMロールを使用した認証を、有効にするかどうかを指定します。

パラメーターを指定した場合、IAMロールを使用した認証が有効となります。この場合、Amazon EC2に紐づけられているIAMロールの認証情報を使用します。

省略すると、未設定（Use the default value.）となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。

= 備考 =

HULFTおよびHULFT クラウドストレージオプションがAmazon EC2以外の環境にインストールされている場合、IAMロールを有効にすると転送時にエラーとなります。

--switch-role-arn ARN

スイッチロールARN（省略可）

IAMロールの切り替えの切り替え先のAmazon Resource Name（ARN）を指定します。

2バイトから2048バイトまでのASCII印字可能文字で指定します。

なお、“none”を設定した場合、スイッチロールARNは無効となり、IAMロールの切り替えは行いません。

省略すると、未設定（Use the default value.）となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。

--external-id ID

外部ID（省略可）

IAMロールの切り替え時に使用する外部IDを指定します。

2バイトから2048バイトまでのASCII印字可能文字で指定します。

なお、“none”を設定した場合、外部IDは無効となります。

省略すると、未設定（Use the default value.）となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。

--role-session-name NAME

ロールセッション名（省略可）

IAMロールの切り替え時に使用するロールセッション名を指定します。

2バイトから255バイトまでのASCII印字可能文字で指定します。

なお、“none”を設定した場合、ロールセッション名は無効となり、転送時には以下の固定値が使用されます。

  • アップロードの場合：HULFT-S3-Upload

  • ダウンロードの場合：HULFT-S3-Download

省略すると、未設定（Use the default value.）となります。未設定の場合、転送時にはデフォルト情報の設定値が使用されます。

補足

  • 以下のように、パラメーターと設定値の間にはスペースまたはイコール（=）のどちらでも指定できます。

      --parameter Value
  --parameter=Value

  • パラメーターに「-h」または「--help」を指定すると、Usageが表示されます。