Composite Outbound (Group Policies) Policy

The Composite outbound policy allows you to create groups of other policies, for easy reuse across multiple routes. Other policies are referenced by their name.

Be careful not to create circular references which can cause your gateway to fail.

Configuration

The configuration shows how to configure the policy in the 'policies.json' document.

Code
{
  "name": "my-composite-outbound-policy",
  "policyType": "composite-outbound",
  "handler": {
    "export": "CompositeOutboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "policies": ["policy1", "policy2"]
    }
  }
}

Policy Configuration

• name <string> - The name of your policy instance. This is used as a reference in your routes.
• policyType <string> - The identifier of the policy. This is used by the Zuplo UI. Value should be composite-outbound.
• handler.export <string> - The name of the exported type. Value should be CompositeOutboundPolicy.
• handler.module <string> - The module containing the policy. Value should be $import(@zuplo/runtime).
• handler.options <object> - The options for this policy. See Policy Options below.

Policy Options

The options for this policy are specified below. All properties are optional unless specifically marked as required.

• policies <string[]> - The list of policy references (beware circular references).

Using the Policy

Read more about how policies work