Fetching contributors…
Cannot retrieve contributors at this time
49 lines (40 sloc) 1.46 KB


The Custom::KongPlugin creates a Kong Plugin .


To declare this entity in your AWS CloudFormation template, use the following syntax:

  "Type" : "Custom::KongPlugin",
  "Properties" : {
    "AdminUrl": String,
    "JWT": {
        "Issuer": String,
        "PrivateKeyParameterName": String
    "ServiceToken" : String,
    "Plugin" : {
      "name": String,
      "api_id": String,
      "consumer_id": String,
      "service_id": String,
      "route_id": String,
      "config": {


You can specify the following properties:

"AdminUrl" - pointing to the Kong Admin  (required).
"JWT" - RS256 JWT token generator configuration (coptional).
"JWT.Issuer" - issuer of the JWT token, defaults to 'admin'.
"JWT.PrivateKeyParameterName" - parameter store name containing the private key to sign the token with (required).
"ServiceToken" - pointing to the function implementing this (required)
"Plugin" - object containing all the properties as defined by Kong add-plugin (required).

Check out all properties for "Plugin" at add-plugin.

Return values

With 'Fn::GetAtt' the following values are available:

  • id - id of the Plugin in Kong.

For more information about using Fn::GetAtt, see Fn::GetAtt.