Configure API Service Graph Connector for AWS API Gateway using the guided setup
Set up scheduled import jobs to pull in AWS API Gateway data into your CMDB.
Vorbereitungen
The 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] article in the Now Support Knowledge Base.
- The Integration Commons for CMDB store app, which is automatically installed. See Integration Commons for CMDB.
- The CMDB CI class models store app, which is automatically installed. See CMDB CI Class Models app.
- The ITOM Discovery License plugin (com.snc.itom.discovery.license). You must activate this plugin.
- ITOM Licensing plugin (com.snc.itom.license). See Request Discovery.
Role required: admin
Prozedur
-
Verify that the application scope is set to the API Service Graph Connector for AWS API Gateway application by using the application picker.
For more information, see Application picker.
- Navigate to All > Service Graph Connectors > AWS API Gateway > Setup.
- On the Guided Setup page, select Continue.
-
Configure the authentication credentials to send requests to the AWS API Gateway.
- In the Configure the Connection and Credentials section of the API Service Graph Connector for AWS API Gateway page, select Start.
-
Configure the connection.
- Select the Configure AWS authentication credentials task.
- In the Name field, enter a name for the authentication.
SGAwsApiCredentialsis the default credential alias name. You can add multiple AWS API Gateway instances. However, try not to modify the default connection alias. - Enter the access key ID and the secret access key in the Access Key ID and Secret Access Key fields respectively.
The AWS access keys are long-term credentials for the IAM user and include two parts: an access key ID and a secret access key. You must use both the access key ID and the secret access key together to authenticate requests.
- Select Update.
- Set the Configure AWS authentication credentials task to complete by selecting the Mark as complete check box and then select Continue.
-
Update the required configuration properties for an AWS API Gateway instance and test the connection.
- Select the Configure and Test AWS Account Details task.
- In the Service Graph Connections section, review and modify the property details by selecting a property from the Property column in the Service Graph Connection Properties related
list.You can configure the following properties:
- AccountId
- A numeric identifier of the AWS account ID.
- CollectionPeriod(days)
- Duration in days for collecting API usage data.
- CollectUsageData
- Enable usage data collection to retrieve API usage data over a specified duration.
- IsGovCloud
- Enable to indicate that the connection setup is for the AWS GovCloud.
- ConfigAggregatorAccountId
- AWS account ID where the aggregator resource type in the AWS Config service has been configured.
- Region(s)
- A list of comma-separated regions where the AWS API Gateway resides.
- PartitionSize
- Partition size for AWS managed APIs if the parallel loading is enabled.
Accepts a numeric value greater than zero. If left empty, the value is automatically calculated.
- StandaloneAccountId
- The ID of a member account associated with the AWS API Gateway account.
- ConfigAggregatorName
- The name of the aggregator resource type in the AWS Config service.
- ManagementAccountId
- The management account ID associated with the AWS API Gateway account.
- ConfigAggregatorRegion
- The region where the aggregator resource type resides.
- StsRoleName
- The STS Assume Role name of the AWS account that is used for querying the STS Assume Role API to obtain the API credentials.
- Select Update in the Service Graph Connection Properties section.
- Test the connection by selecting the Test Connection related link.
Testing the connection might take a few moments. The page is refreshed to show the test results.
- When the Status field is set to Success, select Update.
If any of the tests have errors, follow the suggestions for remediation.
- Set the Configure and Test AWS Account Details task to complete by selecting the Mark as complete check box and then select Continue.
- Wahlweise:
Integrate with multiple AWS API Gateway instances.
- In the Add Multiple Instances section of the API Service Graph Connector for AWS API Gateway page, select Start.
-
Enable creating data sources for the new AWS API Gateway connection.
- Ensure that you have edit permissions for the Datasource [sys_data_source] table.
- Select the Update Data Source Access task.
- To edit the record, select the Global application scope from the application picker.
- In the Application Access related list of the Data Source form that opens in a new tab, select the Can create, Can update, and Can delete check boxes.
- Select Update.
- From the application picker, select the API Service Graph Connector for AWS API Gateway application scope.
- Set the Update Data Source Access task to complete by selecting the Mark as complete check box and then select Continue.
-
Enable creating a scheduled import job for the new AWS API Gateway connection.
- Ensure that you have edit permissions for the Scheduled data import [scheduled_import_set] table.
- Select the Update Data Scheduled Import Access task.
- To edit the record, select the Global application scope from the application picker.
- In the Application Access related list of the Scheduled Data Import form, select the Can create, Can update, and Can delete check boxes.
- Select Update.
- From the application picker, select the API Service Graph Connector for AWS API Gateway application scope.
- Set the Update Data Scheduled Import Access task to complete by selecting the Mark as complete check box and then select Continue.
-
Clear the cache on the Data Source [sys_data_source] and Scheduled Data Imports [scheduled_import_set] tables.
- Select the Clear Cache for Data Source and Scheduled Data Imports tables task.
- In the Run script text box of the background script page, enter the following script:
GlideTableManager.invalidateTable("sys_data_source"); GlideCacheManager.flushTable("sys_data_source"); GlideTableManager.invalidateTable("scheduled_import_set"); GlideCacheManager.flushTable("scheduled_import_set"); GlideTableManager.invalidateTable("sys_db_object"); GlideCacheManager.flushTable("sys_db_object"); - Select Run Script to run the background script in the global scope.
The script may take several minutes to execute.
- After the script is executed, select Close.
- From the application picker, select the API Service Graph Connector for AWS API Gateway application scope.
- Set the Clear Cache for Data Source and Scheduled Data Imports tables task to complete by selecting Mark as Complete.
-
Add another connection for the new AWS API Gateway instance.
- Verify that the application scope is set to the API Service Graph Connector for AWS API Gateway application by using the application picker.
- Select the Add Another Connections task and then select Click Here.
- On the Connections page that opens in another browser tab, select Add Connection.
- In the Create Connection window, fill in the connection name, access key, and secret key details.
- Select Create Connection.
- Close the Workflow Studio and return to the guided setup tab.
- Set the Add Another Connections task to complete by selecting the Mark as complete check box and then select Continue.
-
Update the required configuration properties for the new AWS API Gateway connection and test the connection.
- Select the Test New Connections task.
- Select the connection record you created in step 5.e.
- Test the connection by selecting the Test Connection related link.
Testing the connection might take a few moments. The page is refreshed to show the test results.
- When the Status field is set to Success, select Update.
If any of the tests have errors, follow the suggestions for remediation.
- Set the Test New Connections task to complete by selecting the Mark as complete check box and then select Continue.
-
Configure the scheduled job for the import of AWS API Gateway data.
- In the Set up Scheduled Import Jobs section of the API Service Graph Connector for AWS API Gateway page, select Start.
-
Select the SGA-AWS-API-Gateway-Managed-API-RESTManaged API Rest scheduled job.
For multiple instances, select the scheduled job for the SGA-AWS-API-Gateway-Managed-API-RESTManaged API Rest data source.
-
On the Scheduled Data Import form, verify the field values for the scheduled job.
For more information, see Schedule a data import.
- Select Active check box to activate the scheduled job for the SGA-AWS-API-Gateway-Managed-API-RESTManaged API Rest data source.
- Select Update.
- Set the Set up Scheduled Import Jobs task to complete by selecting the Mark as complete check box and then select Continue.
- On the API Service Graph Connector for AWS API Gateway page, select Complete to save your changes.
- In Complete setup dialog box, select Complete to complete the setup.
- In the message box that appears, select Done.