AIGatewayMCPServerBaseACLPropertiesOauth

object
* Additional properties are NOT allowed.
acl_attribute_typestringrequired

The type of attributes that ACL is evaluated with.

Allowed values:oauth_access_token

access_token_claim_fieldstringrequired

The claim in the OAuth2 access token to use as the subject for ACL evaluation when acl_attribute_type is set to oauth_access_token.
Nested claim can be fetched by using a jq filter starts with dot, e.g., “.user.email”: https://jqlang.org/manual/#object-identifier-index

aclsobjectrequired

Access control rules for allowing or denying consumer groups.

* Additional properties are NOT allowed.
Show Child Parameters
default_tool_aclsobjectrequired

Default access control rules for allowing or denying consumer groups to tools.

* Additional properties are NOT allowed.
Show Child Parameters
Example

AIGatewayRedisAWSAuthentication

object

AWS specific configs for connecting to a Cloud Provider’s redis instance.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:aws

access_key_idstring

AWS Access Key ID to be used for authentication.
This field is referenceable.
This field is encrypted.

assume_role_arnstring

The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
This field is referenceable.
This field is encrypted.

cache_namestring

The name of the AWS Elasticache cluster.
This field is referenceable.

is_serverlessboolean

This flag specifies whether the cluster is serverless.

Default:true

regionstring

The region of the AWS ElastiCache cluster.
This field is referenceable.

role_session_namestring

The session name for the temporary credentials when assuming the IAM role.
This field is referenceable.
This field is encrypted.

secret_access_keystring

AWS Secret Access Key.
This field is referenceable.
This field is encrypted.

Example

AIGatewayRedisAzureAuthentication

object

Azure specific configs for connecting to a Cloud Provider’s redis instance.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:azure

client_idstring

Azure Client ID.
This field is referenceable.
This field is encrypted.

secretstring

Azure Client Secret.
This field is referenceable.
This field is encrypted.

tenant_idstring

Azure Tenant ID.
This field is referenceable.
This field is encrypted.

Example

AIGatewayRedisGCPAuthentication

object

GCP specific configs for connecting to a Cloud Provider’s redis instance.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:gcp

service_account_jsonstring

GCP Service Account JSON.
This field is referenceable.
This field is encrypted.

Example

AIGatewayRedisCloudConfiguration

object

Config for connecting to a Cloud Provider’s Redis instance.

* Additional properties are NOT allowed.
cloud_authenticationOne Of

Auth related config for connecting to a Cloud Provider’s Redis instance.

AIGatewayRedisAWSAuthenticationobject

AWS specific configs for connecting to a Cloud Provider’s redis instance.

* Additional properties are NOT allowed.
Show Child Parameters
clusterobject

Cluster configuration for the Redis connection.

* Additional properties are NOT allowed.
Show Child Parameters
connect_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:2000

>= 0<= 2147483646

connection_is_proxiedboolean

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.

Default:false

databaseinteger

Database to use for the Redis connection when using the redis strategy

Default:0

hoststring

A string representing a host name, such as example.com.
This field is referenceable.

Default:127.0.0.1

keepaliveobject

Keepalive configuration for the Redis connection.

* Additional properties are NOT allowed.
Show Child Parameters
passwordstring

Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
This field is referenceable.
This field is encrypted.

portinteger

An integer representing a port number between 0 and 65535, inclusive.
This field is referenceable.

Default:6379

>= 0<= 65535

read_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:2000

>= 0<= 2147483646

send_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:2000

>= 0<= 2147483646

sentinelobject

Configuration for Redis Sentinel.

* Additional properties are NOT allowed.
Show Child Parameters
server_namestring

A string representing an SNI (server name indication) value for TLS.
This field is referenceable.

sslboolean

If set to true, uses SSL to connect to Redis.

Default:false

ssl_verifyboolean

If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.

Default:true

usernamestring

Username to use for Redis connections. If undefined, ACL authentication won’t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
This field is referenceable.

Example