SGC セントラル を使用して AWS API Gateway の API サービスグラフコネクタを構成する

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：5分

    • AWS API ゲートウェイ データを CMDB にプルするようにスケジュール済みインポートジョブを設定します。

    始める前に

    ServiceNow Store から AWS API Gateway の API サービスグラフコネクタ (バージョン 1.0.0 以降) をインストールします。 ServiceNow Store のインストールステップについては「ServiceNow Store アプリケーションのインストール」を参照してください。

    コネクタで使用される認証メカニズムは、AWS セキュリティトークンサービス (STS) のトークンを使用する AWS 署名タイプ (HMAC 認証手法) です。権限の詳細については、Now Supportナレッジベースの記事「API Service Graph Connector for AWS API Gateway - Setup Instructions (AWS API Gateway の API サービスグラフコネクタ - セットアップ手順) [KB1962734]」を参照してください。

    必要なロール：admin

    このタスクについて

    オンボーディングコネクタのプレイブックエクスペリエンスは、CMDB ワークスペースの SGC セントラル でアクティブ化されます。プレイブックの操作方法の詳細については、「プレイブックとやり取りする」を参照してください。

    手順

    1. 次のように移動する。 ワークスペース > CMDB ワークスペース.
    2. CMDB ワークスペースで SGC セントラル を選択します。
    3. [概要] ページで、[接続を作成] を選択します。
      ヒント:
      または、 [すべての接続] ページで [接続を作成] を選択することもできます。
    4. コネクタを使用して初めて接続を設定するときは、最初の前提条件を満たしてください。
      注:
      この手順は、初回セットアップ時にのみ必要です。「で接続を作成するときに初期セットアップタスクを実行する SGC セントラル」を参照してください。
    5. 接続の詳細を入力し、AWS API ゲートウェイ データをインポートするための API 接続をテストします。
      1. プレイブックの [セットアップ (Setup)] ステージで、[接続を作成してテスト (Create and test connection)] アクティビティを選択します。
      2. フォームのフィールドに入力します。
        表 : 1. [接続を作成してテスト (Create and test connection)] フォーム
        フィールド 説明
        AWS API Gateway 接続名 AWS API ゲートウェイ 接続レコードを識別する名前です。

        例：SG-AWS-API-Gateway connection。
        アクセス キー AWS リソースとやり取りする権限を持つ IAM ユーザーのアクセスキー ID。
        秘密キー 接続を安全に認証するために必要なアクセスキー ID に対応する秘密アクセスキー。
      3. [接続の作成とテスト (Create and test connection)] を選択します。
      4. 接続テストが完了したら、[続行] を選択します。
    6. オプション: 既存の AWS 接続から構成プロパティをコピーします。
      注:
      [ 構成プロパティをコピー ] アクティビティは、 AWS 接続が既にインスタンスに設定されている場合にのみ表示されます。
      1. プレイブックの [セットアップ ] ステージで、[ 構成プロパティをコピー ] アクティビティを選択します。
      2. [ AWS 接続 ] フィールドで、接続を選択します。
        次のプロパティの値が、選択した AWS 接続からコピーされます。
        • スタンドアロンアカウント ID
        • 管理アカウント ID
        • Gov クラウド
        • STS 想定ロール
        • AWS リージョン
        • Config アグリゲーター名
        • Config アグリゲーターアカウント
        • Config アグリゲーターリージョン
      3. [Continue (続行)] をクリックします。
      4. 接続テストが完了したら、[続行] を選択します。
    7. 接続の構成プロパティを設定します。
      1. プレイブックの [セットアップ (Setup)] ステージで、[構成プロパティを設定 (Set configuration properties)] アクティビティを選択します。
      2. プロパティの詳細を入力します。
        注:
        既存の AWS 接続から構成プロパティをコピーすることを選択した場合、ステップ 6.b にリストされているプロパティは既存の接続から自動的にコピーされます。
        表 : 2. AWS API ゲートウェイ 構成プロパティ
        プロパティ 説明
        管理アカウント ID またはスタンドアロンアカウント ID
        管理アカウント ID AWS API ゲートウェイ アカウントに関連付けられた管理アカウント ID。
        スタンドアロンアカウント ID AWS API ゲートウェイアカウントに関連付けられたメンバーアカウントの ID。
        STS 想定ロール名と AWS リージョン
        STS 想定ロール名 STS 想定ロール API のクエリを実行して API 認証情報を取得するために使用する、AWS アカウントの STS 想定ロール名。
        AWS リージョン AWS API ゲートウェイ が存在するリージョンをカンマで区切ったリスト。
        Config アグリゲーターのセットアップ
        Config アグリゲーターアカウント ID AWS Config サービスのアグリゲーターリソースタイプが構成されている AWS アカウント ID。
        Config アグリゲーター名 AWS Config サービスのアグリゲーターリソースタイプの名前。
        Config アグリゲーターリージョン アグリゲーターリソースタイプが存在するリージョン。
        API 使用状況データ
        使用状況データの収集 使用状況データ収集を有効にして、指定した期間の API 使用状況データを取得するオプション。
        収集期間 (日数) API 使用状況データを収集する期間 (日数)。
        Gov クラウドのセットアップ
        Gov クラウドか 接続セットアップが AWS GovCloud 用であることを示すオプション。
      3. [Continue (続行)] をクリックします。
    8. 定期的にデータをインポートするようにインポートスケジュールを構成します。
      1. プレイブックの [セットアップ (Setup)] ステージで、[インポートスケジュールの構成 (Configure import schedule)] アクティビティを選択します。
      2. [スケジュール済みインポートをインポート] リストで [親スケジュール済みデータインポート] を展開し、接続に関連付けられた SGA-AWS-API-Gateway-Managed-API-REST インポートスケジュールを選択します。
        注:
        接続名には、スケジュール名のプリフィックスが付きます。
      3. [ インポートスケジュールの構成 ] ダイアログボックスで、[ アクティブ ] チェックボックスをオンにして、実行スケジュールと時間の詳細を入力します。

        詳細については、「Schedule a data import」を参照してください。

      4. [Save (保存)] を選択します。
        または、[ 今すぐ実行] を選択して、インポートスケジュールをすぐに実行します。
      5. [Continue (続行)] をクリックします。
    9. プレイブックの [セットアップ ] ステージで、[ 接続の作成を確認 ] アクティビティを選択して、接続が構成されているかどうかを確認します。

    次のタスク

    [すべての接続を表示 (View all connections)] を選択して、接続の詳細を確認します。構成された接続が [インストール済み接続 (Installed connections)] リストに表示されます。