Skip to main content

AWS AppSync (CloudFormation)

The Inigo plugin for AWS AppSync provides full observability and controls on all individual subgraphs. Follow the instructions to get up and running.

Prerequisites

  • A working AppSync service with API Key authentication. If not, see the AWS AppSync documentation for configuration instructions.

Inigo Service Creation

In order to be able to provide additional security and analytics to your AppSync service create a new Inigo service. Follow these steps to create your service and to obtain INIGO_SERVICE_TOKEN.

  1. After successful registration at app.inigo.io, open the service configuration menu.

Logo

  1. Select Docker Standalone option.

Logo

  1. Choose service name and label (optionally), and click the Next button.

    Logo

  2. Save the INIGO_SERVICE_TOKEN value, by clicking on copy button, for the later usage.

    Logo

At this point, the work on Inigo's side is over. We will get back to the Inigo dashboard once the AWS configuration is complete.

AWS Agent Subscription

To add Inigo's capabilities to your AppSync service we have to configure the AWS Inigo Agent. Let's go through the subscription and deployment process.

  1. Head to the Inigo GraphQL Analytics product page in AWS Marketplace

    Logo

  2. Click the Continue to Subscribe button and accept the terms and conditions.

    Logo

  3. Wait for the AWS to process acceptance request to complete. Once it is done, Continue to Configuration button will be enabled.

    Logo

  4. On the configuration page select Cloudformation stack for AppSync fulfillment option, the latest version and hit Continue to Launch button.

    Logo

  5. You'll end up at the page with the usage instructions. In this tutorial, we will use provided template to create a stack. Follow step #4 in the Usage Instructions section.

    Logo

  6. You can also use container image directly for complete flexibility, or download the CloudFormation template used to create stack by following Complete CloudFormation stack for AppSync link.

    Logo

AWS Agent Stack Deployment

At this stage we are going to configure our stack deployment. You should prepare initially stored INIGO_SERVICE_TOKEN, AppSync GraphQL endpoint and API Key for the same.

  1. Fill in initially prepared parameters to the stack, agree to the required resource capabilities and Create Stack. You can change stack name to whatever you like. For RemoteAccessCIDR you can choose any suitable CIDR range. In our example we will make it public (0.0.0.0/0).

    Logo

  • AppSyncAPIKey - AppSync API Key
  • AppSyncURL - AppSync service GraphQL endpoint
  • InigoServiceToken - Inigo's service token
  • RemoteAccessCIDR - Range of allowed IPs
  1. Stack creation process should start. Let's wait until its status changes from CREATE_IN_PROGRESS to CREATE_COMPLETE. It usually takes up to 5 minutes.

    Logo

  2. Once stack is created, under the Outputs tab, copy the ExternalUrl value which points to your exposed load balancer pointing to deployed Inigo agent service. Let's copy that value.

    Logo

  3. Using the browser, navigate to ExternalUrl by adding /playground to its path, and you are good to go with making the queries to your AppSync server. Alternatively, you can use any GraphQL client/playground tool by pointing it to ExternalUrl with /graphql.

    Logo

  4. After sending a few requests, head to see your analytic data in your account at app.inigo.io

    LogoLogo

  5. (Optional:) Head over to the Tutorials section to explore more advanced configuration scenarios.