AWS Request Signing Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The AWS Request Signing plugin is compatible with the following protocols:

http, https

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name

  string required

  The name of the plugin, in this case aws-request-signing.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example aws-request-signing_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/SERVICE_NAME|SERVICE_ID/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/ROUTE_NAME|ROUTE_ID/plugins.

• consumer.name or consumer.id

  string

  The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/CONSUMER_NAME|CONSUMER_ID/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • aws_assume_role_arn

    string required encrypted

    The ARN of the AWS IAM Role to assume before making the request to the AWS service.

  • aws_assume_role_name

    string required encrypted

    The name of the AWS IAM Role to assume before making the request to the AWS service.

  • aws_region

    string required

    The AWS region in which the service is located.

  • aws_service

    string required

    The name of the AWS service to be called.

  • override_target_host

    string

    An optional hostname or IP to use instead of the one specified in the service’s endpoint.

  • override_target_port

    number

    An optional port to use instead of the one specified in the service’s endpoint.

  • override_target_protocol

    string Must be one of: http, https

    An optional protocol to use instead of the one specified in the service’s endpoint.