konnect 3.4.1 published on Wednesday, Oct 29, 2025 by kong
konnect.GatewayPluginKafkaConsume
GatewayPluginKafkaConsume Resource
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginKafkaConsume;
import com.pulumi.konnect.GatewayPluginKafkaConsumeArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeConfigAuthenticationArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeConfigSecurityArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumePartialArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeRouteArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myGatewaypluginkafkaconsume = new GatewayPluginKafkaConsume("myGatewaypluginkafkaconsume", GatewayPluginKafkaConsumeArgs.builder()
.config(GatewayPluginKafkaConsumeConfigArgs.builder()
.authentication(GatewayPluginKafkaConsumeConfigAuthenticationArgs.builder()
.mechanism("SCRAM-SHA-512")
.password("...my_password...")
.strategy("sasl")
.tokenauth(true)
.user("...my_user...")
.build())
.auto_offset_reset("earliest")
.bootstrap_servers(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.cluster_name("...my_cluster_name...")
.commit_strategy("off")
.dlq_topic("...my_dlq_topic...")
.enable_dlq(false)
.message_by_lua_functions("...")
.message_deserializer("noop")
.mode("websocket")
.schema_registry(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.security(GatewayPluginKafkaConsumeConfigSecurityArgs.builder()
.certificateId("...my_certificate_id...")
.ssl(true)
.build())
.topics(GatewayPluginKafkaConsumeConfigTopicArgs.builder()
.name("...my_name...")
.schemaRegistry(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs.builder()
.confluent(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs.builder()
.authentication(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs.builder()
.basic(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs.builder()
.password("...my_password...")
.username("...my_username...")
.build())
.mode("none")
.oauth2(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2Args.builder()
.audience("...")
.clientId("...my_client_id...")
.clientSecret("...my_client_secret...")
.grantType("password")
.password("...my_password...")
.scopes("...")
.tokenEndpoint("...my_token_endpoint...")
.tokenHeaders(Map.of("key", serializeJson(
"value")))
.tokenPostArgs(Map.of("key", serializeJson(
"value")))
.username("...my_username...")
.build())
.oauth2Client(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2ClientArgs.builder()
.authMethod("client_secret_basic")
.clientSecretJwtAlg("HS256")
.httpProxy("...my_http_proxy...")
.httpProxyAuthorization("...my_http_proxy_authorization...")
.httpVersion(3.98)
.httpsProxy("...my_https_proxy...")
.httpsProxyAuthorization("...my_https_proxy_authorization...")
.keepAlive(true)
.noProxy("...my_no_proxy...")
.sslVerify(false)
.timeout(217890936)
.build())
.build())
.sslVerify(true)
.ttl(2977.64)
.url("...my_url...")
.build())
.build())
.build())
.build())
.consumer(GatewayPluginKafkaConsumeConsumerArgs.builder()
.id("...my_id...")
.build())
.controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
.createdAt(0)
.enabled(false)
.gatewayPluginKafkaConsumeId("...my_id...")
.instanceName("...my_instance_name...")
.ordering(GatewayPluginKafkaConsumeOrderingArgs.builder()
.after(GatewayPluginKafkaConsumeOrderingAfterArgs.builder()
.access("...")
.build())
.before(GatewayPluginKafkaConsumeOrderingBeforeArgs.builder()
.access("...")
.build())
.build())
.partials(GatewayPluginKafkaConsumePartialArgs.builder()
.id("...my_id...")
.name("...my_name...")
.path("...my_path...")
.build())
.protocols("wss")
.route(GatewayPluginKafkaConsumeRouteArgs.builder()
.id("...my_id...")
.build())
.tags("...")
.updatedAt(0)
.build());
}
}
resources:
myGatewaypluginkafkaconsume:
type: konnect:GatewayPluginKafkaConsume
properties:
config:
authentication:
mechanism: SCRAM-SHA-512
password: '...my_password...'
strategy: sasl
tokenauth: true
user: '...my_user...'
auto_offset_reset: earliest
bootstrap_servers:
- host: '...my_host...'
port: 27325
cluster_name: '...my_cluster_name...'
commit_strategy: off
dlq_topic: '...my_dlq_topic...'
enable_dlq: false
message_by_lua_functions:
- '...'
message_deserializer: noop
mode: websocket
schema_registry:
confluent:
authentication:
basic:
password: '...my_password...'
username: '...my_username...'
mode: oauth2
oauth2:
audience:
- '...'
clientId: '...my_client_id...'
clientSecret: '...my_client_secret...'
grantType: client_credentials
password: '...my_password...'
scopes:
- '...'
tokenEndpoint: '...my_token_endpoint...'
tokenHeaders:
key:
fn::toJSON: value
tokenPostArgs:
key:
fn::toJSON: value
username: '...my_username...'
oauth2Client:
authMethod: client_secret_basic
clientSecretJwtAlg: HS256
httpProxy: '...my_http_proxy...'
httpProxyAuthorization: '...my_http_proxy_authorization...'
httpVersion: 6.33
httpsProxy: '...my_https_proxy...'
httpsProxyAuthorization: '...my_https_proxy_authorization...'
keepAlive: false
noProxy: '...my_no_proxy...'
sslVerify: true
timeout: 2.132166923e+09
sslVerify: false
ttl: 1981.8
url: '...my_url...'
security:
certificateId: '...my_certificate_id...'
ssl: true
topics:
- name: '...my_name...'
schemaRegistry:
confluent:
authentication:
basic:
password: '...my_password...'
username: '...my_username...'
mode: none
oauth2:
audience:
- '...'
clientId: '...my_client_id...'
clientSecret: '...my_client_secret...'
grantType: password
password: '...my_password...'
scopes:
- '...'
tokenEndpoint: '...my_token_endpoint...'
tokenHeaders:
key:
fn::toJSON: value
tokenPostArgs:
key:
fn::toJSON: value
username: '...my_username...'
oauth2Client:
authMethod: client_secret_basic
clientSecretJwtAlg: HS256
httpProxy: '...my_http_proxy...'
httpProxyAuthorization: '...my_http_proxy_authorization...'
httpVersion: 3.98
httpsProxy: '...my_https_proxy...'
httpsProxyAuthorization: '...my_https_proxy_authorization...'
keepAlive: true
noProxy: '...my_no_proxy...'
sslVerify: false
timeout: 2.17890936e+08
sslVerify: true
ttl: 2977.64
url: '...my_url...'
consumer:
id: '...my_id...'
controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
createdAt: 0
enabled: false
gatewayPluginKafkaConsumeId: '...my_id...'
instanceName: '...my_instance_name...'
ordering:
after:
access:
- '...'
before:
access:
- '...'
partials:
- id: '...my_id...'
name: '...my_name...'
path: '...my_path...'
protocols:
- wss
route:
id: '...my_id...'
tags:
- '...'
updatedAt: 0
Create GatewayPluginKafkaConsume Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayPluginKafkaConsume(name: string, args: GatewayPluginKafkaConsumeArgs, opts?: CustomResourceOptions);@overload
def GatewayPluginKafkaConsume(resource_name: str,
args: GatewayPluginKafkaConsumeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayPluginKafkaConsume(resource_name: str,
opts: Optional[ResourceOptions] = None,
control_plane_id: Optional[str] = None,
config: Optional[GatewayPluginKafkaConsumeConfigArgs] = None,
instance_name: Optional[str] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
gateway_plugin_kafka_consume_id: Optional[str] = None,
consumer: Optional[GatewayPluginKafkaConsumeConsumerArgs] = None,
ordering: Optional[GatewayPluginKafkaConsumeOrderingArgs] = None,
partials: Optional[Sequence[GatewayPluginKafkaConsumePartialArgs]] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginKafkaConsumeRouteArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None)func NewGatewayPluginKafkaConsume(ctx *Context, name string, args GatewayPluginKafkaConsumeArgs, opts ...ResourceOption) (*GatewayPluginKafkaConsume, error)public GatewayPluginKafkaConsume(string name, GatewayPluginKafkaConsumeArgs args, CustomResourceOptions? opts = null)
public GatewayPluginKafkaConsume(String name, GatewayPluginKafkaConsumeArgs args)
public GatewayPluginKafkaConsume(String name, GatewayPluginKafkaConsumeArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginKafkaConsume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GatewayPluginKafkaConsumeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GatewayPluginKafkaConsumeArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GatewayPluginKafkaConsumeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayPluginKafkaConsumeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayPluginKafkaConsumeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gatewayPluginKafkaConsumeResource = new Konnect.GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource", new()
{
ControlPlaneId = "string",
Config = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigArgs
{
BootstrapServers = new[]
{
new Konnect.Inputs.GatewayPluginKafkaConsumeConfigBootstrapServerArgs
{
Host = "string",
Port = 0,
},
},
Topics = new[]
{
new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicArgs
{
Name = "string",
SchemaRegistry = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs
{
Confluent = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs
{
Authentication = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs
{
Basic = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs
{
Password = "string",
Username = "string",
},
Mode = "string",
Oauth2 = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2Args
{
Audiences = new[]
{
"string",
},
ClientId = "string",
ClientSecret = "string",
GrantType = "string",
Password = "string",
Scopes = new[]
{
"string",
},
TokenEndpoint = "string",
TokenHeaders =
{
{ "string", "string" },
},
TokenPostArgs =
{
{ "string", "string" },
},
Username = "string",
},
Oauth2Client = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2ClientArgs
{
AuthMethod = "string",
ClientSecretJwtAlg = "string",
HttpProxy = "string",
HttpProxyAuthorization = "string",
HttpVersion = 0,
HttpsProxy = "string",
HttpsProxyAuthorization = "string",
KeepAlive = false,
NoProxy = "string",
SslVerify = false,
Timeout = 0,
},
},
SslVerify = false,
Ttl = 0,
Url = "string",
},
},
},
},
EnableDlq = false,
ClusterName = "string",
CommitStrategy = "string",
DlqTopic = "string",
Authentication = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigAuthenticationArgs
{
Mechanism = "string",
Password = "string",
Strategy = "string",
Tokenauth = false,
User = "string",
},
MessageByLuaFunctions = new[]
{
"string",
},
MessageDeserializer = "string",
Mode = "string",
SchemaRegistry = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryArgs
{
Confluent = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentArgs
{
Authentication = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationArgs
{
Basic = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasicArgs
{
Password = "string",
Username = "string",
},
Mode = "string",
Oauth2 = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2Args
{
Audiences = new[]
{
"string",
},
ClientId = "string",
ClientSecret = "string",
GrantType = "string",
Password = "string",
Scopes = new[]
{
"string",
},
TokenEndpoint = "string",
TokenHeaders =
{
{ "string", "string" },
},
TokenPostArgs =
{
{ "string", "string" },
},
Username = "string",
},
Oauth2Client = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2ClientArgs
{
AuthMethod = "string",
ClientSecretJwtAlg = "string",
HttpProxy = "string",
HttpProxyAuthorization = "string",
HttpVersion = 0,
HttpsProxy = "string",
HttpsProxyAuthorization = "string",
KeepAlive = false,
NoProxy = "string",
SslVerify = false,
Timeout = 0,
},
},
SslVerify = false,
Ttl = 0,
Url = "string",
},
},
Security = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSecurityArgs
{
CertificateId = "string",
Ssl = false,
},
AutoOffsetReset = "string",
},
InstanceName = "string",
CreatedAt = 0,
Enabled = false,
GatewayPluginKafkaConsumeId = "string",
Consumer = new Konnect.Inputs.GatewayPluginKafkaConsumeConsumerArgs
{
Id = "string",
},
Ordering = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingArgs
{
After = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingAfterArgs
{
Accesses = new[]
{
"string",
},
},
Before = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingBeforeArgs
{
Accesses = new[]
{
"string",
},
},
},
Partials = new[]
{
new Konnect.Inputs.GatewayPluginKafkaConsumePartialArgs
{
Id = "string",
Name = "string",
Path = "string",
},
},
Protocols = new[]
{
"string",
},
Route = new Konnect.Inputs.GatewayPluginKafkaConsumeRouteArgs
{
Id = "string",
},
Tags = new[]
{
"string",
},
UpdatedAt = 0,
});
example, err := konnect.NewGatewayPluginKafkaConsume(ctx, "gatewayPluginKafkaConsumeResource", &konnect.GatewayPluginKafkaConsumeArgs{
ControlPlaneId: pulumi.String("string"),
Config: &konnect.GatewayPluginKafkaConsumeConfigArgs{
BootstrapServers: konnect.GatewayPluginKafkaConsumeConfigBootstrapServerArray{
&konnect.GatewayPluginKafkaConsumeConfigBootstrapServerArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
Topics: konnect.GatewayPluginKafkaConsumeConfigTopicArray{
&konnect.GatewayPluginKafkaConsumeConfigTopicArgs{
Name: pulumi.String("string"),
SchemaRegistry: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs{
Confluent: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs{
Authentication: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs{
Basic: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
Mode: pulumi.String("string"),
Oauth2: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2Args{
Audiences: pulumi.StringArray{
pulumi.String("string"),
},
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
GrantType: pulumi.String("string"),
Password: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
TokenEndpoint: pulumi.String("string"),
TokenHeaders: pulumi.StringMap{
"string": pulumi.String("string"),
},
TokenPostArgs: pulumi.StringMap{
"string": pulumi.String("string"),
},
Username: pulumi.String("string"),
},
Oauth2Client: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2ClientArgs{
AuthMethod: pulumi.String("string"),
ClientSecretJwtAlg: pulumi.String("string"),
HttpProxy: pulumi.String("string"),
HttpProxyAuthorization: pulumi.String("string"),
HttpVersion: pulumi.Float64(0),
HttpsProxy: pulumi.String("string"),
HttpsProxyAuthorization: pulumi.String("string"),
KeepAlive: pulumi.Bool(false),
NoProxy: pulumi.String("string"),
SslVerify: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
},
},
SslVerify: pulumi.Bool(false),
Ttl: pulumi.Float64(0),
Url: pulumi.String("string"),
},
},
},
},
EnableDlq: pulumi.Bool(false),
ClusterName: pulumi.String("string"),
CommitStrategy: pulumi.String("string"),
DlqTopic: pulumi.String("string"),
Authentication: &konnect.GatewayPluginKafkaConsumeConfigAuthenticationArgs{
Mechanism: pulumi.String("string"),
Password: pulumi.String("string"),
Strategy: pulumi.String("string"),
Tokenauth: pulumi.Bool(false),
User: pulumi.String("string"),
},
MessageByLuaFunctions: pulumi.StringArray{
pulumi.String("string"),
},
MessageDeserializer: pulumi.String("string"),
Mode: pulumi.String("string"),
SchemaRegistry: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryArgs{
Confluent: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentArgs{
Authentication: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationArgs{
Basic: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasicArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
Mode: pulumi.String("string"),
Oauth2: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2Args{
Audiences: pulumi.StringArray{
pulumi.String("string"),
},
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
GrantType: pulumi.String("string"),
Password: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
TokenEndpoint: pulumi.String("string"),
TokenHeaders: pulumi.StringMap{
"string": pulumi.String("string"),
},
TokenPostArgs: pulumi.StringMap{
"string": pulumi.String("string"),
},
Username: pulumi.String("string"),
},
Oauth2Client: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2ClientArgs{
AuthMethod: pulumi.String("string"),
ClientSecretJwtAlg: pulumi.String("string"),
HttpProxy: pulumi.String("string"),
HttpProxyAuthorization: pulumi.String("string"),
HttpVersion: pulumi.Float64(0),
HttpsProxy: pulumi.String("string"),
HttpsProxyAuthorization: pulumi.String("string"),
KeepAlive: pulumi.Bool(false),
NoProxy: pulumi.String("string"),
SslVerify: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
},
},
SslVerify: pulumi.Bool(false),
Ttl: pulumi.Float64(0),
Url: pulumi.String("string"),
},
},
Security: &konnect.GatewayPluginKafkaConsumeConfigSecurityArgs{
CertificateId: pulumi.String("string"),
Ssl: pulumi.Bool(false),
},
AutoOffsetReset: pulumi.String("string"),
},
InstanceName: pulumi.String("string"),
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
GatewayPluginKafkaConsumeId: pulumi.String("string"),
Consumer: &konnect.GatewayPluginKafkaConsumeConsumerArgs{
Id: pulumi.String("string"),
},
Ordering: &konnect.GatewayPluginKafkaConsumeOrderingArgs{
After: &konnect.GatewayPluginKafkaConsumeOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &konnect.GatewayPluginKafkaConsumeOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Partials: konnect.GatewayPluginKafkaConsumePartialArray{
&konnect.GatewayPluginKafkaConsumePartialArgs{
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Path: pulumi.String("string"),
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &konnect.GatewayPluginKafkaConsumeRouteArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})
var gatewayPluginKafkaConsumeResource = new GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource", GatewayPluginKafkaConsumeArgs.builder()
.controlPlaneId("string")
.config(GatewayPluginKafkaConsumeConfigArgs.builder()
.bootstrapServers(GatewayPluginKafkaConsumeConfigBootstrapServerArgs.builder()
.host("string")
.port(0.0)
.build())
.topics(GatewayPluginKafkaConsumeConfigTopicArgs.builder()
.name("string")
.schemaRegistry(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs.builder()
.confluent(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs.builder()
.authentication(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs.builder()
.basic(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs.builder()
.password("string")
.username("string")
.build())
.mode("string")
.oauth2(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2Args.builder()
.audiences("string")
.clientId("string")
.clientSecret("string")
.grantType("string")
.password("string")
.scopes("string")
.tokenEndpoint("string")
.tokenHeaders(Map.of("string", "string"))
.tokenPostArgs(Map.of("string", "string"))
.username("string")
.build())
.oauth2Client(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2ClientArgs.builder()
.authMethod("string")
.clientSecretJwtAlg("string")
.httpProxy("string")
.httpProxyAuthorization("string")
.httpVersion(0.0)
.httpsProxy("string")
.httpsProxyAuthorization("string")
.keepAlive(false)
.noProxy("string")
.sslVerify(false)
.timeout(0.0)
.build())
.build())
.sslVerify(false)
.ttl(0.0)
.url("string")
.build())
.build())
.build())
.enableDlq(false)
.clusterName("string")
.commitStrategy("string")
.dlqTopic("string")
.authentication(GatewayPluginKafkaConsumeConfigAuthenticationArgs.builder()
.mechanism("string")
.password("string")
.strategy("string")
.tokenauth(false)
.user("string")
.build())
.messageByLuaFunctions("string")
.messageDeserializer("string")
.mode("string")
.schemaRegistry(GatewayPluginKafkaConsumeConfigSchemaRegistryArgs.builder()
.confluent(GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentArgs.builder()
.authentication(GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationArgs.builder()
.basic(GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasicArgs.builder()
.password("string")
.username("string")
.build())
.mode("string")
.oauth2(GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2Args.builder()
.audiences("string")
.clientId("string")
.clientSecret("string")
.grantType("string")
.password("string")
.scopes("string")
.tokenEndpoint("string")
.tokenHeaders(Map.of("string", "string"))
.tokenPostArgs(Map.of("string", "string"))
.username("string")
.build())
.oauth2Client(GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2ClientArgs.builder()
.authMethod("string")
.clientSecretJwtAlg("string")
.httpProxy("string")
.httpProxyAuthorization("string")
.httpVersion(0.0)
.httpsProxy("string")
.httpsProxyAuthorization("string")
.keepAlive(false)
.noProxy("string")
.sslVerify(false)
.timeout(0.0)
.build())
.build())
.sslVerify(false)
.ttl(0.0)
.url("string")
.build())
.build())
.security(GatewayPluginKafkaConsumeConfigSecurityArgs.builder()
.certificateId("string")
.ssl(false)
.build())
.autoOffsetReset("string")
.build())
.instanceName("string")
.createdAt(0.0)
.enabled(false)
.gatewayPluginKafkaConsumeId("string")
.consumer(GatewayPluginKafkaConsumeConsumerArgs.builder()
.id("string")
.build())
.ordering(GatewayPluginKafkaConsumeOrderingArgs.builder()
.after(GatewayPluginKafkaConsumeOrderingAfterArgs.builder()
.accesses("string")
.build())
.before(GatewayPluginKafkaConsumeOrderingBeforeArgs.builder()
.accesses("string")
.build())
.build())
.partials(GatewayPluginKafkaConsumePartialArgs.builder()
.id("string")
.name("string")
.path("string")
.build())
.protocols("string")
.route(GatewayPluginKafkaConsumeRouteArgs.builder()
.id("string")
.build())
.tags("string")
.updatedAt(0.0)
.build());
gateway_plugin_kafka_consume_resource = konnect.GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource",
control_plane_id="string",
config={
"bootstrap_servers": [{
"host": "string",
"port": 0,
}],
"topics": [{
"name": "string",
"schema_registry": {
"confluent": {
"authentication": {
"basic": {
"password": "string",
"username": "string",
},
"mode": "string",
"oauth2": {
"audiences": ["string"],
"client_id": "string",
"client_secret": "string",
"grant_type": "string",
"password": "string",
"scopes": ["string"],
"token_endpoint": "string",
"token_headers": {
"string": "string",
},
"token_post_args": {
"string": "string",
},
"username": "string",
},
"oauth2_client": {
"auth_method": "string",
"client_secret_jwt_alg": "string",
"http_proxy": "string",
"http_proxy_authorization": "string",
"http_version": 0,
"https_proxy": "string",
"https_proxy_authorization": "string",
"keep_alive": False,
"no_proxy": "string",
"ssl_verify": False,
"timeout": 0,
},
},
"ssl_verify": False,
"ttl": 0,
"url": "string",
},
},
}],
"enable_dlq": False,
"cluster_name": "string",
"commit_strategy": "string",
"dlq_topic": "string",
"authentication": {
"mechanism": "string",
"password": "string",
"strategy": "string",
"tokenauth": False,
"user": "string",
},
"message_by_lua_functions": ["string"],
"message_deserializer": "string",
"mode": "string",
"schema_registry": {
"confluent": {
"authentication": {
"basic": {
"password": "string",
"username": "string",
},
"mode": "string",
"oauth2": {
"audiences": ["string"],
"client_id": "string",
"client_secret": "string",
"grant_type": "string",
"password": "string",
"scopes": ["string"],
"token_endpoint": "string",
"token_headers": {
"string": "string",
},
"token_post_args": {
"string": "string",
},
"username": "string",
},
"oauth2_client": {
"auth_method": "string",
"client_secret_jwt_alg": "string",
"http_proxy": "string",
"http_proxy_authorization": "string",
"http_version": 0,
"https_proxy": "string",
"https_proxy_authorization": "string",
"keep_alive": False,
"no_proxy": "string",
"ssl_verify": False,
"timeout": 0,
},
},
"ssl_verify": False,
"ttl": 0,
"url": "string",
},
},
"security": {
"certificate_id": "string",
"ssl": False,
},
"auto_offset_reset": "string",
},
instance_name="string",
created_at=0,
enabled=False,
gateway_plugin_kafka_consume_id="string",
consumer={
"id": "string",
},
ordering={
"after": {
"accesses": ["string"],
},
"before": {
"accesses": ["string"],
},
},
partials=[{
"id": "string",
"name": "string",
"path": "string",
}],
protocols=["string"],
route={
"id": "string",
},
tags=["string"],
updated_at=0)
const gatewayPluginKafkaConsumeResource = new konnect.GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource", {
controlPlaneId: "string",
config: {
bootstrapServers: [{
host: "string",
port: 0,
}],
topics: [{
name: "string",
schemaRegistry: {
confluent: {
authentication: {
basic: {
password: "string",
username: "string",
},
mode: "string",
oauth2: {
audiences: ["string"],
clientId: "string",
clientSecret: "string",
grantType: "string",
password: "string",
scopes: ["string"],
tokenEndpoint: "string",
tokenHeaders: {
string: "string",
},
tokenPostArgs: {
string: "string",
},
username: "string",
},
oauth2Client: {
authMethod: "string",
clientSecretJwtAlg: "string",
httpProxy: "string",
httpProxyAuthorization: "string",
httpVersion: 0,
httpsProxy: "string",
httpsProxyAuthorization: "string",
keepAlive: false,
noProxy: "string",
sslVerify: false,
timeout: 0,
},
},
sslVerify: false,
ttl: 0,
url: "string",
},
},
}],
enableDlq: false,
clusterName: "string",
commitStrategy: "string",
dlqTopic: "string",
authentication: {
mechanism: "string",
password: "string",
strategy: "string",
tokenauth: false,
user: "string",
},
messageByLuaFunctions: ["string"],
messageDeserializer: "string",
mode: "string",
schemaRegistry: {
confluent: {
authentication: {
basic: {
password: "string",
username: "string",
},
mode: "string",
oauth2: {
audiences: ["string"],
clientId: "string",
clientSecret: "string",
grantType: "string",
password: "string",
scopes: ["string"],
tokenEndpoint: "string",
tokenHeaders: {
string: "string",
},
tokenPostArgs: {
string: "string",
},
username: "string",
},
oauth2Client: {
authMethod: "string",
clientSecretJwtAlg: "string",
httpProxy: "string",
httpProxyAuthorization: "string",
httpVersion: 0,
httpsProxy: "string",
httpsProxyAuthorization: "string",
keepAlive: false,
noProxy: "string",
sslVerify: false,
timeout: 0,
},
},
sslVerify: false,
ttl: 0,
url: "string",
},
},
security: {
certificateId: "string",
ssl: false,
},
autoOffsetReset: "string",
},
instanceName: "string",
createdAt: 0,
enabled: false,
gatewayPluginKafkaConsumeId: "string",
consumer: {
id: "string",
},
ordering: {
after: {
accesses: ["string"],
},
before: {
accesses: ["string"],
},
},
partials: [{
id: "string",
name: "string",
path: "string",
}],
protocols: ["string"],
route: {
id: "string",
},
tags: ["string"],
updatedAt: 0,
});
type: konnect:GatewayPluginKafkaConsume
properties:
config:
authentication:
mechanism: string
password: string
strategy: string
tokenauth: false
user: string
autoOffsetReset: string
bootstrapServers:
- host: string
port: 0
clusterName: string
commitStrategy: string
dlqTopic: string
enableDlq: false
messageByLuaFunctions:
- string
messageDeserializer: string
mode: string
schemaRegistry:
confluent:
authentication:
basic:
password: string
username: string
mode: string
oauth2:
audiences:
- string
clientId: string
clientSecret: string
grantType: string
password: string
scopes:
- string
tokenEndpoint: string
tokenHeaders:
string: string
tokenPostArgs:
string: string
username: string
oauth2Client:
authMethod: string
clientSecretJwtAlg: string
httpProxy: string
httpProxyAuthorization: string
httpVersion: 0
httpsProxy: string
httpsProxyAuthorization: string
keepAlive: false
noProxy: string
sslVerify: false
timeout: 0
sslVerify: false
ttl: 0
url: string
security:
certificateId: string
ssl: false
topics:
- name: string
schemaRegistry:
confluent:
authentication:
basic:
password: string
username: string
mode: string
oauth2:
audiences:
- string
clientId: string
clientSecret: string
grantType: string
password: string
scopes:
- string
tokenEndpoint: string
tokenHeaders:
string: string
tokenPostArgs:
string: string
username: string
oauth2Client:
authMethod: string
clientSecretJwtAlg: string
httpProxy: string
httpProxyAuthorization: string
httpVersion: 0
httpsProxy: string
httpsProxyAuthorization: string
keepAlive: false
noProxy: string
sslVerify: false
timeout: 0
sslVerify: false
ttl: 0
url: string
consumer:
id: string
controlPlaneId: string
createdAt: 0
enabled: false
gatewayPluginKafkaConsumeId: string
instanceName: string
ordering:
after:
accesses:
- string
before:
accesses:
- string
partials:
- id: string
name: string
path: string
protocols:
- string
route:
id: string
tags:
- string
updatedAt: 0
GatewayPluginKafkaConsume Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GatewayPluginKafkaConsume resource accepts the following input properties:
- Config
Gateway
Plugin Kafka Consume Config - Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Consumer
Gateway
Plugin Kafka Consume Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied. Default: true
- Gateway
Plugin stringKafka Consume Id - A string representing a UUID (universally unique identifier).
- Instance
Name string - A unique string representing a UTF-8 encoded name.
- Ordering
Gateway
Plugin Kafka Consume Ordering - Partials
List<Gateway
Plugin Kafka Consume Partial> - A list of partials to be used by the plugin.
- Protocols List<string>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- Route
Gateway
Plugin Kafka Consume Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At double - Unix epoch when the resource was last updated.
- Config
Gateway
Plugin Kafka Consume Config Args - Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Consumer
Gateway
Plugin Kafka Consume Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied. Default: true
- Gateway
Plugin stringKafka Consume Id - A string representing a UUID (universally unique identifier).
- Instance
Name string - A unique string representing a UTF-8 encoded name.
- Ordering
Gateway
Plugin Kafka Consume Ordering Args - Partials
[]Gateway
Plugin Kafka Consume Partial Args - A list of partials to be used by the plugin.
- Protocols []string
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- Route
Gateway
Plugin Kafka Consume Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At float64 - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Kafka Consume Config - control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Kafka Consume Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin StringKafka Consume Id - A string representing a UUID (universally unique identifier).
- instance
Name String - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Kafka Consume Ordering - partials
List<Gateway
Plugin Kafka Consume Partial> - A list of partials to be used by the plugin.
- protocols List<String>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Kafka Consume Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Double - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Kafka Consume Config - control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Kafka Consume Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin stringKafka Consume Id - A string representing a UUID (universally unique identifier).
- instance
Name string - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Kafka Consume Ordering - partials
Gateway
Plugin Kafka Consume Partial[] - A list of partials to be used by the plugin.
- protocols string[]
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Kafka Consume Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At number - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Kafka Consume Config Args - control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Kafka Consume Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- created_
at float - Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied. Default: true
- gateway_
plugin_ strkafka_ consume_ id - A string representing a UUID (universally unique identifier).
- instance_
name str - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Kafka Consume Ordering Args - partials
Sequence[Gateway
Plugin Kafka Consume Partial Args] - A list of partials to be used by the plugin.
- protocols Sequence[str]
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Kafka Consume Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated_
at float - Unix epoch when the resource was last updated.
- config Property Map
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer Property Map
- If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin StringKafka Consume Id - A string representing a UUID (universally unique identifier).
- instance
Name String - A unique string representing a UTF-8 encoded name.
- ordering Property Map
- partials List<Property Map>
- A list of partials to be used by the plugin.
- protocols List<String>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route Property Map
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Number - Unix epoch when the resource was last updated.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayPluginKafkaConsume resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GatewayPluginKafkaConsume Resource
Get an existing GatewayPluginKafkaConsume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GatewayPluginKafkaConsumeState, opts?: CustomResourceOptions): GatewayPluginKafkaConsume@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
config: Optional[GatewayPluginKafkaConsumeConfigArgs] = None,
consumer: Optional[GatewayPluginKafkaConsumeConsumerArgs] = None,
control_plane_id: Optional[str] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
gateway_plugin_kafka_consume_id: Optional[str] = None,
instance_name: Optional[str] = None,
ordering: Optional[GatewayPluginKafkaConsumeOrderingArgs] = None,
partials: Optional[Sequence[GatewayPluginKafkaConsumePartialArgs]] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginKafkaConsumeRouteArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None) -> GatewayPluginKafkaConsumefunc GetGatewayPluginKafkaConsume(ctx *Context, name string, id IDInput, state *GatewayPluginKafkaConsumeState, opts ...ResourceOption) (*GatewayPluginKafkaConsume, error)public static GatewayPluginKafkaConsume Get(string name, Input<string> id, GatewayPluginKafkaConsumeState? state, CustomResourceOptions? opts = null)public static GatewayPluginKafkaConsume get(String name, Output<String> id, GatewayPluginKafkaConsumeState state, CustomResourceOptions options)resources: _: type: konnect:GatewayPluginKafkaConsume get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Config
Gateway
Plugin Kafka Consume Config - Consumer
Gateway
Plugin Kafka Consume Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied. Default: true
- Gateway
Plugin stringKafka Consume Id - A string representing a UUID (universally unique identifier).
- Instance
Name string - A unique string representing a UTF-8 encoded name.
- Ordering
Gateway
Plugin Kafka Consume Ordering - Partials
List<Gateway
Plugin Kafka Consume Partial> - A list of partials to be used by the plugin.
- Protocols List<string>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- Route
Gateway
Plugin Kafka Consume Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At double - Unix epoch when the resource was last updated.
- Config
Gateway
Plugin Kafka Consume Config Args - Consumer
Gateway
Plugin Kafka Consume Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied. Default: true
- Gateway
Plugin stringKafka Consume Id - A string representing a UUID (universally unique identifier).
- Instance
Name string - A unique string representing a UTF-8 encoded name.
- Ordering
Gateway
Plugin Kafka Consume Ordering Args - Partials
[]Gateway
Plugin Kafka Consume Partial Args - A list of partials to be used by the plugin.
- Protocols []string
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- Route
Gateway
Plugin Kafka Consume Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At float64 - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Kafka Consume Config - consumer
Gateway
Plugin Kafka Consume Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin StringKafka Consume Id - A string representing a UUID (universally unique identifier).
- instance
Name String - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Kafka Consume Ordering - partials
List<Gateway
Plugin Kafka Consume Partial> - A list of partials to be used by the plugin.
- protocols List<String>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Kafka Consume Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Double - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Kafka Consume Config - consumer
Gateway
Plugin Kafka Consume Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin stringKafka Consume Id - A string representing a UUID (universally unique identifier).
- instance
Name string - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Kafka Consume Ordering - partials
Gateway
Plugin Kafka Consume Partial[] - A list of partials to be used by the plugin.
- protocols string[]
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Kafka Consume Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At number - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Kafka Consume Config Args - consumer
Gateway
Plugin Kafka Consume Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created_
at float - Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied. Default: true
- gateway_
plugin_ strkafka_ consume_ id - A string representing a UUID (universally unique identifier).
- instance_
name str - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Kafka Consume Ordering Args - partials
Sequence[Gateway
Plugin Kafka Consume Partial Args] - A list of partials to be used by the plugin.
- protocols Sequence[str]
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Kafka Consume Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated_
at float - Unix epoch when the resource was last updated.
- config Property Map
- consumer Property Map
- If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin StringKafka Consume Id - A string representing a UUID (universally unique identifier).
- instance
Name String - A unique string representing a UTF-8 encoded name.
- ordering Property Map
- partials List<Property Map>
- A list of partials to be used by the plugin.
- protocols List<String>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route Property Map
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Number - Unix epoch when the resource was last updated.
Supporting Types
GatewayPluginKafkaConsumeConfig, GatewayPluginKafkaConsumeConfigArgs
- Bootstrap
Servers List<GatewayPlugin Kafka Consume Config Bootstrap Server> - Set of bootstrap brokers in a
{host: host, port: port}list format. - Topics
List<Gateway
Plugin Kafka Consume Config Topic> - The Kafka topics and their configuration you want to consume from.
- Authentication
Gateway
Plugin Kafka Consume Config Authentication - Auto
Offset stringReset - The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
- Cluster
Name string - An identifier for the Kafka cluster.
- Commit
Strategy string - The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
- Dlq
Topic string - The topic to use for the Dead Letter Queue.
- Enable
Dlq bool - Enables Dead Letter Queue. When enabled, if the message doesn't conform to the schema (from Schema Registry) or there's an error in the
message_by_lua_functions, it will be forwarded todlq_topicthat can be processed later. - Message
By List<string>Lua Functions - The Lua functions that manipulates the message being sent to the client.
- Message
Deserializer string - The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
- Mode string
- The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
- Schema
Registry GatewayPlugin Kafka Consume Config Schema Registry - The plugin-global schema registry configuration.
- Security
Gateway
Plugin Kafka Consume Config Security
- Bootstrap
Servers []GatewayPlugin Kafka Consume Config Bootstrap Server - Set of bootstrap brokers in a
{host: host, port: port}list format. - Topics
[]Gateway
Plugin Kafka Consume Config Topic - The Kafka topics and their configuration you want to consume from.
- Authentication
Gateway
Plugin Kafka Consume Config Authentication - Auto
Offset stringReset - The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
- Cluster
Name string - An identifier for the Kafka cluster.
- Commit
Strategy string - The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
- Dlq
Topic string - The topic to use for the Dead Letter Queue.
- Enable
Dlq bool - Enables Dead Letter Queue. When enabled, if the message doesn't conform to the schema (from Schema Registry) or there's an error in the
message_by_lua_functions, it will be forwarded todlq_topicthat can be processed later. - Message
By []stringLua Functions - The Lua functions that manipulates the message being sent to the client.
- Message
Deserializer string - The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
- Mode string
- The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
- Schema
Registry GatewayPlugin Kafka Consume Config Schema Registry - The plugin-global schema registry configuration.
- Security
Gateway
Plugin Kafka Consume Config Security
- bootstrap
Servers List<GatewayPlugin Kafka Consume Config Bootstrap Server> - Set of bootstrap brokers in a
{host: host, port: port}list format. - topics
List<Gateway
Plugin Kafka Consume Config Topic> - The Kafka topics and their configuration you want to consume from.
- authentication
Gateway
Plugin Kafka Consume Config Authentication - auto
Offset StringReset - The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
- cluster
Name String - An identifier for the Kafka cluster.
- commit
Strategy String - The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
- dlq
Topic String - The topic to use for the Dead Letter Queue.
- enable
Dlq Boolean - Enables Dead Letter Queue. When enabled, if the message doesn't conform to the schema (from Schema Registry) or there's an error in the
message_by_lua_functions, it will be forwarded todlq_topicthat can be processed later. - message
By List<String>Lua Functions - The Lua functions that manipulates the message being sent to the client.
- message
Deserializer String - The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
- mode String
- The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
- schema
Registry GatewayPlugin Kafka Consume Config Schema Registry - The plugin-global schema registry configuration.
- security
Gateway
Plugin Kafka Consume Config Security
- bootstrap
Servers GatewayPlugin Kafka Consume Config Bootstrap Server[] - Set of bootstrap brokers in a
{host: host, port: port}list format. - topics
Gateway
Plugin Kafka Consume Config Topic[] - The Kafka topics and their configuration you want to consume from.
- authentication
Gateway
Plugin Kafka Consume Config Authentication - auto
Offset stringReset - The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
- cluster
Name string - An identifier for the Kafka cluster.
- commit
Strategy string - The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
- dlq
Topic string - The topic to use for the Dead Letter Queue.
- enable
Dlq boolean - Enables Dead Letter Queue. When enabled, if the message doesn't conform to the schema (from Schema Registry) or there's an error in the
message_by_lua_functions, it will be forwarded todlq_topicthat can be processed later. - message
By string[]Lua Functions - The Lua functions that manipulates the message being sent to the client.
- message
Deserializer string - The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
- mode string
- The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
- schema
Registry GatewayPlugin Kafka Consume Config Schema Registry - The plugin-global schema registry configuration.
- security
Gateway
Plugin Kafka Consume Config Security
- bootstrap_
servers Sequence[GatewayPlugin Kafka Consume Config Bootstrap Server] - Set of bootstrap brokers in a
{host: host, port: port}list format. - topics
Sequence[Gateway
Plugin Kafka Consume Config Topic] - The Kafka topics and their configuration you want to consume from.
- authentication
Gateway
Plugin Kafka Consume Config Authentication - auto_
offset_ strreset - The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
- cluster_
name str - An identifier for the Kafka cluster.
- commit_
strategy str - The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
- dlq_
topic str - The topic to use for the Dead Letter Queue.
- enable_
dlq bool - Enables Dead Letter Queue. When enabled, if the message doesn't conform to the schema (from Schema Registry) or there's an error in the
message_by_lua_functions, it will be forwarded todlq_topicthat can be processed later. - message_
by_ Sequence[str]lua_ functions - The Lua functions that manipulates the message being sent to the client.
- message_
deserializer str - The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
- mode str
- The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
- schema_
registry GatewayPlugin Kafka Consume Config Schema Registry - The plugin-global schema registry configuration.
- security
Gateway
Plugin Kafka Consume Config Security
- bootstrap
Servers List<Property Map> - Set of bootstrap brokers in a
{host: host, port: port}list format. - topics List<Property Map>
- The Kafka topics and their configuration you want to consume from.
- authentication Property Map
- auto
Offset StringReset - The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
- cluster
Name String - An identifier for the Kafka cluster.
- commit
Strategy String - The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
- dlq
Topic String - The topic to use for the Dead Letter Queue.
- enable
Dlq Boolean - Enables Dead Letter Queue. When enabled, if the message doesn't conform to the schema (from Schema Registry) or there's an error in the
message_by_lua_functions, it will be forwarded todlq_topicthat can be processed later. - message
By List<String>Lua Functions - The Lua functions that manipulates the message being sent to the client.
- message
Deserializer String - The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
- mode String
- The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
- schema
Registry Property Map - The plugin-global schema registry configuration.
- security Property Map
GatewayPluginKafkaConsumeConfigAuthentication, GatewayPluginKafkaConsumeConfigAuthenticationArgs
- Mechanism string
- The SASL authentication mechanism. Supported options:
PLAINorSCRAM-SHA-256. must be one of ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512"] - Password string
- Password for SASL authentication.
- Strategy string
- The authentication strategy for the plugin, the only option for the value is
sasl. must be "sasl" - Tokenauth bool
- Enable this to indicate
DelegationTokenauthentication - User string
- Username for SASL authentication.
- Mechanism string
- The SASL authentication mechanism. Supported options:
PLAINorSCRAM-SHA-256. must be one of ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512"] - Password string
- Password for SASL authentication.
- Strategy string
- The authentication strategy for the plugin, the only option for the value is
sasl. must be "sasl" - Tokenauth bool
- Enable this to indicate
DelegationTokenauthentication - User string
- Username for SASL authentication.
- mechanism String
- The SASL authentication mechanism. Supported options:
PLAINorSCRAM-SHA-256. must be one of ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512"] - password String
- Password for SASL authentication.
- strategy String
- The authentication strategy for the plugin, the only option for the value is
sasl. must be "sasl" - tokenauth Boolean
- Enable this to indicate
DelegationTokenauthentication - user String
- Username for SASL authentication.
- mechanism string
- The SASL authentication mechanism. Supported options:
PLAINorSCRAM-SHA-256. must be one of ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512"] - password string
- Password for SASL authentication.
- strategy string
- The authentication strategy for the plugin, the only option for the value is
sasl. must be "sasl" - tokenauth boolean
- Enable this to indicate
DelegationTokenauthentication - user string
- Username for SASL authentication.
- mechanism str
- The SASL authentication mechanism. Supported options:
PLAINorSCRAM-SHA-256. must be one of ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512"] - password str
- Password for SASL authentication.
- strategy str
- The authentication strategy for the plugin, the only option for the value is
sasl. must be "sasl" - tokenauth bool
- Enable this to indicate
DelegationTokenauthentication - user str
- Username for SASL authentication.
- mechanism String
- The SASL authentication mechanism. Supported options:
PLAINorSCRAM-SHA-256. must be one of ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512"] - password String
- Password for SASL authentication.
- strategy String
- The authentication strategy for the plugin, the only option for the value is
sasl. must be "sasl" - tokenauth Boolean
- Enable this to indicate
DelegationTokenauthentication - user String
- Username for SASL authentication.
GatewayPluginKafkaConsumeConfigBootstrapServer, GatewayPluginKafkaConsumeConfigBootstrapServerArgs
GatewayPluginKafkaConsumeConfigSchemaRegistry, GatewayPluginKafkaConsumeConfigSchemaRegistryArgs
GatewayPluginKafkaConsumeConfigSchemaRegistryConfluent, GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentArgs
- Authentication
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication - Ssl
Verify bool - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- Ttl double
- The TTL in seconds for the schema registry cache.
- Url string
- The URL of the schema registry.
- Authentication
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication - Ssl
Verify bool - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- Ttl float64
- The TTL in seconds for the schema registry cache.
- Url string
- The URL of the schema registry.
- authentication
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication - ssl
Verify Boolean - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- ttl Double
- The TTL in seconds for the schema registry cache.
- url String
- The URL of the schema registry.
- authentication
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication - ssl
Verify boolean - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- ttl number
- The TTL in seconds for the schema registry cache.
- url string
- The URL of the schema registry.
- authentication
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication - ssl_
verify bool - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- ttl float
- The TTL in seconds for the schema registry cache.
- url str
- The URL of the schema registry.
- authentication Property Map
- ssl
Verify Boolean - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- ttl Number
- The TTL in seconds for the schema registry cache.
- url String
- The URL of the schema registry.
GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthentication, GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationArgs
- Basic
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Basic - Mode string
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- Oauth2
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2 - Oauth2Client
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2Client
- Basic
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Basic - Mode string
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- Oauth2
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2 - Oauth2Client
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2Client
- basic
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Basic - mode String
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- oauth2
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2 - oauth2Client
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2Client
- basic
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Basic - mode string
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- oauth2
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2 - oauth2Client
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2Client
- basic
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Basic - mode str
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- oauth2
Gateway
Plugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2 - oauth2_
client GatewayPlugin Kafka Consume Config Schema Registry Confluent Authentication Oauth2Client
- basic Property Map
- mode String
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- oauth2 Property Map
- oauth2Client Property Map
GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasic, GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasicArgs
GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2, GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2Args
- Audiences List<string>
- List of audiences passed to the IdP when obtaining a new token. Default: []
- Client
Id string - The client ID for the application registration in the IdP.
- Client
Secret string - The client secret for the application registration in the IdP.
- Grant
Type string - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- Password string
- The password to use if
config.oauth.grant_typeis set topassword. - Scopes List<string>
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- Token
Endpoint string - The token endpoint URI. Not Null
- Token
Headers Dictionary<string, string> - Extra headers to be passed in the token endpoint request.
- Token
Post Dictionary<string, string>Args - Extra post arguments to be passed in the token endpoint request.
- Username string
- The username to use if
config.oauth.grant_typeis set topassword.
- Audiences []string
- List of audiences passed to the IdP when obtaining a new token. Default: []
- Client
Id string - The client ID for the application registration in the IdP.
- Client
Secret string - The client secret for the application registration in the IdP.
- Grant
Type string - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- Password string
- The password to use if
config.oauth.grant_typeis set topassword. - Scopes []string
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- Token
Endpoint string - The token endpoint URI. Not Null
- Token
Headers map[string]string - Extra headers to be passed in the token endpoint request.
- Token
Post map[string]stringArgs - Extra post arguments to be passed in the token endpoint request.
- Username string
- The username to use if
config.oauth.grant_typeis set topassword.
- audiences List<String>
- List of audiences passed to the IdP when obtaining a new token. Default: []
- client
Id String - The client ID for the application registration in the IdP.
- client
Secret String - The client secret for the application registration in the IdP.
- grant
Type String - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- password String
- The password to use if
config.oauth.grant_typeis set topassword. - scopes List<String>
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- token
Endpoint String - The token endpoint URI. Not Null
- token
Headers Map<String,String> - Extra headers to be passed in the token endpoint request.
- token
Post Map<String,String>Args - Extra post arguments to be passed in the token endpoint request.
- username String
- The username to use if
config.oauth.grant_typeis set topassword.
- audiences string[]
- List of audiences passed to the IdP when obtaining a new token. Default: []
- client
Id string - The client ID for the application registration in the IdP.
- client
Secret string - The client secret for the application registration in the IdP.
- grant
Type string - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- password string
- The password to use if
config.oauth.grant_typeis set topassword. - scopes string[]
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- token
Endpoint string - The token endpoint URI. Not Null
- token
Headers {[key: string]: string} - Extra headers to be passed in the token endpoint request.
- token
Post {[key: string]: string}Args - Extra post arguments to be passed in the token endpoint request.
- username string
- The username to use if
config.oauth.grant_typeis set topassword.
- audiences Sequence[str]
- List of audiences passed to the IdP when obtaining a new token. Default: []
- client_
id str - The client ID for the application registration in the IdP.
- client_
secret str - The client secret for the application registration in the IdP.
- grant_
type str - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- password str
- The password to use if
config.oauth.grant_typeis set topassword. - scopes Sequence[str]
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- token_
endpoint str - The token endpoint URI. Not Null
- token_
headers Mapping[str, str] - Extra headers to be passed in the token endpoint request.
- token_
post_ Mapping[str, str]args - Extra post arguments to be passed in the token endpoint request.
- username str
- The username to use if
config.oauth.grant_typeis set topassword.
- audiences List<String>
- List of audiences passed to the IdP when obtaining a new token. Default: []
- client
Id String - The client ID for the application registration in the IdP.
- client
Secret String - The client secret for the application registration in the IdP.
- grant
Type String - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- password String
- The password to use if
config.oauth.grant_typeis set topassword. - scopes List<String>
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- token
Endpoint String - The token endpoint URI. Not Null
- token
Headers Map<String> - Extra headers to be passed in the token endpoint request.
- token
Post Map<String>Args - Extra post arguments to be passed in the token endpoint request.
- username String
- The username to use if
config.oauth.grant_typeis set topassword.
GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2Client, GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationOauth2ClientArgs
- Auth
Method string - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - Client
Secret stringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - Http
Proxy string - The proxy to use when making HTTP requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - Http
Version double - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - Https
Proxy string - The proxy to use when making HTTPS requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - Keep
Alive bool - Whether to use keepalive connections to the IdP. Default: true
- No
Proxy string - A comma-separated list of hosts that should not be proxied.
- Ssl
Verify bool - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- Timeout double
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- Auth
Method string - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - Client
Secret stringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - Http
Proxy string - The proxy to use when making HTTP requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - Http
Version float64 - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - Https
Proxy string - The proxy to use when making HTTPS requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - Keep
Alive bool - Whether to use keepalive connections to the IdP. Default: true
- No
Proxy string - A comma-separated list of hosts that should not be proxied.
- Ssl
Verify bool - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- Timeout float64
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- auth
Method String - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - client
Secret StringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - http
Proxy String - The proxy to use when making HTTP requests to the IdP.
- String
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - http
Version Double - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - https
Proxy String - The proxy to use when making HTTPS requests to the IdP.
- String
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - keep
Alive Boolean - Whether to use keepalive connections to the IdP. Default: true
- no
Proxy String - A comma-separated list of hosts that should not be proxied.
- ssl
Verify Boolean - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- timeout Double
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- auth
Method string - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - client
Secret stringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - http
Proxy string - The proxy to use when making HTTP requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - http
Version number - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - https
Proxy string - The proxy to use when making HTTPS requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - keep
Alive boolean - Whether to use keepalive connections to the IdP. Default: true
- no
Proxy string - A comma-separated list of hosts that should not be proxied.
- ssl
Verify boolean - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- timeout number
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- auth_
method str - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - client_
secret_ strjwt_ alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - http_
proxy str - The proxy to use when making HTTP requests to the IdP.
- str
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - http_
version float - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - https_
proxy str - The proxy to use when making HTTPS requests to the IdP.
- str
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - keep_
alive bool - Whether to use keepalive connections to the IdP. Default: true
- no_
proxy str - A comma-separated list of hosts that should not be proxied.
- ssl_
verify bool - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- timeout float
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- auth
Method String - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - client
Secret StringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - http
Proxy String - The proxy to use when making HTTP requests to the IdP.
- String
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - http
Version Number - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - https
Proxy String - The proxy to use when making HTTPS requests to the IdP.
- String
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - keep
Alive Boolean - Whether to use keepalive connections to the IdP. Default: true
- no
Proxy String - A comma-separated list of hosts that should not be proxied.
- ssl
Verify Boolean - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- timeout Number
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
GatewayPluginKafkaConsumeConfigSecurity, GatewayPluginKafkaConsumeConfigSecurityArgs
- Certificate
Id string - UUID of certificate entity for mTLS authentication.
- Ssl bool
- Enables TLS.
- Certificate
Id string - UUID of certificate entity for mTLS authentication.
- Ssl bool
- Enables TLS.
- certificate
Id String - UUID of certificate entity for mTLS authentication.
- ssl Boolean
- Enables TLS.
- certificate
Id string - UUID of certificate entity for mTLS authentication.
- ssl boolean
- Enables TLS.
- certificate_
id str - UUID of certificate entity for mTLS authentication.
- ssl bool
- Enables TLS.
- certificate
Id String - UUID of certificate entity for mTLS authentication.
- ssl Boolean
- Enables TLS.
GatewayPluginKafkaConsumeConfigTopic, GatewayPluginKafkaConsumeConfigTopicArgs
- Name string
- Not Null
- Schema
Registry GatewayPlugin Kafka Consume Config Topic Schema Registry - The plugin-global schema registry configuration.
- Name string
- Not Null
- Schema
Registry GatewayPlugin Kafka Consume Config Topic Schema Registry - The plugin-global schema registry configuration.
- name String
- Not Null
- schema
Registry GatewayPlugin Kafka Consume Config Topic Schema Registry - The plugin-global schema registry configuration.
- name string
- Not Null
- schema
Registry GatewayPlugin Kafka Consume Config Topic Schema Registry - The plugin-global schema registry configuration.
- name str
- Not Null
- schema_
registry GatewayPlugin Kafka Consume Config Topic Schema Registry - The plugin-global schema registry configuration.
- name String
- Not Null
- schema
Registry Property Map - The plugin-global schema registry configuration.
GatewayPluginKafkaConsumeConfigTopicSchemaRegistry, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs
GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluent, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs
- Authentication
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication - Ssl
Verify bool - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- Ttl double
- The TTL in seconds for the schema registry cache.
- Url string
- The URL of the schema registry.
- Authentication
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication - Ssl
Verify bool - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- Ttl float64
- The TTL in seconds for the schema registry cache.
- Url string
- The URL of the schema registry.
- authentication
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication - ssl
Verify Boolean - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- ttl Double
- The TTL in seconds for the schema registry cache.
- url String
- The URL of the schema registry.
- authentication
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication - ssl
Verify boolean - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- ttl number
- The TTL in seconds for the schema registry cache.
- url string
- The URL of the schema registry.
- authentication
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication - ssl_
verify bool - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- ttl float
- The TTL in seconds for the schema registry cache.
- url str
- The URL of the schema registry.
- authentication Property Map
- ssl
Verify Boolean - Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
- ttl Number
- The TTL in seconds for the schema registry cache.
- url String
- The URL of the schema registry.
GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthentication, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs
- Basic
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Basic - Mode string
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- Oauth2
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2 - Oauth2Client
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2Client
- Basic
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Basic - Mode string
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- Oauth2
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2 - Oauth2Client
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2Client
- basic
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Basic - mode String
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- oauth2
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2 - oauth2Client
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2Client
- basic
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Basic - mode string
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- oauth2
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2 - oauth2Client
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2Client
- basic
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Basic - mode str
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- oauth2
Gateway
Plugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2 - oauth2_
client GatewayPlugin Kafka Consume Config Topic Schema Registry Confluent Authentication Oauth2Client
- basic Property Map
- mode String
- Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none", "oauth2"]
- oauth2 Property Map
- oauth2Client Property Map
GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasic, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs
GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2Args
- Audiences List<string>
- List of audiences passed to the IdP when obtaining a new token. Default: []
- Client
Id string - The client ID for the application registration in the IdP.
- Client
Secret string - The client secret for the application registration in the IdP.
- Grant
Type string - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- Password string
- The password to use if
config.oauth.grant_typeis set topassword. - Scopes List<string>
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- Token
Endpoint string - The token endpoint URI. Not Null
- Token
Headers Dictionary<string, string> - Extra headers to be passed in the token endpoint request.
- Token
Post Dictionary<string, string>Args - Extra post arguments to be passed in the token endpoint request.
- Username string
- The username to use if
config.oauth.grant_typeis set topassword.
- Audiences []string
- List of audiences passed to the IdP when obtaining a new token. Default: []
- Client
Id string - The client ID for the application registration in the IdP.
- Client
Secret string - The client secret for the application registration in the IdP.
- Grant
Type string - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- Password string
- The password to use if
config.oauth.grant_typeis set topassword. - Scopes []string
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- Token
Endpoint string - The token endpoint URI. Not Null
- Token
Headers map[string]string - Extra headers to be passed in the token endpoint request.
- Token
Post map[string]stringArgs - Extra post arguments to be passed in the token endpoint request.
- Username string
- The username to use if
config.oauth.grant_typeis set topassword.
- audiences List<String>
- List of audiences passed to the IdP when obtaining a new token. Default: []
- client
Id String - The client ID for the application registration in the IdP.
- client
Secret String - The client secret for the application registration in the IdP.
- grant
Type String - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- password String
- The password to use if
config.oauth.grant_typeis set topassword. - scopes List<String>
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- token
Endpoint String - The token endpoint URI. Not Null
- token
Headers Map<String,String> - Extra headers to be passed in the token endpoint request.
- token
Post Map<String,String>Args - Extra post arguments to be passed in the token endpoint request.
- username String
- The username to use if
config.oauth.grant_typeis set topassword.
- audiences string[]
- List of audiences passed to the IdP when obtaining a new token. Default: []
- client
Id string - The client ID for the application registration in the IdP.
- client
Secret string - The client secret for the application registration in the IdP.
- grant
Type string - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- password string
- The password to use if
config.oauth.grant_typeis set topassword. - scopes string[]
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- token
Endpoint string - The token endpoint URI. Not Null
- token
Headers {[key: string]: string} - Extra headers to be passed in the token endpoint request.
- token
Post {[key: string]: string}Args - Extra post arguments to be passed in the token endpoint request.
- username string
- The username to use if
config.oauth.grant_typeis set topassword.
- audiences Sequence[str]
- List of audiences passed to the IdP when obtaining a new token. Default: []
- client_
id str - The client ID for the application registration in the IdP.
- client_
secret str - The client secret for the application registration in the IdP.
- grant_
type str - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- password str
- The password to use if
config.oauth.grant_typeis set topassword. - scopes Sequence[str]
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- token_
endpoint str - The token endpoint URI. Not Null
- token_
headers Mapping[str, str] - Extra headers to be passed in the token endpoint request.
- token_
post_ Mapping[str, str]args - Extra post arguments to be passed in the token endpoint request.
- username str
- The username to use if
config.oauth.grant_typeis set topassword.
- audiences List<String>
- List of audiences passed to the IdP when obtaining a new token. Default: []
- client
Id String - The client ID for the application registration in the IdP.
- client
Secret String - The client secret for the application registration in the IdP.
- grant
Type String - The OAuth grant type to be used. Default: "clientcredentials"; must be one of ["clientcredentials", "password"]
- password String
- The password to use if
config.oauth.grant_typeis set topassword. - scopes List<String>
- List of scopes to request from the IdP when obtaining a new token. Default: ["openid"]
- token
Endpoint String - The token endpoint URI. Not Null
- token
Headers Map<String> - Extra headers to be passed in the token endpoint request.
- token
Post Map<String>Args - Extra post arguments to be passed in the token endpoint request.
- username String
- The username to use if
config.oauth.grant_typeis set topassword.
GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2Client, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationOauth2ClientArgs
- Auth
Method string - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - Client
Secret stringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - Http
Proxy string - The proxy to use when making HTTP requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - Http
Version double - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - Https
Proxy string - The proxy to use when making HTTPS requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - Keep
Alive bool - Whether to use keepalive connections to the IdP. Default: true
- No
Proxy string - A comma-separated list of hosts that should not be proxied.
- Ssl
Verify bool - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- Timeout double
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- Auth
Method string - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - Client
Secret stringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - Http
Proxy string - The proxy to use when making HTTP requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - Http
Version float64 - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - Https
Proxy string - The proxy to use when making HTTPS requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - Keep
Alive bool - Whether to use keepalive connections to the IdP. Default: true
- No
Proxy string - A comma-separated list of hosts that should not be proxied.
- Ssl
Verify bool - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- Timeout float64
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- auth
Method String - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - client
Secret StringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - http
Proxy String - The proxy to use when making HTTP requests to the IdP.
- String
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - http
Version Double - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - https
Proxy String - The proxy to use when making HTTPS requests to the IdP.
- String
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - keep
Alive Boolean - Whether to use keepalive connections to the IdP. Default: true
- no
Proxy String - A comma-separated list of hosts that should not be proxied.
- ssl
Verify Boolean - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- timeout Double
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- auth
Method string - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - client
Secret stringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - http
Proxy string - The proxy to use when making HTTP requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - http
Version number - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - https
Proxy string - The proxy to use when making HTTPS requests to the IdP.
- string
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - keep
Alive boolean - Whether to use keepalive connections to the IdP. Default: true
- no
Proxy string - A comma-separated list of hosts that should not be proxied.
- ssl
Verify boolean - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- timeout number
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- auth_
method str - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - client_
secret_ strjwt_ alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - http_
proxy str - The proxy to use when making HTTP requests to the IdP.
- str
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - http_
version float - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - https_
proxy str - The proxy to use when making HTTPS requests to the IdP.
- str
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - keep_
alive bool - Whether to use keepalive connections to the IdP. Default: true
- no_
proxy str - A comma-separated list of hosts that should not be proxied.
- ssl_
verify bool - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- timeout float
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
- auth
Method String - The authentication method used in client requests to the IdP. Supported values are:
client_secret_basicto sendclient_idandclient_secretin theAuthorization: Basicheader,client_secret_postto sendclient_idandclient_secretas part of the request body, orclient_secret_jwtto send a JWT signed with theclient_secretusing the client assertion as part of the body. Default: "clientsecretpost"; must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"] - client
Secret StringJwt Alg - The algorithm to use with JWT when using
client_secret_jwtauthentication. Default: "HS512"; must be one of ["HS256", "HS512"] - http
Proxy String - The proxy to use when making HTTP requests to the IdP.
- String
- The
Proxy-Authorizationheader value to be used withhttp_proxy. - http
Version Number - The HTTP version used for requests made by this plugin. Supported values:
1.1for HTTP 1.1 and1.0for HTTP 1.0. - https
Proxy String - The proxy to use when making HTTPS requests to the IdP.
- String
- The
Proxy-Authorizationheader value to be used withhttps_proxy. - keep
Alive Boolean - Whether to use keepalive connections to the IdP. Default: true
- no
Proxy String - A comma-separated list of hosts that should not be proxied.
- ssl
Verify Boolean - Whether to verify the certificate presented by the IdP when using HTTPS. Default: false
- timeout Number
- Network I/O timeout for requests to the IdP in milliseconds. Default: 10000
GatewayPluginKafkaConsumeConsumer, GatewayPluginKafkaConsumeConsumerArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginKafkaConsumeOrdering, GatewayPluginKafkaConsumeOrderingArgs
GatewayPluginKafkaConsumeOrderingAfter, GatewayPluginKafkaConsumeOrderingAfterArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginKafkaConsumeOrderingBefore, GatewayPluginKafkaConsumeOrderingBeforeArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginKafkaConsumePartial, GatewayPluginKafkaConsumePartialArgs
GatewayPluginKafkaConsumeRoute, GatewayPluginKafkaConsumeRouteArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
Import
In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:
terraform
import {
to = konnect_gateway_plugin_kafka_consume.my_konnect_gateway_plugin_kafka_consume
id = jsonencode({
control_plane_id = "9524ec7d-36d9-465d-a8c5-83a3c9390458"
id = "3473c251-5b6c-4f45-b1ff-7ede735a366d"
})
}
The pulumi import command can be used, for example:
$ pulumi import konnect:index/gatewayPluginKafkaConsume:GatewayPluginKafkaConsume my_konnect_gateway_plugin_kafka_consume '{"control_plane_id": "9524ec7d-36d9-465d-a8c5-83a3c9390458", "id": "3473c251-5b6c-4f45-b1ff-7ede735a366d"}'
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnectTerraform Provider.
