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>
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]
func LookupGatewayPluginAcme(ctx *Context, args *LookupGatewayPluginAcmeArgs, opts ...InvokeOption) (*LookupGatewayPluginAcmeResult, error)
func LookupGatewayPluginAcmeOutput(ctx *Context, args *LookupGatewayPluginAcmeOutputArgs, opts ...InvokeOption) LookupGatewayPluginAcmeResultOutput
> 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)
}
public static CompletableFuture<GetGatewayPluginAcmeResult> getGatewayPluginAcme(GetGatewayPluginAcmeArgs args, InvokeOptions options)
public static Output<GetGatewayPluginAcmeResult> getGatewayPluginAcme(GetGatewayPluginAcmeArgs args, InvokeOptions options)
fn::invoke:
function: konnect:index/getGatewayPluginAcme:getGatewayPluginAcme
arguments:
# arguments dictionary
The following arguments are supported:
- Control
Plane Id This property is required. string
- Control
Plane Id This property is required. string
- control
Plane Id This property is required. String
- control
Plane Id This property is required. string
- control_
plane_ id This property is required. str
- control
Plane Id This property is required. String
getGatewayPluginAcme Result
The following output properties are available:
- Config
Get
Gateway Plugin Acme Config - Control
Plane stringId - Created
At double - Enabled bool
- Id string
- Instance
Name string - Ordering
Get
Gateway Plugin Acme Ordering - Protocols List<string>
- List<string>
- Updated
At double
- Config
Get
Gateway Plugin Acme Config - Control
Plane stringId - Created
At float64 - Enabled bool
- Id string
- Instance
Name string - Ordering
Get
Gateway Plugin Acme Ordering - Protocols []string
- []string
- Updated
At float64
- config
Get
Gateway Plugin Acme Config - control
Plane StringId - created
At Double - enabled Boolean
- id String
- instance
Name String - ordering
Get
Gateway Plugin Acme Ordering - protocols List<String>
- List<String>
- updated
At Double
- config
Get
Gateway Plugin Acme Config - control
Plane stringId - created
At number - enabled boolean
- id string
- instance
Name string - ordering
Get
Gateway Plugin Acme Ordering - protocols string[]
- string[]
- updated
At number
- config
Get
Gateway Plugin Acme Config - control_
plane_ strid - created_
at float - enabled bool
- id str
- instance_
name str - ordering
Get
Gateway Plugin Acme Ordering - protocols Sequence[str]
- Sequence[str]
- updated_
at float
- config Property Map
- control
Plane StringId - created
At Number - enabled Boolean
- id String
- instance
Name String - ordering Property Map
- protocols List<String>
- List<String>
- updated
At Number
Supporting Types
GetGatewayPluginAcmeConfig
- Account
Email This property is required. string - The account identifier. Can be reused in a different plugin instance.
- Account
Key This property is required. GetGateway Plugin Acme Config Account Key - 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 thedomains
list. - Api
Uri This property is required. string - A string representing a URL, such as https://example.com/path/to/resource?q=search.
- Cert
Type This property is required. string - The certificate type to create. The possible values are
rsa
for RSA certificate orecc
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 ('*')
- Eab
Hmac Key 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.
- Eab
Kid 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.
- Enable
Ipv4Common 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. double - 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. string - A string value that specifies the preferred certificate chain to use when generating certificates.
- Renew
Threshold Days This property is required. double - Days remaining to renew the certificate before it expires.
- Rsa
Key Size 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 ofkong
,redis
,consul
, orvault
in production. - Storage
Config This property is required. GetGateway Plugin Acme Config Storage Config - 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.
- Account
Email This property is required. string - The account identifier. Can be reused in a different plugin instance.
- Account
Key This property is required. GetGateway Plugin Acme Config Account Key - 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 thedomains
list. - Api
Uri This property is required. string - A string representing a URL, such as https://example.com/path/to/resource?q=search.
- Cert
Type This property is required. string - The certificate type to create. The possible values are
rsa
for RSA certificate orecc
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 ('*')
- Eab
Hmac Key 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.
- Eab
Kid 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.
- Enable
Ipv4Common 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. float64 - 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. string - A string value that specifies the preferred certificate chain to use when generating certificates.
- Renew
Threshold Days This property is required. float64 - Days remaining to renew the certificate before it expires.
- Rsa
Key Size 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 ofkong
,redis
,consul
, orvault
in production. - Storage
Config This property is required. GetGateway Plugin Acme Config Storage Config - 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.
- account
Email This property is required. String - The account identifier. Can be reused in a different plugin instance.
- account
Key This property is required. GetGateway Plugin Acme Config Account Key - The private key associated with the account.
- allow
Any Domain This property is required. Boolean - If set to
true
, the plugin allows all domains and ignores any values in thedomains
list. - api
Uri This property is required. String - A string representing a URL, such as https://example.com/path/to/resource?q=search.
- cert
Type This property is required. String - The certificate type to create. The possible values are
rsa
for RSA certificate orecc
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 ('*')
- eab
Hmac Key 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.
- eab
Kid 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.
- enable
Ipv4Common Name This property is required. Boolean - 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. Double - 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. String - A string value that specifies the preferred certificate chain to use when generating certificates.
- renew
Threshold Days This property is required. Double - Days remaining to renew the certificate before it expires.
- rsa
Key Size 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 ofkong
,redis
,consul
, orvault
in production. - storage
Config This property is required. GetGateway Plugin Acme Config Storage Config - tos
Accepted 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. string - The account identifier. Can be reused in a different plugin instance.
- account
Key This property is required. GetGateway Plugin Acme Config Account Key - The private key associated with the account.
- allow
Any Domain This property is required. boolean - If set to
true
, the plugin allows all domains and ignores any values in thedomains
list. - api
Uri This property is required. string - A string representing a URL, such as https://example.com/path/to/resource?q=search.
- cert
Type This property is required. string - The certificate type to create. The possible values are
rsa
for RSA certificate orecc
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 ('*')
- eab
Hmac Key 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.
- eab
Kid 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.
- enable
Ipv4Common Name This property is required. boolean - 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. number - 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. string - A string value that specifies the preferred certificate chain to use when generating certificates.
- renew
Threshold Days This property is required. number - Days remaining to renew the certificate before it expires.
- rsa
Key Size 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 ofkong
,redis
,consul
, orvault
in production. - storage
Config This property is required. GetGateway Plugin Acme Config Storage Config - tos
Accepted 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. GetGateway Plugin Acme Config Account Key - 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 thedomains
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 orecc
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 ofkong
,redis
,consul
, orvault
in production. - storage_
config This property is required. GetGateway Plugin Acme Config Storage Config - 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.
- account
Email This property is required. String - The account identifier. Can be reused in a different plugin instance.
- account
Key This property is required. Property Map - The private key associated with the account.
- allow
Any Domain This property is required. Boolean - If set to
true
, the plugin allows all domains and ignores any values in thedomains
list. - api
Uri This property is required. String - A string representing a URL, such as https://example.com/path/to/resource?q=search.
- cert
Type This property is required. String - The certificate type to create. The possible values are
rsa
for RSA certificate orecc
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 ('*')
- eab
Hmac Key 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.
- eab
Kid 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.
- enable
Ipv4Common Name This property is required. Boolean - 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. Number - 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. String - A string value that specifies the preferred certificate chain to use when generating certificates.
- renew
Threshold Days This property is required. Number - Days remaining to renew the certificate before it expires.
- rsa
Key Size 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 ofkong
,redis
,consul
, orvault
in production. - storage
Config This property is required. Property Map - tos
Accepted 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
GetGatewayPluginAcmeConfigStorageConfig
- Consul
This property is required. GetGateway Plugin Acme Config Storage Config Consul - Kong
This property is required. Dictionary<string, string> - Redis
This property is required. GetGateway Plugin Acme Config Storage Config Redis - Shm
This property is required. GetGateway Plugin Acme Config Storage Config Shm - Vault
This property is required. GetGateway Plugin Acme Config Storage Config Vault
- Consul
This property is required. GetGateway Plugin Acme Config Storage Config Consul - Kong
This property is required. map[string]string - Redis
This property is required. GetGateway Plugin Acme Config Storage Config Redis - Shm
This property is required. GetGateway Plugin Acme Config Storage Config Shm - Vault
This property is required. GetGateway Plugin Acme Config Storage Config Vault
- consul
This property is required. GetGateway Plugin Acme Config Storage Config Consul - kong
This property is required. Map<String,String> - redis
This property is required. GetGateway Plugin Acme Config Storage Config Redis - shm
This property is required. GetGateway Plugin Acme Config Storage Config Shm - vault
This property is required. GetGateway Plugin Acme Config Storage Config Vault
- consul
This property is required. GetGateway Plugin Acme Config Storage Config Consul - kong
This property is required. {[key: string]: string} - redis
This property is required. GetGateway Plugin Acme Config Storage Config Redis - shm
This property is required. GetGateway Plugin Acme Config Storage Config Shm - vault
This property is required. GetGateway Plugin Acme Config Storage Config Vault
- consul
This property is required. GetGateway Plugin Acme Config Storage Config Consul - kong
This property is required. Mapping[str, str] - redis
This property is required. GetGateway Plugin Acme Config Storage Config Redis - shm
This property is required. GetGateway Plugin Acme Config Storage Config Shm - vault
This property is required. GetGateway Plugin Acme Config Storage Config Vault
- 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.
- Kv
Path 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.
- Kv
Path 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.
- kv
Path 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.
- kv
Path 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.
- kv
Path 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 - Extra
Options This property is required. GetGateway Plugin Acme Config Storage Config Redis Extra Options - 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.
- Server
Name 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.
- 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
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_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 - Extra
Options This property is required. GetGateway Plugin Acme Config Storage Config Redis Extra Options - 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.
- Server
Name 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.
- 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
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_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 - extra
Options This property is required. GetGateway Plugin Acme Config Storage Config Redis Extra Options - 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.
- server
Name 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.
- ssl
Verify 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
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_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 - extra
Options This property is required. GetGateway Plugin Acme Config Storage Config Redis Extra Options - 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.
- server
Name 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.
- ssl
Verify 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
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_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. GetGateway Plugin Acme Config Storage Config Redis Extra Options - 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
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_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 - extra
Options 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.
- server
Name 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.
- ssl
Verify 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
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_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. 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.
GetGatewayPluginAcmeConfigStorageConfigShm
- Shm
Name This property is required. string - Name of shared memory zone used for Kong API gateway storage
- Shm
Name This property is required. string - Name of shared memory zone used for Kong API gateway storage
- shm
Name This property is required. String - Name of shared memory zone used for Kong API gateway storage
- shm
Name 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
- shm
Name This property is required. String - Name of shared memory zone used for Kong API gateway storage
GetGatewayPluginAcmeConfigStorageConfigVault
- Auth
Method This property is required. string - Auth Method, default to token, can be 'token' or 'kubernetes'.
- Auth
Path This property is required. string - Vault's authentication path to use.
- Auth
Role 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.
- Jwt
Path This property is required. string - The path to the JWT.
- Kv
Path 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.
- Tls
Server Name This property is required. string - 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. string - Consul ACL token.
- Auth
Method This property is required. string - Auth Method, default to token, can be 'token' or 'kubernetes'.
- Auth
Path This property is required. string - Vault's authentication path to use.
- Auth
Role 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.
- Jwt
Path This property is required. string - The path to the JWT.
- Kv
Path 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.
- Tls
Server Name This property is required. string - 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. string - Consul ACL token.
- auth
Method This property is required. String - Auth Method, default to token, can be 'token' or 'kubernetes'.
- auth
Path This property is required. String - Vault's authentication path to use.
- auth
Role 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.
- jwt
Path This property is required. String - The path to the JWT.
- kv
Path 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.
- tls
Server Name This property is required. String - SNI used in request, default to host if omitted.
- tls
Verify This property is required. Boolean - Turn on TLS verification.
- token
This property is required. String - Consul ACL token.
- auth
Method This property is required. string - Auth Method, default to token, can be 'token' or 'kubernetes'.
- auth
Path This property is required. string - Vault's authentication path to use.
- auth
Role 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.
- jwt
Path This property is required. string - The path to the JWT.
- kv
Path 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.
- tls
Server Name This property is required. string - SNI used in request, default to host if omitted.
- tls
Verify 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.
- auth
Method This property is required. String - Auth Method, default to token, can be 'token' or 'kubernetes'.
- auth
Path This property is required. String - Vault's authentication path to use.
- auth
Role 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.
- jwt
Path This property is required. String - The path to the JWT.
- kv
Path 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.
- tls
Server Name This property is required. String - SNI used in request, default to host if omitted.
- tls
Verify This property is required. Boolean - Turn on TLS verification.
- token
This property is required. String - Consul ACL token.
GetGatewayPluginAcmeOrdering
- After
This property is required. GetGateway Plugin Acme Ordering After - Before
This property is required. GetGateway Plugin Acme Ordering Before
- After
This property is required. GetGateway Plugin Acme Ordering After - Before
This property is required. GetGateway Plugin Acme Ordering Before
- after
This property is required. GetGateway Plugin Acme Ordering After - before
This property is required. GetGateway Plugin Acme Ordering Before
- after
This property is required. GetGateway Plugin Acme Ordering After - before
This property is required. GetGateway Plugin Acme Ordering Before
- after
This property is required. GetGateway Plugin Acme Ordering After - before
This property is required. GetGateway Plugin Acme Ordering Before
- 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.