1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginAcme
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.getGatewayPluginAcme

Explore with Pulumi AI

Using getGatewayPluginAcme

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGatewayPluginAcme(args: GetGatewayPluginAcmeArgs, opts?: InvokeOptions): Promise<GetGatewayPluginAcmeResult>
function getGatewayPluginAcmeOutput(args: GetGatewayPluginAcmeOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginAcmeResult>
Copy
def get_gateway_plugin_acme(control_plane_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGatewayPluginAcmeResult
def get_gateway_plugin_acme_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginAcmeResult]
Copy
func LookupGatewayPluginAcme(ctx *Context, args *LookupGatewayPluginAcmeArgs, opts ...InvokeOption) (*LookupGatewayPluginAcmeResult, error)
func LookupGatewayPluginAcmeOutput(ctx *Context, args *LookupGatewayPluginAcmeOutputArgs, opts ...InvokeOption) LookupGatewayPluginAcmeResultOutput
Copy

> Note: This function is named LookupGatewayPluginAcme in the Go SDK.

public static class GetGatewayPluginAcme 
{
    public static Task<GetGatewayPluginAcmeResult> InvokeAsync(GetGatewayPluginAcmeArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginAcmeResult> Invoke(GetGatewayPluginAcmeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayPluginAcmeResult> getGatewayPluginAcme(GetGatewayPluginAcmeArgs args, InvokeOptions options)
public static Output<GetGatewayPluginAcmeResult> getGatewayPluginAcme(GetGatewayPluginAcmeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginAcme:getGatewayPluginAcme
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ControlPlaneId This property is required. string
ControlPlaneId This property is required. string
controlPlaneId This property is required. String
controlPlaneId This property is required. string
control_plane_id This property is required. str
controlPlaneId This property is required. String

getGatewayPluginAcme Result

The following output properties are available:

config Property Map
controlPlaneId String
createdAt Number
enabled Boolean
id String
instanceName String
ordering Property Map
protocols List<String>
tags List<String>
updatedAt Number

Supporting Types

GetGatewayPluginAcmeConfig

AccountEmail This property is required. string
The account identifier. Can be reused in a different plugin instance.
AccountKey This property is required. GetGatewayPluginAcmeConfigAccountKey
The private key associated with the account.
AllowAnyDomain This property is required. bool
If set to true, the plugin allows all domains and ignores any values in the domains list.
ApiUri This property is required. string
A string representing a URL, such as https://example.com/path/to/resource?q=search.
CertType This property is required. string
The certificate type to create. The possible values are rsa for RSA certificate or ecc for EC certificate.
Domains This property is required. List<string>
An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label ('*')
EabHmacKey This property is required. string
External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.
EabKid This property is required. string
External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.
EnableIpv4CommonName This property is required. bool
A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates.
FailBackoffMinutes This property is required. double
Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate.
PreferredChain This property is required. string
A string value that specifies the preferred certificate chain to use when generating certificates.
RenewThresholdDays This property is required. double
Days remaining to renew the certificate before it expires.
RsaKeySize This property is required. double
RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.
Storage This property is required. string
The backend storage type to use. In DB-less mode and Konnect, kong storage is unavailable. In hybrid mode and Konnect, shm storage is unavailable. shm storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of kong, redis, consul, or vault in production.
StorageConfig This property is required. GetGatewayPluginAcmeConfigStorageConfig
TosAccepted This property is required. bool
If you are using Let's Encrypt, you must set this to true to agree the terms of service.
AccountEmail This property is required. string
The account identifier. Can be reused in a different plugin instance.
AccountKey This property is required. GetGatewayPluginAcmeConfigAccountKey
The private key associated with the account.
AllowAnyDomain This property is required. bool
If set to true, the plugin allows all domains and ignores any values in the domains list.
ApiUri This property is required. string
A string representing a URL, such as https://example.com/path/to/resource?q=search.
CertType This property is required. string
The certificate type to create. The possible values are rsa for RSA certificate or ecc for EC certificate.
Domains This property is required. []string
An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label ('*')
EabHmacKey This property is required. string
External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.
EabKid This property is required. string
External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.
EnableIpv4CommonName This property is required. bool
A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates.
FailBackoffMinutes This property is required. float64
Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate.
PreferredChain This property is required. string
A string value that specifies the preferred certificate chain to use when generating certificates.
RenewThresholdDays This property is required. float64
Days remaining to renew the certificate before it expires.
RsaKeySize This property is required. float64
RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.
Storage This property is required. string
The backend storage type to use. In DB-less mode and Konnect, kong storage is unavailable. In hybrid mode and Konnect, shm storage is unavailable. shm storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of kong, redis, consul, or vault in production.
StorageConfig This property is required. GetGatewayPluginAcmeConfigStorageConfig
TosAccepted This property is required. bool
If you are using Let's Encrypt, you must set this to true to agree the terms of service.
accountEmail This property is required. String
The account identifier. Can be reused in a different plugin instance.
accountKey This property is required. GetGatewayPluginAcmeConfigAccountKey
The private key associated with the account.
allowAnyDomain This property is required. Boolean
If set to true, the plugin allows all domains and ignores any values in the domains list.
apiUri This property is required. String
A string representing a URL, such as https://example.com/path/to/resource?q=search.
certType This property is required. String
The certificate type to create. The possible values are rsa for RSA certificate or ecc for EC certificate.
domains This property is required. List<String>
An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label ('*')
eabHmacKey This property is required. String
External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.
eabKid This property is required. String
External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.
enableIpv4CommonName This property is required. Boolean
A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates.
failBackoffMinutes This property is required. Double
Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate.
preferredChain This property is required. String
A string value that specifies the preferred certificate chain to use when generating certificates.
renewThresholdDays This property is required. Double
Days remaining to renew the certificate before it expires.
rsaKeySize This property is required. Double
RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.
storage This property is required. String
The backend storage type to use. In DB-less mode and Konnect, kong storage is unavailable. In hybrid mode and Konnect, shm storage is unavailable. shm storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of kong, redis, consul, or vault in production.
storageConfig This property is required. GetGatewayPluginAcmeConfigStorageConfig
tosAccepted This property is required. Boolean
If you are using Let's Encrypt, you must set this to true to agree the terms of service.
accountEmail This property is required. string
The account identifier. Can be reused in a different plugin instance.
accountKey This property is required. GetGatewayPluginAcmeConfigAccountKey
The private key associated with the account.
allowAnyDomain This property is required. boolean
If set to true, the plugin allows all domains and ignores any values in the domains list.
apiUri This property is required. string
A string representing a URL, such as https://example.com/path/to/resource?q=search.
certType This property is required. string
The certificate type to create. The possible values are rsa for RSA certificate or ecc for EC certificate.
domains This property is required. string[]
An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label ('*')
eabHmacKey This property is required. string
External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.
eabKid This property is required. string
External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.
enableIpv4CommonName This property is required. boolean
A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates.
failBackoffMinutes This property is required. number
Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate.
preferredChain This property is required. string
A string value that specifies the preferred certificate chain to use when generating certificates.
renewThresholdDays This property is required. number
Days remaining to renew the certificate before it expires.
rsaKeySize This property is required. number
RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.
storage This property is required. string
The backend storage type to use. In DB-less mode and Konnect, kong storage is unavailable. In hybrid mode and Konnect, shm storage is unavailable. shm storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of kong, redis, consul, or vault in production.
storageConfig This property is required. GetGatewayPluginAcmeConfigStorageConfig
tosAccepted This property is required. boolean
If you are using Let's Encrypt, you must set this to true to agree the terms of service.
account_email This property is required. str
The account identifier. Can be reused in a different plugin instance.
account_key This property is required. GetGatewayPluginAcmeConfigAccountKey
The private key associated with the account.
allow_any_domain This property is required. bool
If set to true, the plugin allows all domains and ignores any values in the domains list.
api_uri This property is required. str
A string representing a URL, such as https://example.com/path/to/resource?q=search.
cert_type This property is required. str
The certificate type to create. The possible values are rsa for RSA certificate or ecc for EC certificate.
domains This property is required. Sequence[str]
An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label ('*')
eab_hmac_key This property is required. str
External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.
eab_kid This property is required. str
External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.
enable_ipv4_common_name This property is required. bool
A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates.
fail_backoff_minutes This property is required. float
Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate.
preferred_chain This property is required. str
A string value that specifies the preferred certificate chain to use when generating certificates.
renew_threshold_days This property is required. float
Days remaining to renew the certificate before it expires.
rsa_key_size This property is required. float
RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.
storage This property is required. str
The backend storage type to use. In DB-less mode and Konnect, kong storage is unavailable. In hybrid mode and Konnect, shm storage is unavailable. shm storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of kong, redis, consul, or vault in production.
storage_config This property is required. GetGatewayPluginAcmeConfigStorageConfig
tos_accepted This property is required. bool
If you are using Let's Encrypt, you must set this to true to agree the terms of service.
accountEmail This property is required. String
The account identifier. Can be reused in a different plugin instance.
accountKey This property is required. Property Map
The private key associated with the account.
allowAnyDomain This property is required. Boolean
If set to true, the plugin allows all domains and ignores any values in the domains list.
apiUri This property is required. String
A string representing a URL, such as https://example.com/path/to/resource?q=search.
certType This property is required. String
The certificate type to create. The possible values are rsa for RSA certificate or ecc for EC certificate.
domains This property is required. List<String>
An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label ('*')
eabHmacKey This property is required. String
External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.
eabKid This property is required. String
External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.
enableIpv4CommonName This property is required. Boolean
A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates.
failBackoffMinutes This property is required. Number
Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate.
preferredChain This property is required. String
A string value that specifies the preferred certificate chain to use when generating certificates.
renewThresholdDays This property is required. Number
Days remaining to renew the certificate before it expires.
rsaKeySize This property is required. Number
RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.
storage This property is required. String
The backend storage type to use. In DB-less mode and Konnect, kong storage is unavailable. In hybrid mode and Konnect, shm storage is unavailable. shm storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of kong, redis, consul, or vault in production.
storageConfig This property is required. Property Map
tosAccepted This property is required. Boolean
If you are using Let's Encrypt, you must set this to true to agree the terms of service.

GetGatewayPluginAcmeConfigAccountKey

KeyId This property is required. string
The Key ID.
KeySet This property is required. string
The ID of the key set to associate the Key ID with.
KeyId This property is required. string
The Key ID.
KeySet This property is required. string
The ID of the key set to associate the Key ID with.
keyId This property is required. String
The Key ID.
keySet This property is required. String
The ID of the key set to associate the Key ID with.
keyId This property is required. string
The Key ID.
keySet This property is required. string
The ID of the key set to associate the Key ID with.
key_id This property is required. str
The Key ID.
key_set This property is required. str
The ID of the key set to associate the Key ID with.
keyId This property is required. String
The Key ID.
keySet This property is required. String
The ID of the key set to associate the Key ID with.

GetGatewayPluginAcmeConfigStorageConfig

Consul This property is required. GetGatewayPluginAcmeConfigStorageConfigConsul
Kong This property is required. Dictionary<string, string>
Redis This property is required. GetGatewayPluginAcmeConfigStorageConfigRedis
Shm This property is required. GetGatewayPluginAcmeConfigStorageConfigShm
Vault This property is required. GetGatewayPluginAcmeConfigStorageConfigVault
Consul This property is required. GetGatewayPluginAcmeConfigStorageConfigConsul
Kong This property is required. map[string]string
Redis This property is required. GetGatewayPluginAcmeConfigStorageConfigRedis
Shm This property is required. GetGatewayPluginAcmeConfigStorageConfigShm
Vault This property is required. GetGatewayPluginAcmeConfigStorageConfigVault
consul This property is required. GetGatewayPluginAcmeConfigStorageConfigConsul
kong This property is required. Map<String,String>
redis This property is required. GetGatewayPluginAcmeConfigStorageConfigRedis
shm This property is required. GetGatewayPluginAcmeConfigStorageConfigShm
vault This property is required. GetGatewayPluginAcmeConfigStorageConfigVault
consul This property is required. GetGatewayPluginAcmeConfigStorageConfigConsul
kong This property is required. {[key: string]: string}
redis This property is required. GetGatewayPluginAcmeConfigStorageConfigRedis
shm This property is required. GetGatewayPluginAcmeConfigStorageConfigShm
vault This property is required. GetGatewayPluginAcmeConfigStorageConfigVault
consul This property is required. GetGatewayPluginAcmeConfigStorageConfigConsul
kong This property is required. Mapping[str, str]
redis This property is required. GetGatewayPluginAcmeConfigStorageConfigRedis
shm This property is required. GetGatewayPluginAcmeConfigStorageConfigShm
vault This property is required. GetGatewayPluginAcmeConfigStorageConfigVault
consul This property is required. Property Map
kong This property is required. Map<String>
redis This property is required. Property Map
shm This property is required. Property Map
vault This property is required. Property Map

GetGatewayPluginAcmeConfigStorageConfigConsul

Host This property is required. string
A string representing a host name, such as example.com.
Https This property is required. bool
Boolean representation of https.
KvPath This property is required. string
KV prefix path.
Port This property is required. double
An integer representing a port number between 0 and 65535, inclusive.
Timeout This property is required. double
Timeout in milliseconds.
Token This property is required. string
Consul ACL token.
Host This property is required. string
A string representing a host name, such as example.com.
Https This property is required. bool
Boolean representation of https.
KvPath This property is required. string
KV prefix path.
Port This property is required. float64
An integer representing a port number between 0 and 65535, inclusive.
Timeout This property is required. float64
Timeout in milliseconds.
Token This property is required. string
Consul ACL token.
host This property is required. String
A string representing a host name, such as example.com.
https This property is required. Boolean
Boolean representation of https.
kvPath This property is required. String
KV prefix path.
port This property is required. Double
An integer representing a port number between 0 and 65535, inclusive.
timeout This property is required. Double
Timeout in milliseconds.
token This property is required. String
Consul ACL token.
host This property is required. string
A string representing a host name, such as example.com.
https This property is required. boolean
Boolean representation of https.
kvPath This property is required. string
KV prefix path.
port This property is required. number
An integer representing a port number between 0 and 65535, inclusive.
timeout This property is required. number
Timeout in milliseconds.
token This property is required. string
Consul ACL token.
host This property is required. str
A string representing a host name, such as example.com.
https This property is required. bool
Boolean representation of https.
kv_path This property is required. str
KV prefix path.
port This property is required. float
An integer representing a port number between 0 and 65535, inclusive.
timeout This property is required. float
Timeout in milliseconds.
token This property is required. str
Consul ACL token.
host This property is required. String
A string representing a host name, such as example.com.
https This property is required. Boolean
Boolean representation of https.
kvPath This property is required. String
KV prefix path.
port This property is required. Number
An integer representing a port number between 0 and 65535, inclusive.
timeout This property is required. Number
Timeout in milliseconds.
token This property is required. String
Consul ACL token.

GetGatewayPluginAcmeConfigStorageConfigRedis

Database This property is required. double
Database to use for the Redis connection when using the redis strategy
ExtraOptions This property is required. GetGatewayPluginAcmeConfigStorageConfigRedisExtraOptions
Custom ACME Redis options
Host This property is required. string
A string representing a host name, such as example.com.
Password This property is required. string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
Port This property is required. double
An integer representing a port number between 0 and 65535, inclusive.
ServerName This property is required. string
A string representing an SNI (server name indication) value for TLS.
Ssl This property is required. bool
If set to true, uses SSL to connect to Redis.
SslVerify This property is required. bool
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.
Timeout This property is required. double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
Username This property is required. string
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.
Database This property is required. float64
Database to use for the Redis connection when using the redis strategy
ExtraOptions This property is required. GetGatewayPluginAcmeConfigStorageConfigRedisExtraOptions
Custom ACME Redis options
Host This property is required. string
A string representing a host name, such as example.com.
Password This property is required. string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
Port This property is required. float64
An integer representing a port number between 0 and 65535, inclusive.
ServerName This property is required. string
A string representing an SNI (server name indication) value for TLS.
Ssl This property is required. bool
If set to true, uses SSL to connect to Redis.
SslVerify This property is required. bool
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.
Timeout This property is required. float64
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
Username This property is required. string
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.
database This property is required. Double
Database to use for the Redis connection when using the redis strategy
extraOptions This property is required. GetGatewayPluginAcmeConfigStorageConfigRedisExtraOptions
Custom ACME Redis options
host This property is required. String
A string representing a host name, such as example.com.
password This property is required. String
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port This property is required. Double
An integer representing a port number between 0 and 65535, inclusive.
serverName This property is required. String
A string representing an SNI (server name indication) value for TLS.
ssl This property is required. Boolean
If set to true, uses SSL to connect to Redis.
sslVerify This property is required. Boolean
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.
timeout This property is required. Double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
username This property is required. String
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.
database This property is required. number
Database to use for the Redis connection when using the redis strategy
extraOptions This property is required. GetGatewayPluginAcmeConfigStorageConfigRedisExtraOptions
Custom ACME Redis options
host This property is required. string
A string representing a host name, such as example.com.
password This property is required. string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port This property is required. number
An integer representing a port number between 0 and 65535, inclusive.
serverName This property is required. string
A string representing an SNI (server name indication) value for TLS.
ssl This property is required. boolean
If set to true, uses SSL to connect to Redis.
sslVerify This property is required. boolean
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.
timeout This property is required. number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
username This property is required. string
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.
database This property is required. float
Database to use for the Redis connection when using the redis strategy
extra_options This property is required. GetGatewayPluginAcmeConfigStorageConfigRedisExtraOptions
Custom ACME Redis options
host This property is required. str
A string representing a host name, such as example.com.
password This property is required. str
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port This property is required. float
An integer representing a port number between 0 and 65535, inclusive.
server_name This property is required. str
A string representing an SNI (server name indication) value for TLS.
ssl This property is required. bool
If set to true, uses SSL to connect to Redis.
ssl_verify This property is required. bool
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.
timeout This property is required. float
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
username This property is required. str
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.
database This property is required. Number
Database to use for the Redis connection when using the redis strategy
extraOptions This property is required. Property Map
Custom ACME Redis options
host This property is required. String
A string representing a host name, such as example.com.
password This property is required. String
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port This property is required. Number
An integer representing a port number between 0 and 65535, inclusive.
serverName This property is required. String
A string representing an SNI (server name indication) value for TLS.
ssl This property is required. Boolean
If set to true, uses SSL to connect to Redis.
sslVerify This property is required. Boolean
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.
timeout This property is required. Number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
username This property is required. String
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.

GetGatewayPluginAcmeConfigStorageConfigRedisExtraOptions

Namespace This property is required. string
A namespace to prepend to all keys stored in Redis.
ScanCount This property is required. double
The number of keys to return in Redis SCAN calls.
Namespace This property is required. string
A namespace to prepend to all keys stored in Redis.
ScanCount This property is required. float64
The number of keys to return in Redis SCAN calls.
namespace This property is required. String
A namespace to prepend to all keys stored in Redis.
scanCount This property is required. Double
The number of keys to return in Redis SCAN calls.
namespace This property is required. string
A namespace to prepend to all keys stored in Redis.
scanCount This property is required. number
The number of keys to return in Redis SCAN calls.
namespace This property is required. str
A namespace to prepend to all keys stored in Redis.
scan_count This property is required. float
The number of keys to return in Redis SCAN calls.
namespace This property is required. String
A namespace to prepend to all keys stored in Redis.
scanCount This property is required. Number
The number of keys to return in Redis SCAN calls.

GetGatewayPluginAcmeConfigStorageConfigShm

ShmName This property is required. string
Name of shared memory zone used for Kong API gateway storage
ShmName This property is required. string
Name of shared memory zone used for Kong API gateway storage
shmName This property is required. String
Name of shared memory zone used for Kong API gateway storage
shmName This property is required. string
Name of shared memory zone used for Kong API gateway storage
shm_name This property is required. str
Name of shared memory zone used for Kong API gateway storage
shmName This property is required. String
Name of shared memory zone used for Kong API gateway storage

GetGatewayPluginAcmeConfigStorageConfigVault

AuthMethod This property is required. string
Auth Method, default to token, can be 'token' or 'kubernetes'.
AuthPath This property is required. string
Vault's authentication path to use.
AuthRole This property is required. string
The role to try and assign.
Host This property is required. string
A string representing a host name, such as example.com.
Https This property is required. bool
Boolean representation of https.
JwtPath This property is required. string
The path to the JWT.
KvPath This property is required. string
KV prefix path.
Port This property is required. double
An integer representing a port number between 0 and 65535, inclusive.
Timeout This property is required. double
Timeout in milliseconds.
TlsServerName This property is required. string
SNI used in request, default to host if omitted.
TlsVerify This property is required. bool
Turn on TLS verification.
Token This property is required. string
Consul ACL token.
AuthMethod This property is required. string
Auth Method, default to token, can be 'token' or 'kubernetes'.
AuthPath This property is required. string
Vault's authentication path to use.
AuthRole This property is required. string
The role to try and assign.
Host This property is required. string
A string representing a host name, such as example.com.
Https This property is required. bool
Boolean representation of https.
JwtPath This property is required. string
The path to the JWT.
KvPath This property is required. string
KV prefix path.
Port This property is required. float64
An integer representing a port number between 0 and 65535, inclusive.
Timeout This property is required. float64
Timeout in milliseconds.
TlsServerName This property is required. string
SNI used in request, default to host if omitted.
TlsVerify This property is required. bool
Turn on TLS verification.
Token This property is required. string
Consul ACL token.
authMethod This property is required. String
Auth Method, default to token, can be 'token' or 'kubernetes'.
authPath This property is required. String
Vault's authentication path to use.
authRole This property is required. String
The role to try and assign.
host This property is required. String
A string representing a host name, such as example.com.
https This property is required. Boolean
Boolean representation of https.
jwtPath This property is required. String
The path to the JWT.
kvPath This property is required. String
KV prefix path.
port This property is required. Double
An integer representing a port number between 0 and 65535, inclusive.
timeout This property is required. Double
Timeout in milliseconds.
tlsServerName This property is required. String
SNI used in request, default to host if omitted.
tlsVerify This property is required. Boolean
Turn on TLS verification.
token This property is required. String
Consul ACL token.
authMethod This property is required. string
Auth Method, default to token, can be 'token' or 'kubernetes'.
authPath This property is required. string
Vault's authentication path to use.
authRole This property is required. string
The role to try and assign.
host This property is required. string
A string representing a host name, such as example.com.
https This property is required. boolean
Boolean representation of https.
jwtPath This property is required. string
The path to the JWT.
kvPath This property is required. string
KV prefix path.
port This property is required. number
An integer representing a port number between 0 and 65535, inclusive.
timeout This property is required. number
Timeout in milliseconds.
tlsServerName This property is required. string
SNI used in request, default to host if omitted.
tlsVerify This property is required. boolean
Turn on TLS verification.
token This property is required. string
Consul ACL token.
auth_method This property is required. str
Auth Method, default to token, can be 'token' or 'kubernetes'.
auth_path This property is required. str
Vault's authentication path to use.
auth_role This property is required. str
The role to try and assign.
host This property is required. str
A string representing a host name, such as example.com.
https This property is required. bool
Boolean representation of https.
jwt_path This property is required. str
The path to the JWT.
kv_path This property is required. str
KV prefix path.
port This property is required. float
An integer representing a port number between 0 and 65535, inclusive.
timeout This property is required. float
Timeout in milliseconds.
tls_server_name This property is required. str
SNI used in request, default to host if omitted.
tls_verify This property is required. bool
Turn on TLS verification.
token This property is required. str
Consul ACL token.
authMethod This property is required. String
Auth Method, default to token, can be 'token' or 'kubernetes'.
authPath This property is required. String
Vault's authentication path to use.
authRole This property is required. String
The role to try and assign.
host This property is required. String
A string representing a host name, such as example.com.
https This property is required. Boolean
Boolean representation of https.
jwtPath This property is required. String
The path to the JWT.
kvPath This property is required. String
KV prefix path.
port This property is required. Number
An integer representing a port number between 0 and 65535, inclusive.
timeout This property is required. Number
Timeout in milliseconds.
tlsServerName This property is required. String
SNI used in request, default to host if omitted.
tlsVerify This property is required. Boolean
Turn on TLS verification.
token This property is required. String
Consul ACL token.

GetGatewayPluginAcmeOrdering

After This property is required. GetGatewayPluginAcmeOrderingAfter
Before This property is required. GetGatewayPluginAcmeOrderingBefore
After This property is required. GetGatewayPluginAcmeOrderingAfter
Before This property is required. GetGatewayPluginAcmeOrderingBefore
after This property is required. GetGatewayPluginAcmeOrderingAfter
before This property is required. GetGatewayPluginAcmeOrderingBefore
after This property is required. GetGatewayPluginAcmeOrderingAfter
before This property is required. GetGatewayPluginAcmeOrderingBefore
after This property is required. GetGatewayPluginAcmeOrderingAfter
before This property is required. GetGatewayPluginAcmeOrderingBefore
after This property is required. Property Map
before This property is required. Property Map

GetGatewayPluginAcmeOrderingAfter

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginAcmeOrderingBefore

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.