ストレージ認証情報のデフォルト情報の登録コマンド(Amazon S3)
Amazon S3でのストレージ認証情報のデフォルト情報をクラウドストレージDBに登録します。
ストレージ認証情報のデフォルト情報の登録コマンド
utls3infoadd [COMMON-OPTIONS] -t auth --default [AUTH-OPTIONS]
パラメータ説明
- [COMMON-OPTIONS]
-
ユーティリティで共通のオプションです。
- -f, --force
-
確認の省略(省略可)
登録する情報の確認を行わずに情報が登録されます。
省略すると、ストレージ認証情報のデフォルト情報を登録する前に確認のメッセージが表示されます。
Are you sure to register? [y/n]:
“y”または”Y”を入力すると、コマンドで指定したストレージ認証情報のデフォルト情報が登録されます。
“y”または”Y”以外を入力した場合、エラーで終了されます。
- [REQUIRED]
-
省略できないパラメータです。
- -t, --type auth
-
情報の種別(省略不可)
- auth
-
: ストレージ認証情報
- --default
-
デフォルト情報の変更(省略不可)
ストレージ認証情報のデフォルト情報が登録されます。
- [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アクセスキーIDを指定します。
1バイトから255バイトまでのASCII印字可能文字で指定します。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時には環境変数(AWS_ACCESS_KEY_ID)に設定した値が使用されます。
- --secret-access-key KEY
-
AWSシークレットアクセスキー(省略可)
Amazon Web Serviceに接続するために、クラウドサービスから提供されるAWSシークレットアクセスキーを指定します。
1バイトから255バイトまでのASCII印字可能文字で指定します。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時には環境変数(AWS_SECRET_ACCESS_KEY)に設定した値が使用されます。
-
--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.)となります。未設定の場合、転送時にはIAMロールは無効となります。
= 備考 =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.)となります。未設定の場合、転送時にはスイッチロールARNは無効となります。
- --external-id ID
-
外部ID(省略可)
IAMロールの切り替え時に使用する外部IDを指定します。
2バイトから2048バイトまでのASCII印字可能文字で指定します。
なお、“none”を設定した場合、外部IDは無効となります。
省略すると、未設定(Use the default value.)となります。未設定の場合、転送時には外部IDは無効となります。
- --role-session-name NAME
-
ロールセッション名(省略可)
IAMロールの切り替え時に使用するロールセッション名を指定します。
2バイトから255バイトまでのASCII印字可能文字で指定します。
なお、“none”を設定した場合、ロールセッション名は無効となります。
省略すると、未設定(Use the default value.)となります。
ただし、個別設定とデフォルト設定で実際に使用する値として「スイッチロールARN」に“none”以外が設定されていて、「ロールセッション名」に“none”を設定または未設定の場合、転送時には以下の固定値を使用します。
-
アップロードの場合:HULFT-S3-Upload
-
ダウンロードの場合:HULFT-S3-Download
-
-
補足
-
以下のように、パラメータと設定値の間にはスペースまたはイコール(=)のどちらでも指定できます。
--parameter Value --parameter=Value
-
パラメータに「-h」または「--help」を指定すると、Usageが表示されます。