README.md

Kong Plugin S3

summary: Get AWS S3 Objects with AWS V4 signed request

Plugin Priority

Priority: 750

Plugin Version

Version: 0.4.0

Config

* This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

name	type	required	validations	default
aws_key*	string	false
aws_secret*	string	false
aws_assume_role_arn*	string	false
aws_web_identity_credential	boolean	false		true
aws_web_identity_token_file	string	false
aws_web_identity_role_arn	string	false
aws_role_session_name	string	false		kong
aws_region	string	false
aws_imds_protocol_version	string	true	- one_of: - v1 - v2	v1
bucket_name	string	true
rewrites	map[string][string]	false		/: /index.html
host	string	false
port	integer	false	- between: - 0 - 65535	443
clear_query_string	boolean	true		false

Usage

plugins:
  - name: s3
    enabled: true
    config:
      aws_key: ''
      aws_secret: ''
      aws_assume_role_arn: ''
      aws_web_identity_credential: true
      aws_web_identity_token_file: ''
      aws_web_identity_role_arn: ''
      aws_role_session_name: kong
      aws_region: ''
      aws_imds_protocol_version: v1
      bucket_name: ''
      rewrites:
        /: /index.html
      host: ''
      port: 443
      clear_query_string: false