konnect.GatewayPluginKafkaConsume
Explore with Pulumi AI
GatewayPluginKafkaConsume Resource
Example Usage
Coming soon!
Coming soon!
Coming soon!
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.GatewayPluginKafkaConsumeRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeServiceArgs;
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")
.message_deserializer("noop")
.mode("server-sent-events")
.security(GatewayPluginKafkaConsumeConfigSecurityArgs.builder()
.certificateId("...my_certificate_id...")
.ssl(true)
.build())
.topics(GatewayPluginKafkaConsumeConfigTopicArgs.builder()
.name("...my_name...")
.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())
.protocols("wss")
.route(GatewayPluginKafkaConsumeRouteArgs.builder()
.id("...my_id...")
.build())
.service(GatewayPluginKafkaConsumeServiceArgs.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
message_deserializer: noop
mode: server-sent-events
security:
certificateId: '...my_certificate_id...'
ssl: true
topics:
- name: '...my_name...'
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:
- '...'
protocols:
- wss
route:
id: '...my_id...'
service:
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,
instance_name: Optional[str] = None,
consumer: Optional[GatewayPluginKafkaConsumeConsumerArgs] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
gateway_plugin_kafka_consume_id: Optional[str] = None,
config: Optional[GatewayPluginKafkaConsumeConfigArgs] = None,
ordering: Optional[GatewayPluginKafkaConsumeOrderingArgs] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginKafkaConsumeRouteArgs] = None,
service: Optional[GatewayPluginKafkaConsumeServiceArgs] = 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",
InstanceName = "string",
Consumer = new Konnect.Inputs.GatewayPluginKafkaConsumeConsumerArgs
{
Id = "string",
},
CreatedAt = 0,
Enabled = false,
GatewayPluginKafkaConsumeId = "string",
Config = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigArgs
{
Authentication = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigAuthenticationArgs
{
Mechanism = "string",
Password = "string",
Strategy = "string",
Tokenauth = false,
User = "string",
},
AutoOffsetReset = "string",
BootstrapServers = new[]
{
new Konnect.Inputs.GatewayPluginKafkaConsumeConfigBootstrapServerArgs
{
Host = "string",
Port = 0,
},
},
ClusterName = "string",
CommitStrategy = "string",
MessageDeserializer = "string",
Mode = "string",
Security = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSecurityArgs
{
CertificateId = "string",
Ssl = false,
},
Topics = new[]
{
new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicArgs
{
Name = "string",
},
},
},
Ordering = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingArgs
{
After = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingAfterArgs
{
Accesses = new[]
{
"string",
},
},
Before = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingBeforeArgs
{
Accesses = new[]
{
"string",
},
},
},
Protocols = new[]
{
"string",
},
Route = new Konnect.Inputs.GatewayPluginKafkaConsumeRouteArgs
{
Id = "string",
},
Service = new Konnect.Inputs.GatewayPluginKafkaConsumeServiceArgs
{
Id = "string",
},
Tags = new[]
{
"string",
},
UpdatedAt = 0,
});
example, err := konnect.NewGatewayPluginKafkaConsume(ctx, "gatewayPluginKafkaConsumeResource", &konnect.GatewayPluginKafkaConsumeArgs{
ControlPlaneId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Consumer: &konnect.GatewayPluginKafkaConsumeConsumerArgs{
Id: pulumi.String("string"),
},
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
GatewayPluginKafkaConsumeId: pulumi.String("string"),
Config: &konnect.GatewayPluginKafkaConsumeConfigArgs{
Authentication: &konnect.GatewayPluginKafkaConsumeConfigAuthenticationArgs{
Mechanism: pulumi.String("string"),
Password: pulumi.String("string"),
Strategy: pulumi.String("string"),
Tokenauth: pulumi.Bool(false),
User: pulumi.String("string"),
},
AutoOffsetReset: pulumi.String("string"),
BootstrapServers: konnect.GatewayPluginKafkaConsumeConfigBootstrapServerArray{
&konnect.GatewayPluginKafkaConsumeConfigBootstrapServerArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ClusterName: pulumi.String("string"),
CommitStrategy: pulumi.String("string"),
MessageDeserializer: pulumi.String("string"),
Mode: pulumi.String("string"),
Security: &konnect.GatewayPluginKafkaConsumeConfigSecurityArgs{
CertificateId: pulumi.String("string"),
Ssl: pulumi.Bool(false),
},
Topics: konnect.GatewayPluginKafkaConsumeConfigTopicArray{
&konnect.GatewayPluginKafkaConsumeConfigTopicArgs{
Name: pulumi.String("string"),
},
},
},
Ordering: &konnect.GatewayPluginKafkaConsumeOrderingArgs{
After: &konnect.GatewayPluginKafkaConsumeOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &konnect.GatewayPluginKafkaConsumeOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &konnect.GatewayPluginKafkaConsumeRouteArgs{
Id: pulumi.String("string"),
},
Service: &konnect.GatewayPluginKafkaConsumeServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})
var gatewayPluginKafkaConsumeResource = new GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource", GatewayPluginKafkaConsumeArgs.builder()
.controlPlaneId("string")
.instanceName("string")
.consumer(GatewayPluginKafkaConsumeConsumerArgs.builder()
.id("string")
.build())
.createdAt(0.0)
.enabled(false)
.gatewayPluginKafkaConsumeId("string")
.config(GatewayPluginKafkaConsumeConfigArgs.builder()
.authentication(GatewayPluginKafkaConsumeConfigAuthenticationArgs.builder()
.mechanism("string")
.password("string")
.strategy("string")
.tokenauth(false)
.user("string")
.build())
.autoOffsetReset("string")
.bootstrapServers(GatewayPluginKafkaConsumeConfigBootstrapServerArgs.builder()
.host("string")
.port(0.0)
.build())
.clusterName("string")
.commitStrategy("string")
.messageDeserializer("string")
.mode("string")
.security(GatewayPluginKafkaConsumeConfigSecurityArgs.builder()
.certificateId("string")
.ssl(false)
.build())
.topics(GatewayPluginKafkaConsumeConfigTopicArgs.builder()
.name("string")
.build())
.build())
.ordering(GatewayPluginKafkaConsumeOrderingArgs.builder()
.after(GatewayPluginKafkaConsumeOrderingAfterArgs.builder()
.accesses("string")
.build())
.before(GatewayPluginKafkaConsumeOrderingBeforeArgs.builder()
.accesses("string")
.build())
.build())
.protocols("string")
.route(GatewayPluginKafkaConsumeRouteArgs.builder()
.id("string")
.build())
.service(GatewayPluginKafkaConsumeServiceArgs.builder()
.id("string")
.build())
.tags("string")
.updatedAt(0.0)
.build());
gateway_plugin_kafka_consume_resource = konnect.GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource",
control_plane_id="string",
instance_name="string",
consumer={
"id": "string",
},
created_at=0,
enabled=False,
gateway_plugin_kafka_consume_id="string",
config={
"authentication": {
"mechanism": "string",
"password": "string",
"strategy": "string",
"tokenauth": False,
"user": "string",
},
"auto_offset_reset": "string",
"bootstrap_servers": [{
"host": "string",
"port": 0,
}],
"cluster_name": "string",
"commit_strategy": "string",
"message_deserializer": "string",
"mode": "string",
"security": {
"certificate_id": "string",
"ssl": False,
},
"topics": [{
"name": "string",
}],
},
ordering={
"after": {
"accesses": ["string"],
},
"before": {
"accesses": ["string"],
},
},
protocols=["string"],
route={
"id": "string",
},
service={
"id": "string",
},
tags=["string"],
updated_at=0)
const gatewayPluginKafkaConsumeResource = new konnect.GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource", {
controlPlaneId: "string",
instanceName: "string",
consumer: {
id: "string",
},
createdAt: 0,
enabled: false,
gatewayPluginKafkaConsumeId: "string",
config: {
authentication: {
mechanism: "string",
password: "string",
strategy: "string",
tokenauth: false,
user: "string",
},
autoOffsetReset: "string",
bootstrapServers: [{
host: "string",
port: 0,
}],
clusterName: "string",
commitStrategy: "string",
messageDeserializer: "string",
mode: "string",
security: {
certificateId: "string",
ssl: false,
},
topics: [{
name: "string",
}],
},
ordering: {
after: {
accesses: ["string"],
},
before: {
accesses: ["string"],
},
},
protocols: ["string"],
route: {
id: "string",
},
service: {
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
messageDeserializer: string
mode: string
security:
certificateId: string
ssl: false
topics:
- name: string
consumer:
id: string
controlPlaneId: string
createdAt: 0
enabled: false
gatewayPluginKafkaConsumeId: string
instanceName: string
ordering:
after:
accesses:
- string
before:
accesses:
- string
protocols:
- string
route:
id: string
service:
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:
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- 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.
- Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringKafka Consume Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Kafka Consume Ordering - 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
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.
- Service
Gateway
Plugin Kafka Consume Service - 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.
- 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.
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- 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.
- Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringKafka Consume Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Kafka Consume Ordering Args - 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
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.
- Service
Gateway
Plugin Kafka Consume Service Args - 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.
- []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.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- 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.
- created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringKafka Consume Id - The ID of this resource.
- instance
Name String - ordering
Gateway
Plugin Kafka Consume Ordering - 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
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.
- service
Gateway
Plugin Kafka Consume Service - 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.
- 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.
- control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- 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.
- created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied.
- gateway
Plugin stringKafka Consume Id - The ID of this resource.
- instance
Name string - ordering
Gateway
Plugin Kafka Consume Ordering - 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
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.
- service
Gateway
Plugin Kafka Consume Service - 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.
- 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.
- control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- 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.
- created_
at float - Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied.
- gateway_
plugin_ strkafka_ consume_ id - The ID of this resource.
- instance_
name str - ordering
Gateway
Plugin Kafka Consume Ordering Args - 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
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.
- service
Gateway
Plugin Kafka Consume Service Args - 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.
- 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.
- control
Plane StringId - 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.
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringKafka Consume Id - The ID of this resource.
- instance
Name String - ordering 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.
- 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,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginKafkaConsumeRouteArgs] = None,
service: Optional[GatewayPluginKafkaConsumeServiceArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None) -> GatewayPluginKafkaConsume
func 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.
- Gateway
Plugin stringKafka Consume Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Kafka Consume Ordering - 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
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.
- Service
Gateway
Plugin Kafka Consume Service - 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.
- 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.
- Gateway
Plugin stringKafka Consume Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Kafka Consume Ordering Args - 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
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.
- Service
Gateway
Plugin Kafka Consume Service Args - 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.
- []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.
- gateway
Plugin StringKafka Consume Id - The ID of this resource.
- instance
Name String - ordering
Gateway
Plugin Kafka Consume Ordering - 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
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.
- service
Gateway
Plugin Kafka Consume Service - 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.
- 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.
- gateway
Plugin stringKafka Consume Id - The ID of this resource.
- instance
Name string - ordering
Gateway
Plugin Kafka Consume Ordering - 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
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.
- service
Gateway
Plugin Kafka Consume Service - 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.
- 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.
- gateway_
plugin_ strkafka_ consume_ id - The ID of this resource.
- instance_
name str - ordering
Gateway
Plugin Kafka Consume Ordering Args - 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
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.
- service
Gateway
Plugin Kafka Consume Service Args - 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.
- 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.
- gateway
Plugin StringKafka Consume Id - The ID of this resource.
- instance
Name String - ordering 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.
- 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
- 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. must be one of ["earliest", "latest"]
- Bootstrap
Servers List<GatewayPlugin Kafka Consume Config Bootstrap Server> - Set of bootstrap brokers in a
{host: host, port: port}
list format. - Cluster
Name string - An identifier for the Kafka cluster.
- Commit
Strategy string - The strategy to use for committing offsets. must be one of ["auto", "off"]
- Message
Deserializer string - The deserializer to use for the consumed messages. must be one of ["json", "noop"]
- Mode string
- The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
- Security
Gateway
Plugin Kafka Consume Config Security - 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. must be one of ["earliest", "latest"]
- Bootstrap
Servers []GatewayPlugin Kafka Consume Config Bootstrap Server - Set of bootstrap brokers in a
{host: host, port: port}
list format. - Cluster
Name string - An identifier for the Kafka cluster.
- Commit
Strategy string - The strategy to use for committing offsets. must be one of ["auto", "off"]
- Message
Deserializer string - The deserializer to use for the consumed messages. must be one of ["json", "noop"]
- Mode string
- The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
- Security
Gateway
Plugin Kafka Consume Config Security - 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. must be one of ["earliest", "latest"]
- bootstrap
Servers List<GatewayPlugin Kafka Consume Config Bootstrap Server> - Set of bootstrap brokers in a
{host: host, port: port}
list format. - cluster
Name String - An identifier for the Kafka cluster.
- commit
Strategy String - The strategy to use for committing offsets. must be one of ["auto", "off"]
- message
Deserializer String - The deserializer to use for the consumed messages. must be one of ["json", "noop"]
- mode String
- The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
- security
Gateway
Plugin Kafka Consume Config Security - 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. must be one of ["earliest", "latest"]
- bootstrap
Servers GatewayPlugin Kafka Consume Config Bootstrap Server[] - Set of bootstrap brokers in a
{host: host, port: port}
list format. - cluster
Name string - An identifier for the Kafka cluster.
- commit
Strategy string - The strategy to use for committing offsets. must be one of ["auto", "off"]
- message
Deserializer string - The deserializer to use for the consumed messages. must be one of ["json", "noop"]
- mode string
- The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
- security
Gateway
Plugin Kafka Consume Config Security - 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_ strreset - The offset to start from when there is no initial offset in the consumer group. must be one of ["earliest", "latest"]
- bootstrap_
servers Sequence[GatewayPlugin Kafka Consume Config Bootstrap Server] - Set of bootstrap brokers in a
{host: host, port: port}
list format. - cluster_
name str - An identifier for the Kafka cluster.
- commit_
strategy str - The strategy to use for committing offsets. must be one of ["auto", "off"]
- message_
deserializer str - The deserializer to use for the consumed messages. must be one of ["json", "noop"]
- mode str
- The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
- security
Gateway
Plugin Kafka Consume Config Security - topics
Sequence[Gateway
Plugin Kafka Consume Config Topic] - 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. must be one of ["earliest", "latest"]
- bootstrap
Servers List<Property Map> - Set of bootstrap brokers in a
{host: host, port: port}
list format. - cluster
Name String - An identifier for the Kafka cluster.
- commit
Strategy String - The strategy to use for committing offsets. must be one of ["auto", "off"]
- message
Deserializer String - The deserializer to use for the consumed messages. must be one of ["json", "noop"]
- mode String
- The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
- security Property Map
- topics List<Property Map>
- The Kafka topics and their configuration you want to consume from.
GatewayPluginKafkaConsumeConfigAuthentication, GatewayPluginKafkaConsumeConfigAuthenticationArgs
- Mechanism string
- The SASL authentication mechanism. Supported options:
PLAIN
orSCRAM-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
DelegationToken
authentication - User string
- Username for SASL authentication.
- Mechanism string
- The SASL authentication mechanism. Supported options:
PLAIN
orSCRAM-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
DelegationToken
authentication - User string
- Username for SASL authentication.
- mechanism String
- The SASL authentication mechanism. Supported options:
PLAIN
orSCRAM-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
DelegationToken
authentication - user String
- Username for SASL authentication.
- mechanism string
- The SASL authentication mechanism. Supported options:
PLAIN
orSCRAM-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
DelegationToken
authentication - user string
- Username for SASL authentication.
- mechanism str
- The SASL authentication mechanism. Supported options:
PLAIN
orSCRAM-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
DelegationToken
authentication - user str
- Username for SASL authentication.
- mechanism String
- The SASL authentication mechanism. Supported options:
PLAIN
orSCRAM-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
DelegationToken
authentication - user String
- Username for SASL authentication.
GatewayPluginKafkaConsumeConfigBootstrapServer, GatewayPluginKafkaConsumeConfigBootstrapServerArgs
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
- Name string
- Not Null
- name String
- Not Null
- name string
- Not Null
- name str
- Not Null
- name String
- Not Null
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>
GatewayPluginKafkaConsumeRoute, GatewayPluginKafkaConsumeRouteArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginKafkaConsumeService, GatewayPluginKafkaConsumeServiceArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
Import
$ 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
konnect
Terraform Provider.