Skip to content

Promise based read-only API client for the next-url-management-api. Does multi-region health checks and failover.

Notifications You must be signed in to change notification settings

Financial-Times/n-url-management-api-read-client

Repository files navigation

n-url-management-api-read-client

Communicates directly with the DynamoDB tables.

IAM Permissions

You will need the following IAM permissions:-

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "dynamodb:GetItem",
        "dynamodb:BatchGetItem"
      ],
      "Resource": "arn:aws:dynamodb:*:*:table/urlmgmtapi_*"
    }
  ]
}

Environment variables

Expects:-

  • URLMGMTAPI_AWS_ACCESS_KEY
  • URLMGMTAPI_AWS_SECRET_KEY

init options

  • timeout [Number]
  • connectTimeout [Number]
  • poolConnextions [Boolean]
  • raceOnce [Boolean] = don't keep checking up on the health of the dynamodbs. Use for a lambda environment