5.2.10 ファイルの削除
機能
この部品は，Amazon S3環境で管理されているファイルを削除します。
この部品が前提とするサーバを次に示します。
・AWS操作サーバ(実行対象サーバ)
AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によりこのサーバに部品が転送され，実行されます。
この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。
Remove-S3Object -BucketName "バケット名(AWS.bucketNameプロパティ)の値"
-Key "キー名(AWS.keyNameプロパティ)の値"
-Force
AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。
利用場面
この部品は，Amazon S3環境で管理されているファイルを削除する場合に使用できます。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
・AWS Tools for Windows PowerShell
・Microsoft .Net Framework 3.5以降
【実行対象サーバ内前提製品の稼働OS】
・Windows Server
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。
実行権限
(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。
・ファイルの削除
バージョン
02.00.00
部品のタグ
File Operations,AWS
タスクログに表示される部品の名称
awsDeleteFile
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
AWS.accessKeyId |
アクセスキーID |
AWSに接続するためのアクセスキーIDを指定します。 |
− |
入力 |
○ |
|
AWS.secretAccessKey |
シークレットアクセスキー |
AWSに接続するためのシークレットアクセスキーを指定します。 |
− |
入力 |
○ |
|
AWS.region |
リージョン |
接続先となるAWSのリージョンを指定します。 |
− |
入力 |
○ |
|
AWS.bucketName |
バケット名 |
バケット名を指定します。 |
− |
入力 |
○ |
|
AWS.keyName |
キー名 |
削除するファイルのキー名を指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |