{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":47051,"path":"servicenow-platform/configuration-management-database-cmdb/sgcc-configure-aws-api-gateway.md","title":"Configure API Service Graph Connector for AWS API Gateway using SGC Central","bundle":null,"doc_type":null,"release":"australia","body":"\n# Configure API Service Graph Connector for AWS API Gateway using SGC Central\n\nSet up scheduled import jobs to pull in AWS API Gateway data into your CMDB.\n\n## Before you begin\n\nInstall API Service Graph Connector for AWS API Gateway version 1.0.0 or later from the ServiceNow Store. For ServiceNow Store installation steps, see [Install a ServiceNow Store application](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/installing-applications-in-application-manager.md).\n\nThe authentication mechanism used by the connector is AWS Signature Type \\(HMAC Authentication Technique\\) with AWS Security Token Service \\(STS\\) token. For information about permissions, see the [API Service Graph Connector for AWS API Gateway - Setup Instructions \\[KB1962734\\]](https://support.servicenow.com/kb_view.do?sysparm_article=KB1962734) article in the Now Support Knowledge Base.\n\nRole required: The following table shows the roles required for each stage of the playbook.\n\n|Stage|Role|\n|-----|----|\n|Prerequisites|admin|\n|Setup|SGC-Admin \\(sn\\_cmdb\\_int\\_util.sgc\\_admin\\) or admin|\n\n**Note:** The admin user role is required to run background scripts and to provide access to global tables to the SGC-Admin user. For information about the user roles for Service Graph Connectors, see [Service Graph Connector user roles](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/cmdb-sgc-intro.md).\n\n## About this task\n\nThe playbook experience for onboarding connectors is activated with SGC Central in the CMDB Workspace. To configure the SGC Central application, see [Configuring SGC Central](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/sgcc-configuring.md) and for more information on how to interact with a playbook, see Interact with Playbook.\n\n**Note:** Alternatively, you can configure a default connection already available from the installed or draft connections in SGC Central. Go to **All** > **Service Graph Connectors**, then select **Setup** for the connector from the menu. To learn about installed and draft connections, see [Managing connections added for Service Graph Connectors in SGC Central](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/sgcc-managing-connection.md).\n\n## Procedure\n\n1. Navigate to **Workspaces** > **CMDB Workspace**.\n\n2. In the CMDB Workspace, select **SGC Central**.\n\n3. On the Overview page, select **Create connection**.\n\n **Tip:** Alternatively, you can select **Create connection** on the All connections page.\n\n4. On the Create connection window, select the AWS API Gateway connector type, and then select **Create connection**.\n\n5. Complete the initial prerequisites when setting up a connection for the first time using a connector.\n\n **Note:** This step is required only during the first-time setup. See [Perform initial setup tasks when creating a connection in SGC Central](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/sgcc-first-time-setup.md).\n\n6. Enter connection details and test the API connection for importing AWS API Gateway data.\n\n 1. In the **Setup** stage of the playbook, select the **Create and test connection** activity.\n\n 2. On the form, fill in the fields.\n\n\n
\n\nField\n\n\n\nDescription\n\n
\n\nAWS API Gateway Connection Name\n\n\n\nName to identify the AWS API Gateway connection record.For example, `SG-AWS-API-Gateway connection`.\n\n
\n\nAccess Key\n\n\n\nAccess key ID of the IAM user that has permissions to interact with the AWS resources.\n\n
\n\nSecret Key\n\n\n\nSecret access key that corresponds to the Access key ID required for authenticating the connection securely.\n\n
3. Select **Create and test connection**.\n\n 4. Once the connection test is complete, select **Continue**.\n\n7. Copy configuration properties from an existing AWS connection.\n\n **Note:** The Copy configuration properties activity is displayed only when an AWS connection is already set up on your instance.\n\n 1. In the **Setup** stage of the playbook, select the **Copy configuration properties** activity.\n\n 2. In the **AWS Connection** field, select the connection.\n\n The values of the following properties are copied from the selected AWS connection:\n\n - Standalone account ID\n - Management account ID\n - Gov cloud\n - STS assume role\n - AWS regions\n - Config aggregator name\n - Config aggregator account\n - Config aggregator region\n 3. Select **Continue**.\n\n 4. Once the connection test is complete, select **Continue**.\n\n8. Set the configuration properties for the connection.\n\n 1. In the **Setup** stage of the playbook, select the **Set configuration properties** activity.\n\n 2. Fill in the property details.\n\n **Note:** If you select to copy the configuration properties from an existing AWS connection, the properties listed in the step [7.b](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/sgcc-configure-aws-api-gateway.md) are copied from the existing connection automatically.\n\n |Property|Description|\n|Management account ID or standalone account ID|\n |--------|-----------|\n |----------------------------------------------|\n |Management account ID|Management account ID associated with the AWS API Gateway account.|\n |Standalone account ID|ID of a member account associated with the AWS API Gateway account.|\n |STS assume role name and AWS regions|\n |STS assume role name|STS Assume Role name of the AWS account that is used for querying the STS Assume Role API to obtain the API credentials.|\n |AWS regions|List of comma-separated regions where the AWS API Gateway resides.|\n |Config aggregator setup|\n |Config aggregator account ID|AWS account ID where the aggregator resource type in the AWS Config service has been configured.|\n |Config aggregator name|Name of the aggregator resource type in the AWS Config service.|\n |Config aggregator region|Region where the aggregator resource type resides.|\n |API usage data|\n |Collect Usage Data|Option to enable usage data collection to retrieve API usage data over a specified duration.|\n |Collection period in days|Duration in days for collecting API usage data.|\n |Gov cloud setup|\n |Is gov cloud|Option to indicate that the connection setup is for the AWS GovCloud.|\n\n 3. Select **Continue**.\n\n9. Configure the import schedule to import data at regular intervals.\n\n 1. In the **Setup** stage of the playbook, select the **Configure import schedule** activity.\n\n 2. Expand the Parent scheduled data import within the Import schedules list to select the **Managed API Rest** import schedule associated with your connection.\n\n **Note:** The connection name is prefixed to the schedule name.\n\n 3. In the Configure import schedule dialog box, select the **Active** check box, and then fill in the run schedule and time details.\n\n For more information, see [Schedule a data import](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/integrate-applications/t_ScheduleADataImport.md#table_r53_5hm_xp).\n\n 4. Select **Save**.\n\n Alternatively, select **Execute Now** to execute the import schedule immediately.\n\n 5. Select **Continue**.\n\n10. In the **Setup** stage of the playbook, select the **Confirm connection creation** activity to verify whether the connection was configured.\n\n\n## What to do next\n\nSelect **View all connections** to review the connection details. The configured connection appears in the Installed connections list.\n\nYou can then manage connections from the SGC Central view of the CMDB Workspace. For more information, see [Managing connections added for Service Graph Connectors in SGC Central](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/sgcc-managing-connection.md).\n\n**Related topics** \n\n\n[API Service Graph Connector for AWS API Gateway](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/api-sgc-aws-gateway.md)\n\n[Target tables for storing API Service Graph Connector for AWS API Gateway data](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/api-sgc-aws-gateway-tables.md)\n\n"}}