このページでは、ワークフロー自動化アクションカタログで利用可能なAWS EC2アクションのリファレンスを提供します。これらのアクションを使用して、EC2インスタンス、EBSボリュームとスナップショット、Elastic IPアドレス、Amazon Machine Images(AMI)、セキュリティグループ、キーペア、およびEC2リソースタグを管理します。
前提条件
ワークフロー自動化で AWS アクションを使用する前に、次の点を確認してください。
- 適切な権限を持つ AWS アカウント。
- 設定された AWS 認証情報 (IAM ユーザー認証情報、IAM ロール ARN、またはセッション認証情報)。
- 使用する予定の特定のAWSサービスに必要な IAM 権限。
IAM ユーザーおよび IAM ロールを作成する方法、およびワークフロー オートメーションAWSアクションと統合するための静的 AWS 認証情報とセッションAWS認証情報を設定する方法については、 AWS認証情報のセットアップ」を参照してください。
インスタンスを実行する
アクション識別子はaws.ec2.runInstancesです。
権限を持つAMIを使用して、指定された数のインスタンスをリリースします。サブネットIDを指定しない場合、デフォルトのVPCサブネットが使用されます。ユーザーがサブスクライブしていない製品コードを持つAMIがある場合、リクエストは失敗します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスがリリースされるAWSリージョン。 |
|
| 弦 | 必須。インスタンスに使用するAMIのIDです。 |
|
| 弦 | 必須。インスタンスに使用するインスタンスタイプ。 |
|
| Int | 必須。リリースするインスタンスの最小数。 |
|
| Int | 必須。リリースするインスタンスの最大数。 |
|
| 地図 | オプション。run_instances呼び出しの追加のboto3 APIパラメーター。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
ヒント
parameters マップは、boto3 API で利用可能な任意のオプション引数を受け入れるため、requests を動的に構築できます。
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
インスタンスを説明する
アクション識別子はaws.ec2.describeInstancesです。
指定されたインスタンスまたはすべてのインスタンスについて説明します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| リスト | オプション。記述するインスタンスIDの一覧。 |
|
| リスト | オプション。describeリクエストに適用するフィルター。 |
|
| 弦 | オプション。以前のレスポンスからのページネーショントークン。 |
|
| Int | オプション。返す結果の最大数です。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | describe_instances boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
重要
インスタンスIDを指定した場合、出力には指定されたインスタンスの情報のみが含まれます。フィルターを指定した場合、出力にはフィルター条件を満たすインスタンスの情報のみが含まれます。どちらも指定しない場合、出力にはすべてのインスタンスの情報が含まれます。instanceIdsパラメーターはmaxResultsと一緒に使用できません。
インスタンスを再起動する
アクション識別子はaws.ec2.startInstancesです。
以前に停止した Amazon EBS ベースのインスタンスを起動します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| リスト | 必須。開始するインスタンスIDの一覧。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
インスタンスを停止する
アクション識別子はaws.ec2.stopInstancesです。
Amazon EBS-backed インスタンスを停止します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| リスト | 必須。停止するインスタンスIDの一覧。 |
|
| ブール値 | オプション。インスタンスを停止する代わりにHibernateします。デフォルト:
。 |
|
| ブール値 | オプション。インスタンスの停止を強制します。デフォルト:
。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
インスタンスの再起動をリクエストします
アクション識別子はaws.ec2.rebootInstancesです。
指定されたインスタンスの再起動をリクエストします。この操作は非同期です — 指定されたインスタンスを再起動するリクエストをキューに入れるだけです。インスタンスが有効であり、お客様の所有である場合、操作は成功します。終了したインスタンスを再起動するリクエストは無視されます。インスタンスが数分以内に正常にシャットダウンしない場合、Amazon EC2はハードリブートを実行します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| リスト | 必須。再起動するインスタンスIDの一覧。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
インスタンスをシャットダウンする
アクション識別子はaws.ec2.terminateInstancesです。
指定されたインスタンスをシャットダウンします。この操作はべき等です — インスタンスを複数回終了しても、各呼び出しは成功します。複数のインスタンスを指定してリクエストが失敗した場合(たとえば、1つの誤ったインスタンスIDが原因の場合)、どのインスタンスも終了しません。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| リスト | 必須。終了するインスタンスのID。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | terminate_instances boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
EBSスナップショットを作成する
アクション識別子はaws.ec2.createSnapshotです。
EBSボリュームのスナップショットを作成し、Amazon S3に保存します。スナップショットは、バックアップ、EBSボリュームのコピーの作成、およびインスタンスをシャットダウンする前のデータの保存に使用できます。ソースEBSボリュームの場所によって、スナップショットを作成できる場所が決まります。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。EBSボリュームが配置されているAWSリージョン。 |
|
| 弦 | 必須。スナップショットを作成するEBSボリュームのID。 |
|
| 弦 | オプション。スナップショットの説明。 |
|
| 弦 | オプション。スナップショットを作成するOutpostのAmazonリソースネーム(ARN)。 |
|
| リスト | オプション。作成時にスナップショットに適用するタグ。 |
|
| 弦 | オプション。スナップショットの場所。有効な値:
、
。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
スナップショットを削除する
アクション識別子はaws.ec2.deleteSnapshotです。
指定されたスナップショットを削除します。登録済みのAMIで使用されているEBSボリュームのルートデバイスのスナップショットは削除できません — スナップショットを削除する前に、まずAMIの登録を解除する必要があります。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。スナップショットが配置されている AWS リージョン。 |
|
| 弦 | 必須。削除するスナップショットのID。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功時にレスポンスボディはありません。 を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
Elastic IP アドレスの割り当て
アクション識別子はaws.ec2.allocateAddressです。
VPC内のEC2インスタンスで使用する新しいElastic IPアドレスを割り当てます。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。アドレスが割り当てられているAWSリージョン。 |
|
| 弦 | オプション。アドレスのスコープ。VPCインスタンスには
を使用します。 |
|
| 弦 | オプション。以前に解放した、復元対象の特定のElastic IPアドレス。 |
|
| 弦 | オプション。IPアドレスがアドバタイズされるグループを制限します。 |
|
| リスト | オプション。割り当て時にアドレスに適用されるタグ。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
Elastic IPアドレスを関連付ける
アクション識別子はaws.ec2.associateAddressです。
Elastic IPアドレスをEC2インスタンスまたはネットワークインターフェイスに関連付けます。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。関連付けが行われるAWSリージョン。 |
|
| 弦 | オプション。関連付けるElastic IP割り当てID。VPCインスタンスの場合は、
または
とともに使用します。 |
|
| 弦 | オプション。アドレスを関連付けるインスタンス。 |
|
| 弦 | オプション。EC2-Classicアドレスの
の代替。 |
|
| 弦 | オプション。インスタンスの代わりとなるターゲットネットワークインターフェイス。 |
|
| 弦 | オプション。関連付けるネットワークインターフェイス上の特定のプライベートIP。 |
|
| ブール値 | オプション。アドレスを既存の関連付けから移動できるようにします。デフォルト:
。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
重要
識別子の特定の組み合わせのみが有効です。VPCインスタンスの場合は、allocationIdをinstanceIdまたはnetworkInterfaceIdとともに使用します。EC2-Classicインスタンスの場合は、publicIpとinstanceIdを使用してください。2つの形式を混在させないでください。
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
Elastic IPアドレスの関連付け解除
アクション識別子はaws.ec2.disassociateAddressです。
現在のインスタンスまたはネットワークインターフェイスからElastic IPアドレスの関連付けを解除します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。関連付けが存在するAWSリージョン。 |
|
| 弦 | オプション。
によって返される関連付けID。VPCアドレスに使用します。 |
|
| 弦 | オプション。EC2-Classicアドレスの
の代替。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
重要
アドレスが関連付けられたドメインに一致する識別子を1つだけ使用します。VPCアドレスの場合は、associationIdを使用します。EC2-Classicアドレスの場合は、publicIpを使用します。
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功時のレスポンス本文はありません。 disassociate_address boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
Elastic IPアドレスを解放する
アクション識別子はaws.ec2.releaseAddressです。
Elastic IPアドレスをAWSプールに解放します。アドレスを解放するには、事前に関連付けを解除しておく必要があります。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。アドレスが割り当てられているAWSリージョン。 |
|
| 弦 | オプション。解放するVPCアドレスのアロケーションID。 |
|
| 弦 | オプション。EC2-Classicアドレスの
の代替。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功時のレスポンスボディはありません。 を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
Elastic IPアドレスを記述します。
アクション識別子はaws.ec2.describeAddressesです。
Elastic IPアドレスとその現在の関連付けについて説明します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。結果をこれらのパブリックIPアドレスに制限します。 |
|
| リスト | オプション。結果をこれらの割り当てIDに制限します。 |
|
| リスト | オプション。クエリに適用するAWSフィルター。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | describe_addresses boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
タグを作成
アクション識別子はaws.ec2.createTagsです。
任意のEC2リソース — インスタンス、ボリューム、スナップショット、セキュリティグループ、AMIなど — にタグを追加または上書きします。同じキーを持つ既存のタグは上書きされます。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。リソースが配置されているAWSリージョン。 |
|
| リスト | 必須。タグ付けするEC2リソースのID。 |
|
| リスト | 必須。適用するタグのキーの値のペア。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功した場合、レスポンス本文はありません。 を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
タグを削除
アクション識別子はaws.ec2.deleteTagsです。
任意のEC2リソースからタグを削除します。指定されたリソースからすべてのタグを削除するには、tagsフィールドを省略します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。リソースが配置されているAWSリージョン。 |
|
| リスト | 必須。タグを削除するEC2リソースのID。 |
|
| リスト | オプション。削除するタグ。値に関係なくキーを削除するには、
を省略します。すべてのタグを削除するには、フィールドを完全に省略します。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功した場合、レスポンス本文はありません。 を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
タグの説明
アクション識別子はaws.ec2.describeTagsです。
リソースID、リソースタイプ、キー、または値によるオプションのフィルタリングを使用して、任意のEC2リソースタイプ全体のタグを記述します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。クエリに適用されるAWSフィルター。
、
、
または
でフィルタリングします。 |
|
| 弦 | オプション。以前のレスポンスからのページネーショントークン。 |
|
| Int | オプション。1ページあたりに返すタグの最大数。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
ボリュームの作成
アクション識別子はaws.ec2.createVolumeです。
指定されたアベイラビリティーゾーンに新しいEBSボリュームを作成します。ボリュームは、同じアベイラビリティーゾーン内のインスタンスにのみアタッチできます。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。ボリュームが作成されるAWSリージョン。 |
|
| 弦 | 必須。ボリュームを作成するアベイラビリティーゾーンです。 |
|
| Int | オプション。GiB単位のボリュームサイズ。
が指定されていない場合は必須です。 |
|
| 弦 | オプション。EBSボリュームタイプ。有効な値:
、
、
、
、
、
、
。デフォルト:
。 |
|
| 弦 | オプション。ボリュームの復元元となるスナップショット。 |
|
| Int | オプション。プロビジョンドIOPS。
、
、および
ボリュームにのみ有効です。 |
|
| Int | オプション。MiB/s単位のスループット。
ボリュームにのみ有効です。 |
|
| リスト | オプション。作成時にボリュームに適用されるタグ。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
ボリュームの削除
アクション識別子はaws.ec2.deleteVolumeです。
EBSボリュームを削除します。ボリュームを削除する前に、ボリュームはavailable状態(完全にデタッチ済み)である必要があります。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。ボリュームが配置されているAWSリージョン。 |
|
| 弦 | 必須。削除するボリュームのID。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功時のレスポンスボディはありません。 を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
ボリュームのアタッチ
アクション識別子はaws.ec2.attachVolumeです。
実行中または停止中のEC2インスタンスにEBSボリュームをアタッチします。ボリュームとインスタンスは同じアベイラビリティーゾーンにある必要があります。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。ボリュームとインスタンスが配置されているAWSリージョン。 |
|
| 弦 | 必須。アタッチするボリュームのIDです。
状態である必要があります。 |
|
| 弦 | 必須。アタッチするインスタンス。
または
である必要があります。 |
|
| 弦 | 必須。インスタンス上でボリュームが公開されるデバイス名。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
ボリュームのデタッチ
アクション識別子はaws.ec2.detachVolumeです。
EC2インスタンスからEBSボリュームをデタッチします。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。ボリュームが配置されているAWSリージョン。 |
|
| 弦 | 必須。デタッチするボリュームのIDです。 |
|
| 弦 | オプション。デタッチを特定のインスタンスに絞り込みます。ボリュームがマルチアタッチされている場合に便利です。 |
|
| 弦 | オプション。デタッチをインスタンス上の特定のデバイス名に絞り込みます。 |
|
| ブール値 | オプション。ゲストOSからアンマウントせずにデタッチを強制します。データ損失やファイルシステムの破損を引き起こす可能性があります。デフォルト:
。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
ボリュームの変更
アクション識別子はaws.ec2.modifyVolumeです。
EBSボリュームのサイズを変更するか、ボリュームタイプ、IOPS、またはスループットを変更します。EBSボリュームは拡張のみ可能で、縮小することはできません。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。ボリュームが配置されているAWSリージョン。 |
|
| 弦 | 必須。変更するボリュームのID。 |
|
| Int | オプション。GiB単位の新しいサイズ。 |
|
| 弦 | オプション。新しいボリュームタイプ。 |
|
| Int | オプション。新しいプロビジョンドIOPS。
、
、および
ボリュームにのみ有効です。 |
|
| Int | オプション。MiB/s単位の新しいスループット。
ボリュームにのみ有効です。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
ボリュームの説明
アクション識別子はaws.ec2.describeVolumesです。
EBSボリュームとそのアタッチメント状態を記述します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。結果を特定のボリュームIDに制限します。リージョン内のすべてのボリュームを記述するには省略します。 |
|
| リスト | オプション。サーバー側のフィルター(たとえば、
、
、または
によるもの)。 |
|
| 弦 | オプション。以前のレスポンスからのページネーショントークン。 |
|
| Int | オプション。1ページあたりに返すボリュームの最大数。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
スナップショットのコピー
アクション識別子はaws.ec2.copySnapshotです。
バックアップおよびディザスタリカバリのために、EBSスナップショットを別のリージョンにコピーします。regionフィールドは、宛先リージョンを指定します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。スナップショットがコピーされる宛先リージョン。 |
|
| 弦 | 必須。コピーするスナップショットのID。 |
|
| 弦 | 必須。ソーススナップショットが現在存在するリージョン。 |
|
| 弦 | オプション。新しいスナップショットに適用される説明。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
スナップショットの記述
アクション識別子はaws.ec2.describeSnapshotsです。
所有者、ボリューム、またはフィルター条件によってEBSスナップショットを記述します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。結果を特定のスナップショットIDに制限します。 |
|
| リスト | オプション。スナップショットの所有者でフィルターします。呼び出し元アカウントが所有するスナップショットのみを返すには、
を使用します。 |
|
| リスト | オプション。ボリューム、ステータス、タグなどによるAWSフィルター。 |
|
| 弦 | オプション。以前のレスポンスからのページネーショントークン。 |
|
| Int | オプション。1ページあたりに返すスナップショットの最大数。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | describe_snapshots boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
画像を作成する
アクション識別子はaws.ec2.createImageです。
実行中または停止中のEC2インスタンスからAmazon Machine Image(AMI)を作成します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| 弦 | 必須。イメージをキャプチャするEC2インスタンス。 |
|
| 弦 | 必須。新しいAMIの名前。リージョン内で一意である必要があります。 |
|
| 弦 | オプション。AMIの自由形式の説明。 |
|
| ブール値 | オプション。
の場合、ファイルシステムの一貫性があるイメージを保証するために、AWSはインスタンスをシャットダウンして再起動します。イメージの一貫性を犠牲にして再起動をスキップするには、
を設定します。デフォルト:
。 |
|
| リスト | オプション。作成時に新しいAMIとそのスナップショットに適用されるタグです。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
イメージのコピー
アクション識別子はaws.ec2.copyImageです。
ディザスタリカバリまたはマルチリージョンデプロイメントのために、Amazon Machine Image(AMI)を別のリージョンにコピーします。regionフィールドは、宛先リージョンを指定します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。コピーが作成される宛先リージョン。 |
|
| 弦 | 必須。コピーするAMI。 |
|
| 弦 | 必須。現在ソースAMIを保持しているリージョン。 |
|
| 弦 | オプション。宛先リージョンの新しいAMIの名前。 |
|
| 弦 | オプション。コピーされたAMIの自由形式の説明。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
イメージの登録解除
アクション識別子はaws.ec2.deregisterImageです。
所有しているAmazon Machine Image(AMI)の登録を解除します。AMIの登録を解除しても、そのバッキングEBSスナップショットは削除されません — ストレージコストの発生を防ぐには、それらを個別に削除してください。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。AMIが登録されているAWSリージョン。 |
|
| 弦 | 必須。登録解除するAMI。呼び出し元アカウントが所有するAMIである必要があります。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
イメージの記述
アクション識別子はaws.ec2.describeImagesです。
アカウントが所有している、アカウントと共有されている、またはアカウントに公開されているAmazon Machine Imageを記述します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。結果を特定のAMI IDに制限します。 |
|
| リスト | オプション。所有者で結果を絞り込みます。AWSアカウントID、
、
、または
を受け入れます。 |
|
| リスト | オプション。サーバー側のフィルター(たとえば、
、
、または
によるもの)。 |
|
| 弦 | オプション。以前のレスポンスからのページネーショントークン。 |
|
| Int | オプション。1ページあたりに返すAMIの最大数。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
インスタンスのステータスを記述します。
アクション識別子はaws.ec2.describeInstanceStatusです。
システムおよびインスタンスのステータスチェックやスケジュールされたイベントなど、1つ以上のEC2インスタンスのステータスを記述します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。確認するインスタンスID。省略した場合、すべてのインスタンスが返されます。 |
|
| ブール値 | オプション。
の場合、実行中以外の状態のインスタンスが含まれます。デフォルト:
。 |
|
| リスト | オプション。クエリに適用するAWSフィルター。 |
|
| 弦 | オプション。以前のレスポンスからのページネーショントークン。 |
|
| Int | オプション。1ページあたりに返す結果の最大数。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | describe_instance_status boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
インスタンスタイプの説明
アクション識別子はaws.ec2.describeInstanceTypesです。
EC2インスタンスタイプの仕様(vCPU、メモリ、ネットワーク、ストレージ)を記述します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。記述する特定のインスタンスタイプ。 |
|
| リスト | オプション。クエリに適用するAWSフィルター。 |
|
| 弦 | オプション。以前のレスポンスからのページネーショントークン。 |
|
| Int | オプション。1ページあたりに返す結果の最大数。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | describe_instance_types boto3リファレンス をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
インスタンス属性を変更
アクション識別子はaws.ec2.modifyInstanceAttributeです。
インスタンスタイプ、終了保護、ユーザーデータ、送信元/送信先チェックなど、EC2インスタンスの単一の属性を変更します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| 弦 | 必須。属性が変更されるインスタンス。 |
|
| 地図 | 必須。AWS APIが想定する形式で変更する属性。1回の呼び出しで変更できる属性は1つだけです。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
重要
1回の呼び出しで変更できる属性は1つだけです。各属性は parameters マップ内で異なる形状を持ちます — たとえば、インスタンスタイプを変更する場合は {"InstanceType": {"Value": "t3.large"}}、終了保護を有効にする場合は {"DisableApiTermination": {"Value": true}} です。ほとんどの属性では、最初にインスタンスを停止する必要があります。
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功時のレスポンス本文はありません。 modify_instance_attribute boto3 リファレンス をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
詳細な監視を有効にする
アクション識別子はaws.ec2.monitorInstancesです。
1つ以上のEC2インスタンスに対して、詳細なCloudWatch監視(1分間のメトリクス)を有効にします。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| リスト | 必須。詳細な監視を有効にするインスタンスのID。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
詳細な監視の無効化
アクション識別子はaws.ec2.unmonitorInstancesです。
1つ以上のEC2インスタンスの詳細なCloudWatch監視を無効にし、標準の5分間のメトリクスに戻します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| リスト | 必須。詳細監視を無効にするインスタンスのID。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | unmonitor_instances boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
コンソール出力の取得
アクション識別子はaws.ec2.getConsoleOutputです。
起動およびトラブルシューティングの診断のために、EC2インスタンスのコンソール出力を取得します。出力はbase64エンコードされています。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| 弦 | 必須。コンソール出力を取得するインスタンス。 |
|
| ブール値 | オプション。
の場合、処理中であっても最新の出力を返します。デフォルト:
。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | get_console_output boto3 リファレンス をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
Windowsパスワードデータを取得します。
アクション識別子はaws.ec2.getPasswordDataです。
Windows EC2インスタンスの暗号化されたアドミニストレーターパスワードを取得します。Windows以外のインスタンスの場合は空のPasswordDataフィールドを返します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。インスタンスが配置されているAWSリージョン。 |
|
| 弦 | 必須。パスワードデータを取得するWindowsインスタンス。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
キーペアのインポート
アクション識別子はaws.ec2.importKeyPairです。
既存のパブリックキーをキーペアとしてEC2にインポートします。AWSはパブリックキーのみを保存します — プライベートキーがユーザーの管理下から離れることはありません。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。キーペアが登録されているAWSリージョンです。 |
|
| 弦 | 必須。インポートしたキーペアを登録する一意の名前です。 |
|
| 弦 | 必須。インポートするパブリックキーです。シークレットとして渡します。 |
|
| リスト | オプション。インポート時にキーペアに適用されるタグ。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
キーペアの削除
アクション識別子はaws.ec2.deleteKeyPairです。
EC2キーペアを削除します。keyNameまたはkeyPairIdのいずれかを指定します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。キーペアが存在するAWSリージョンです。 |
|
| 弦 | オプション。削除するキーペアの名前。
または
のいずれかを指定します。 |
|
| 弦 | オプション。削除するキーペアのIDです。
または
のいずれかを指定します。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功した場合、レスポンス本文はありません。 を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
キーペアの説明
アクション識別子はaws.ec2.describeKeyPairsです。
アカウントおよびリージョン内のEC2キーペアを記述します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。結果をこれらのキーペア名に制限します。 |
|
| リスト | オプション。結果をこれらのキーペアIDに制限します。 |
|
| リスト | オプション。AWSフィルター(たとえば、
またはタグによるもの)。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | describe_key_pairs boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
セキュリティグループを作成します。
アクション識別子はaws.ec2.createSecurityGroupです。
VPC内に新しいEC2セキュリティグループを作成します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。セキュリティグループが作成されるAWSリージョンです。 |
|
| 弦 | 必須。新しいセキュリティグループの名前です。VPC内で一意である必要があります。 |
|
| 弦 | 必須。セキュリティグループの説明。 |
|
| 弦 | オプション。グループを作成するVPC。デフォルトはリージョンのデフォルトVPCです。 |
|
| リスト | オプション。作成時にグループに適用されるタグ。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | create_security_group boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
セキュリティグループを削除
アクション識別子はaws.ec2.deleteSecurityGroupです。
EC2セキュリティグループを削除します。groupId(推奨)またはgroupNameのいずれかを指定します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。セキュリティグループが存在するAWSリージョン。 |
|
| 弦 | オプション。削除するセキュリティグループです。任意のVPCで機能します。
よりも推奨されます。 |
|
| 弦 | オプション。
の代替手段です。デフォルトVPC内のグループにのみ有効です。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功した場合、レスポンス本文はありません。 delete_security_group boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
セキュリティグループの記述
アクション識別子はaws.ec2.describeSecurityGroupsです。
EC2セキュリティグループと、そのインバウンドルールおよびアウトバウンドルールについて説明します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。クエリするAWSリージョン。 |
|
| リスト | オプション。結果を特定のセキュリティグループIDに制限します。 |
|
| リスト | オプション。グループ名で結果を制限します。デフォルトVPC内のグループにのみ有効です。 |
|
| リスト | オプション。AWSフィルター。例:
、
、
によるもの。 |
|
| 弦 | オプション。以前のレスポンスからのページネーショントークン。 |
|
| Int | オプション。1ページあたりに返すグループの最大数。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | describe_security_groups boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
インバウンドルールの追加
アクション識別子はaws.ec2.authorizeSecurityGroupIngressです。
EC2セキュリティグループにインバウンドルールを追加します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。セキュリティグループが存在するAWSリージョン。 |
|
| 弦 | 必須。インバウンドルールを追加するセキュリティグループです。 |
|
| 弦 | オプション。フラット形式。単一のIPv4ルールの場合は、
、
、および
とともに使用します。 |
|
| Int | オプション。フラット形式。ポート範囲の開始。 |
|
| Int | オプション。フラット形式。ポート範囲の終了。 |
|
| 弦 | オプション。フラット形式。ルールで許可された送信元CIDRブロック。 |
|
| リスト | オプション。構造化された形式。1回の呼び出しでの複数のルール、ルールの説明、IPv6範囲、プレフィックスリスト、またはソースセキュリティグループに必要です。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
ヒント
このアクションは2つのルール形式をサポートしています — 呼び出しごとに1つを選択してください。フラット形式(ipProtocol、fromPort、toPort、cidrIp)は、単一のIPv4ルールの省略形です。複数のルール、説明、IPv6範囲、プレフィックスリスト、または送信元セキュリティグループには、ipPermissionsを使用してください。
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功した場合、レスポンス本文はありません。 authorize_security_group_ingress boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
インバウンドルールを削除
アクション識別子はaws.ec2.revokeSecurityGroupIngressです。
EC2セキュリティグループからインバウンドルールを削除します。ルールの仕様は、既存のルールと完全に一致する必要があります。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。セキュリティグループが存在するAWSリージョン。 |
|
| 弦 | 必須。インバウンドルールを削除するセキュリティグループ。 |
|
| 弦 | オプション。フラット形式。
、
、および
とともに使用します。 |
|
| Int | オプション。フラット形式。ポート範囲の開始。 |
|
| Int | オプション。フラット形式。ポート範囲の終了。 |
|
| 弦 | オプション。フラット形式。削除されるルールの送信元CIDRブロックです。 |
|
| リスト | オプション。構造化された形式。1回の呼び出しで複数のルールを取り消す場合、またはIPv6範囲、プレフィックスリスト、送信元セキュリティグループに関するルールを取り消す場合に必要です。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功した場合、レスポンス本文はありません。 revoke_security_group_ingress boto3リファレンス をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
アウトバウンドルールを追加
アクション識別子はaws.ec2.authorizeSecurityGroupEgressです。
構造化されたipPermissions形式を使用して、EC2セキュリティグループにアウトバウンドルールを追加します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。セキュリティグループが存在するAWSリージョン。 |
|
| 弦 | 必須。アウトバウンドルールを追加するセキュリティグループ。 |
|
| リスト | 必須。構造化された形式で追加するアウトバウンドルールです。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
重要
インバウンドルールのアクションとは異なり、このアクションはフラットなパラメーター形式(cidrIp、ipProtocol、fromPort、toPort)をサポートしていません。AWS AuthorizeSecurityGroupEgress APIは、これらのパラメーターを完全に拒否します。すべてのアウトバウンドルールは、構造化されたipPermissionsリストを使用する必要があります。
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功時のレスポンスボディはありません。 authorize_security_group_egress boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
アウトバウンドルールの削除
アクション識別子はaws.ec2.revokeSecurityGroupEgressです。
EC2 セキュリティグループからアウトバウンドルールを削除します。ルールの仕様は、既存のルールと完全に一致する必要があります。一般的な用途は、AWS がすべての新しいセキュリティグループにアタッチする、デフォルトのすべてを許可するエグレスルールを削除することです。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。AWS APIコールのために引き受けるIAMロールARN。 |
|
| 弦 | オプション。AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。STS認証用の一時的なセッショントークン。シークレットとして渡します。 |
|
| 弦 | 必須。セキュリティグループが存在するAWSリージョン。 |
|
| 弦 | 必須。アウトバウンドルールを削除するセキュリティグループ。 |
|
| リスト | 必須。構造化された形式で削除するアウトバウンドルールです。既存のルールと完全に一致する必要があります。 |
|
| リスト | オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
重要
インバウンドルールのアクションとは異なり、このアクションはフラットなパラメーター形式(cidrIp、ipProtocol、fromPort、toPort)をサポートしていません。すべてのアウトバウンドルールは、構造化されたipPermissionsリストを使用する必要があります。
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 成功した場合、レスポンス本文はありません。 revoke_security_group_egress boto3リファレンス を参照してください。 |
| ブール値 |
または
|
| 弦 |
|