konnect.GatewayPluginKafkaLog

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

name string

The unique name of the resource.

args GatewayPluginKafkaLogArgs

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 GatewayPluginKafkaLogArgs

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 GatewayPluginKafkaLogArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GatewayPluginKafkaLogArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GatewayPluginKafkaLogArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

ControlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Config GatewayPluginKafkaLogConfig

Consumer GatewayPluginKafkaLogConsumer

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.

CreatedAt double

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginKafkaLogId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginKafkaLogOrdering

Partials List<GatewayPluginKafkaLogPartial>

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.

Route GatewayPluginKafkaLogRoute

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.

Service GatewayPluginKafkaLogService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

Tags List<string>

An optional set of strings associated with the Plugin for grouping and filtering.

UpdatedAt double

Unix epoch when the resource was last updated.

ControlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Config GatewayPluginKafkaLogConfigArgs

Consumer GatewayPluginKafkaLogConsumerArgs

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.

CreatedAt float64

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginKafkaLogId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginKafkaLogOrderingArgs

Partials []GatewayPluginKafkaLogPartialArgs

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.

Route GatewayPluginKafkaLogRouteArgs

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.

Service GatewayPluginKafkaLogServiceArgs

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

Tags []string

An optional set of strings associated with the Plugin for grouping and filtering.

UpdatedAt float64

Unix epoch when the resource was last updated.

controlPlaneId String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

config GatewayPluginKafkaLogConfig

consumer GatewayPluginKafkaLogConsumer

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.

createdAt Double

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginKafkaLogId String

The ID of this resource.

instanceName String

ordering GatewayPluginKafkaLogOrdering

partials List<GatewayPluginKafkaLogPartial>

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.

route GatewayPluginKafkaLogRoute

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.

service GatewayPluginKafkaLogService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

updatedAt Double

Unix epoch when the resource was last updated.

controlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

config GatewayPluginKafkaLogConfig

consumer GatewayPluginKafkaLogConsumer

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.

createdAt number

Unix epoch when the resource was created.

enabled boolean

Whether the plugin is applied.

gatewayPluginKafkaLogId string

The ID of this resource.

instanceName string

ordering GatewayPluginKafkaLogOrdering

partials GatewayPluginKafkaLogPartial[]

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.

route GatewayPluginKafkaLogRoute

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.

service GatewayPluginKafkaLogService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags string[]

An optional set of strings associated with the Plugin for grouping and filtering.

updatedAt number

Unix epoch when the resource was last updated.

control_plane_id str

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

config GatewayPluginKafkaLogConfigArgs

consumer GatewayPluginKafkaLogConsumerArgs

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.

gateway_plugin_kafka_log_id str

The ID of this resource.

instance_name str

ordering GatewayPluginKafkaLogOrderingArgs

partials Sequence[GatewayPluginKafkaLogPartialArgs]

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.

route GatewayPluginKafkaLogRouteArgs

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.

service GatewayPluginKafkaLogServiceArgs

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags 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.

controlPlaneId String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

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.

createdAt Number

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginKafkaLogId String

The ID of this resource.

instanceName String

ordering Property Map

partials List<Property Map>

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.

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.

service Property Map

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

updatedAt Number

Unix epoch when the resource was last updated.

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.

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.

Authentication GatewayPluginKafkaLogConfigAuthentication

BootstrapServers List<GatewayPluginKafkaLogConfigBootstrapServer>

Set of bootstrap brokers in a {host: host, port: port} list format.

ClusterName string

An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

CustomFieldsByLua Dictionary<string, string>

Lua code as a key-value map

Keepalive double

KeepaliveEnabled bool

ProducerAsync bool

Flag to enable asynchronous mode.

ProducerAsyncBufferingLimitsMessagesInMemory double

Maximum number of messages that can be buffered in memory in asynchronous mode.

ProducerAsyncFlushTimeout double

Maximum time interval in milliseconds between buffer flushes in asynchronous mode.

ProducerRequestAcks double

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set). must be one of ["-1", "0", "1"]

ProducerRequestLimitsBytesPerRequest double

Maximum size of a Produce request in bytes.

ProducerRequestLimitsMessagesPerRequest double

Maximum number of messages to include into a single Produce request.

ProducerRequestRetriesBackoffTimeout double

Backoff interval between retry attempts in milliseconds.

ProducerRequestRetriesMaxAttempts double

Maximum number of retry attempts per single Produce request.

ProducerRequestTimeout double

Time to wait for a Produce response in milliseconds

Security GatewayPluginKafkaLogConfigSecurity

Timeout double

Socket timeout in milliseconds.

Topic string

The Kafka topic to publish to.

Authentication GatewayPluginKafkaLogConfigAuthentication

BootstrapServers []GatewayPluginKafkaLogConfigBootstrapServer

Set of bootstrap brokers in a {host: host, port: port} list format.

ClusterName string

An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

CustomFieldsByLua map[string]string

Lua code as a key-value map

Keepalive float64

KeepaliveEnabled bool

ProducerAsync bool

Flag to enable asynchronous mode.

ProducerAsyncBufferingLimitsMessagesInMemory float64

Maximum number of messages that can be buffered in memory in asynchronous mode.

ProducerAsyncFlushTimeout float64

Maximum time interval in milliseconds between buffer flushes in asynchronous mode.

ProducerRequestAcks float64

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set). must be one of ["-1", "0", "1"]

ProducerRequestLimitsBytesPerRequest float64

Maximum size of a Produce request in bytes.

ProducerRequestLimitsMessagesPerRequest float64

Maximum number of messages to include into a single Produce request.

ProducerRequestRetriesBackoffTimeout float64

Backoff interval between retry attempts in milliseconds.

ProducerRequestRetriesMaxAttempts float64

Maximum number of retry attempts per single Produce request.

ProducerRequestTimeout float64

Time to wait for a Produce response in milliseconds

Security GatewayPluginKafkaLogConfigSecurity

Timeout float64

Socket timeout in milliseconds.

Topic string

The Kafka topic to publish to.

authentication GatewayPluginKafkaLogConfigAuthentication

bootstrapServers List<GatewayPluginKafkaLogConfigBootstrapServer>

Set of bootstrap brokers in a {host: host, port: port} list format.

clusterName String

An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

customFieldsByLua Map<String,String>

Lua code as a key-value map

keepalive Double

keepaliveEnabled Boolean

producerAsync Boolean

Flag to enable asynchronous mode.

producerAsyncBufferingLimitsMessagesInMemory Double

Maximum number of messages that can be buffered in memory in asynchronous mode.

producerAsyncFlushTimeout Double

Maximum time interval in milliseconds between buffer flushes in asynchronous mode.

producerRequestAcks Double

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set). must be one of ["-1", "0", "1"]

producerRequestLimitsBytesPerRequest Double

Maximum size of a Produce request in bytes.

producerRequestLimitsMessagesPerRequest Double

Maximum number of messages to include into a single Produce request.

producerRequestRetriesBackoffTimeout Double

Backoff interval between retry attempts in milliseconds.

producerRequestRetriesMaxAttempts Double

Maximum number of retry attempts per single Produce request.

producerRequestTimeout Double

Time to wait for a Produce response in milliseconds

security GatewayPluginKafkaLogConfigSecurity

timeout Double

Socket timeout in milliseconds.

topic String

The Kafka topic to publish to.

authentication GatewayPluginKafkaLogConfigAuthentication

bootstrapServers GatewayPluginKafkaLogConfigBootstrapServer[]

Set of bootstrap brokers in a {host: host, port: port} list format.

clusterName string

An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

customFieldsByLua {[key: string]: string}

Lua code as a key-value map

keepalive number

keepaliveEnabled boolean

producerAsync boolean

Flag to enable asynchronous mode.

producerAsyncBufferingLimitsMessagesInMemory number

Maximum number of messages that can be buffered in memory in asynchronous mode.

producerAsyncFlushTimeout number

Maximum time interval in milliseconds between buffer flushes in asynchronous mode.

producerRequestAcks number

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set). must be one of ["-1", "0", "1"]

producerRequestLimitsBytesPerRequest number

Maximum size of a Produce request in bytes.

producerRequestLimitsMessagesPerRequest number

Maximum number of messages to include into a single Produce request.

producerRequestRetriesBackoffTimeout number

Backoff interval between retry attempts in milliseconds.

producerRequestRetriesMaxAttempts number

Maximum number of retry attempts per single Produce request.

producerRequestTimeout number

Time to wait for a Produce response in milliseconds

security GatewayPluginKafkaLogConfigSecurity

timeout number

Socket timeout in milliseconds.

topic string

The Kafka topic to publish to.

authentication GatewayPluginKafkaLogConfigAuthentication

bootstrap_servers Sequence[GatewayPluginKafkaLogConfigBootstrapServer]

Set of bootstrap brokers in a {host: host, port: port} list format.

cluster_name str

An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

custom_fields_by_lua Mapping[str, str]

Lua code as a key-value map

keepalive float

keepalive_enabled bool

producer_async bool

Flag to enable asynchronous mode.

producer_async_buffering_limits_messages_in_memory float

Maximum number of messages that can be buffered in memory in asynchronous mode.

producer_async_flush_timeout float

Maximum time interval in milliseconds between buffer flushes in asynchronous mode.

producer_request_acks float

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set). must be one of ["-1", "0", "1"]

producer_request_limits_bytes_per_request float

Maximum size of a Produce request in bytes.

producer_request_limits_messages_per_request float

Maximum number of messages to include into a single Produce request.

producer_request_retries_backoff_timeout float

Backoff interval between retry attempts in milliseconds.

producer_request_retries_max_attempts float

Maximum number of retry attempts per single Produce request.

producer_request_timeout float

Time to wait for a Produce response in milliseconds

security GatewayPluginKafkaLogConfigSecurity

timeout float

Socket timeout in milliseconds.

topic str

The Kafka topic to publish to.

authentication Property Map

bootstrapServers List<Property Map>

Set of bootstrap brokers in a {host: host, port: port} list format.

clusterName String

An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

customFieldsByLua Map<String>

Lua code as a key-value map

keepalive Number

keepaliveEnabled Boolean

producerAsync Boolean

Flag to enable asynchronous mode.

producerAsyncBufferingLimitsMessagesInMemory Number

Maximum number of messages that can be buffered in memory in asynchronous mode.

producerAsyncFlushTimeout Number

Maximum time interval in milliseconds between buffer flushes in asynchronous mode.

producerRequestAcks Number

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set). must be one of ["-1", "0", "1"]

producerRequestLimitsBytesPerRequest Number

Maximum size of a Produce request in bytes.

producerRequestLimitsMessagesPerRequest Number

Maximum number of messages to include into a single Produce request.

producerRequestRetriesBackoffTimeout Number

Backoff interval between retry attempts in milliseconds.

producerRequestRetriesMaxAttempts Number

Maximum number of retry attempts per single Produce request.

producerRequestTimeout Number

Time to wait for a Produce response in milliseconds

security Property Map

timeout Number

Socket timeout in milliseconds.

topic String

The Kafka topic to publish to.

Mechanism string

The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512. 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 DelegationToken authentication

User string

Username for SASL authentication.

Mechanism string

The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512. 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 DelegationToken authentication

User string

Username for SASL authentication.

mechanism String

The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512. 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 DelegationToken authentication

user String

Username for SASL authentication.

mechanism string

The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512. 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 DelegationToken authentication

user string

Username for SASL authentication.

mechanism str

The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512. 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 DelegationToken authentication

user str

Username for SASL authentication.

mechanism String

The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512. 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 DelegationToken authentication

user String

Username for SASL authentication.

Host string

A string representing a host name, such as example.com. Not Null

Port double

An integer representing a port number between 0 and 65535, inclusive. Not Null

Host string

A string representing a host name, such as example.com. Not Null

Port float64

An integer representing a port number between 0 and 65535, inclusive. Not Null

host String

A string representing a host name, such as example.com. Not Null

port Double

An integer representing a port number between 0 and 65535, inclusive. Not Null

host string

A string representing a host name, such as example.com. Not Null

port number

An integer representing a port number between 0 and 65535, inclusive. Not Null

host str

A string representing a host name, such as example.com. Not Null

port float

An integer representing a port number between 0 and 65535, inclusive. Not Null

host String

A string representing a host name, such as example.com. Not Null

port Number

An integer representing a port number between 0 and 65535, inclusive. Not Null

CertificateId string

UUID of certificate entity for mTLS authentication.

Ssl bool

Enables TLS.

CertificateId string

UUID of certificate entity for mTLS authentication.

Ssl bool

Enables TLS.

certificateId String

UUID of certificate entity for mTLS authentication.

ssl Boolean

Enables TLS.

certificateId 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.

certificateId String

UUID of certificate entity for mTLS authentication.

ssl Boolean

Enables TLS.