1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginSolaceConsume
konnect 3.4.1 published on Wednesday, Oct 29, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayPluginSolaceConsume

Get Started
konnect logo
konnect 3.4.1 published on Wednesday, Oct 29, 2025 by kong
kong/terraform-provider-konnect

    GatewayPluginSolaceConsume 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.GatewayPluginSolaceConsume;
import com.pulumi.konnect.GatewayPluginSolaceConsumeArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeConfigFlowArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeConfigPollingArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeConfigSessionArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeConfigSessionAuthenticationArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeConfigWebsocketArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumePartialArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginSolaceConsumeServiceArgs;
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 myGatewaypluginsolaceconsume = new GatewayPluginSolaceConsume("myGatewaypluginsolaceconsume", GatewayPluginSolaceConsumeArgs.builder()
            .config(GatewayPluginSolaceConsumeConfigArgs.builder()
                .flow(GatewayPluginSolaceConsumeConfigFlowArgs.builder()
                    .ackMode("CLIENT")
                    .binds(GatewayPluginSolaceConsumeConfigFlowBindArgs.builder()
                        .name("...my_name...")
                        .type("QUEUE")
                        .build())
                    .functions("...")
                    .maxUnackedMessages(5)
                    .properties(Map.of("key", serializeJson(
                        "value")))
                    .selector("...my_selector...")
                    .waitTimeout(2591)
                    .windowSize(141)
                    .build())
                .mode("WEBSOCKET")
                .polling(GatewayPluginSolaceConsumeConfigPollingArgs.builder()
                    .timeout(287082)
                    .build())
                .session(GatewayPluginSolaceConsumeConfigSessionArgs.builder()
                    .authentication(GatewayPluginSolaceConsumeConfigSessionAuthenticationArgs.builder()
                        .accessToken("...my_access_token...")
                        .accessTokenHeader("...my_access_token_header...")
                        .idToken("...my_id_token...")
                        .idTokenHeader("...my_id_token_header...")
                        .password("...my_password...")
                        .scheme("BASIC")
                        .username("...my_username...")
                        .build())
                    .calculateMessageExpiry(false)
                    .connectTimeout(27609)
                    .generateRcvTimestamps(true)
                    .generateSendTimestamps(true)
                    .generateSenderId(false)
                    .generateSequenceNumber(true)
                    .host("...my_host...")
                    .properties(Map.of("key", serializeJson(
                        "value")))
                    .sslValidateCertificate(true)
                    .vpnName("...my_vpn_name...")
                    .build())
                .websocket(GatewayPluginSolaceConsumeConfigWebsocketArgs.builder()
                    .maxRecvLen(5)
                    .maxSendLen(10)
                    .timeout(44172)
                    .build())
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(8)
            .enabled(false)
            .gatewayPluginSolaceConsumeId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginSolaceConsumeOrderingArgs.builder()
                .after(GatewayPluginSolaceConsumeOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginSolaceConsumeOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .partials(GatewayPluginSolaceConsumePartialArgs.builder()
                .id("...my_id...")
                .name("...my_name...")
                .path("...my_path...")
                .build())
            .protocols("grpc")
            .route(GatewayPluginSolaceConsumeRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginSolaceConsumeServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .updatedAt(4)
            .build());

    }
}

    resources:
  myGatewaypluginsolaceconsume:
    type: konnect:GatewayPluginSolaceConsume
    properties:
      config:
        flow:
          ackMode: CLIENT
          binds:
            - name: '...my_name...'
              type: QUEUE
          functions:
            - '...'
          maxUnackedMessages: 5
          properties:
            key:
              fn::toJSON: value
          selector: '...my_selector...'
          waitTimeout: 2591
          windowSize: 141
        mode: WEBSOCKET
        polling:
          timeout: 287082
        session:
          authentication:
            accessToken: '...my_access_token...'
            accessTokenHeader: '...my_access_token_header...'
            idToken: '...my_id_token...'
            idTokenHeader: '...my_id_token_header...'
            password: '...my_password...'
            scheme: BASIC
            username: '...my_username...'
          calculateMessageExpiry: false
          connectTimeout: 27609
          generateRcvTimestamps: true
          generateSendTimestamps: true
          generateSenderId: false
          generateSequenceNumber: true
          host: '...my_host...'
          properties:
            key:
              fn::toJSON: value
          sslValidateCertificate: true
          vpnName: '...my_vpn_name...'
        websocket:
          maxRecvLen: 5
          maxSendLen: 10
          timeout: 44172
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 8
      enabled: false
      gatewayPluginSolaceConsumeId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      partials:
        - id: '...my_id...'
          name: '...my_name...'
          path: '...my_path...'
      protocols:
        - grpc
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
      updatedAt: 4

    Create GatewayPluginSolaceConsume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GatewayPluginSolaceConsume(name: string, args: GatewayPluginSolaceConsumeArgs, opts?: CustomResourceOptions);
    @overload
def GatewayPluginSolaceConsume(resource_name: str,
                               args: GatewayPluginSolaceConsumeArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginSolaceConsume(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               config: Optional[GatewayPluginSolaceConsumeConfigArgs] = None,
                               control_plane_id: Optional[str] = None,
                               created_at: Optional[float] = None,
                               enabled: Optional[bool] = None,
                               gateway_plugin_solace_consume_id: Optional[str] = None,
                               instance_name: Optional[str] = None,
                               ordering: Optional[GatewayPluginSolaceConsumeOrderingArgs] = None,
                               partials: Optional[Sequence[GatewayPluginSolaceConsumePartialArgs]] = None,
                               protocols: Optional[Sequence[str]] = None,
                               route: Optional[GatewayPluginSolaceConsumeRouteArgs] = None,
                               service: Optional[GatewayPluginSolaceConsumeServiceArgs] = None,
                               tags: Optional[Sequence[str]] = None,
                               updated_at: Optional[float] = None)
    func NewGatewayPluginSolaceConsume(ctx *Context, name string, args GatewayPluginSolaceConsumeArgs, opts ...ResourceOption) (*GatewayPluginSolaceConsume, error)
    public GatewayPluginSolaceConsume(string name, GatewayPluginSolaceConsumeArgs args, CustomResourceOptions? opts = null)
    public GatewayPluginSolaceConsume(String name, GatewayPluginSolaceConsumeArgs args)
public GatewayPluginSolaceConsume(String name, GatewayPluginSolaceConsumeArgs args, CustomResourceOptions options)

    type: konnect:GatewayPluginSolaceConsume
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 GatewayPluginSolaceConsumeArgs
    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 GatewayPluginSolaceConsumeArgs
    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 GatewayPluginSolaceConsumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayPluginSolaceConsumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayPluginSolaceConsumeArgs
    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 gatewayPluginSolaceConsumeResource = new Konnect.GatewayPluginSolaceConsume("gatewayPluginSolaceConsumeResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginSolaceConsumeConfigArgs
    {
        Flow = new Konnect.Inputs.GatewayPluginSolaceConsumeConfigFlowArgs
        {
            Binds = new[]
            {
                new Konnect.Inputs.GatewayPluginSolaceConsumeConfigFlowBindArgs
                {
                    Name = "string",
                    Type = "string",
                },
            },
            AckMode = "string",
            Functions = new[]
            {
                "string",
            },
            MaxUnackedMessages = 0,
            Properties = 
            {
                { "string", "string" },
            },
            Selector = "string",
            WaitTimeout = 0,
            WindowSize = 0,
        },
        Session = new Konnect.Inputs.GatewayPluginSolaceConsumeConfigSessionArgs
        {
            Host = "string",
            Authentication = new Konnect.Inputs.GatewayPluginSolaceConsumeConfigSessionAuthenticationArgs
            {
                AccessToken = "string",
                AccessTokenHeader = "string",
                IdToken = "string",
                IdTokenHeader = "string",
                Password = "string",
                Scheme = "string",
                Username = "string",
            },
            CalculateMessageExpiry = false,
            ConnectTimeout = 0,
            GenerateRcvTimestamps = false,
            GenerateSendTimestamps = false,
            GenerateSenderId = false,
            GenerateSequenceNumber = false,
            Properties = 
            {
                { "string", "string" },
            },
            SslValidateCertificate = false,
            VpnName = "string",
        },
        Mode = "string",
        Polling = new Konnect.Inputs.GatewayPluginSolaceConsumeConfigPollingArgs
        {
            Timeout = 0,
        },
        Websocket = new Konnect.Inputs.GatewayPluginSolaceConsumeConfigWebsocketArgs
        {
            MaxRecvLen = 0,
            MaxSendLen = 0,
            Timeout = 0,
        },
    },
    ControlPlaneId = "string",
    CreatedAt = 0,
    Enabled = false,
    GatewayPluginSolaceConsumeId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginSolaceConsumeOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginSolaceConsumeOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginSolaceConsumeOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Partials = new[]
    {
        new Konnect.Inputs.GatewayPluginSolaceConsumePartialArgs
        {
            Id = "string",
            Name = "string",
            Path = "string",
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginSolaceConsumeRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginSolaceConsumeServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
});

    example, err := konnect.NewGatewayPluginSolaceConsume(ctx, "gatewayPluginSolaceConsumeResource", &konnect.GatewayPluginSolaceConsumeArgs{
	Config: &konnect.GatewayPluginSolaceConsumeConfigArgs{
		Flow: &konnect.GatewayPluginSolaceConsumeConfigFlowArgs{
			Binds: konnect.GatewayPluginSolaceConsumeConfigFlowBindArray{
				&konnect.GatewayPluginSolaceConsumeConfigFlowBindArgs{
					Name: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			AckMode: pulumi.String("string"),
			Functions: pulumi.StringArray{
				pulumi.String("string"),
			},
			MaxUnackedMessages: pulumi.Float64(0),
			Properties: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Selector:    pulumi.String("string"),
			WaitTimeout: pulumi.Float64(0),
			WindowSize:  pulumi.Float64(0),
		},
		Session: &konnect.GatewayPluginSolaceConsumeConfigSessionArgs{
			Host: pulumi.String("string"),
			Authentication: &konnect.GatewayPluginSolaceConsumeConfigSessionAuthenticationArgs{
				AccessToken:       pulumi.String("string"),
				AccessTokenHeader: pulumi.String("string"),
				IdToken:           pulumi.String("string"),
				IdTokenHeader:     pulumi.String("string"),
				Password:          pulumi.String("string"),
				Scheme:            pulumi.String("string"),
				Username:          pulumi.String("string"),
			},
			CalculateMessageExpiry: pulumi.Bool(false),
			ConnectTimeout:         pulumi.Float64(0),
			GenerateRcvTimestamps:  pulumi.Bool(false),
			GenerateSendTimestamps: pulumi.Bool(false),
			GenerateSenderId:       pulumi.Bool(false),
			GenerateSequenceNumber: pulumi.Bool(false),
			Properties: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			SslValidateCertificate: pulumi.Bool(false),
			VpnName:                pulumi.String("string"),
		},
		Mode: pulumi.String("string"),
		Polling: &konnect.GatewayPluginSolaceConsumeConfigPollingArgs{
			Timeout: pulumi.Float64(0),
		},
		Websocket: &konnect.GatewayPluginSolaceConsumeConfigWebsocketArgs{
			MaxRecvLen: pulumi.Float64(0),
			MaxSendLen: pulumi.Float64(0),
			Timeout:    pulumi.Float64(0),
		},
	},
	ControlPlaneId:               pulumi.String("string"),
	CreatedAt:                    pulumi.Float64(0),
	Enabled:                      pulumi.Bool(false),
	GatewayPluginSolaceConsumeId: pulumi.String("string"),
	InstanceName:                 pulumi.String("string"),
	Ordering: &konnect.GatewayPluginSolaceConsumeOrderingArgs{
		After: &konnect.GatewayPluginSolaceConsumeOrderingAfterArgs{
			Accesses: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Before: &konnect.GatewayPluginSolaceConsumeOrderingBeforeArgs{
			Accesses: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Partials: konnect.GatewayPluginSolaceConsumePartialArray{
		&konnect.GatewayPluginSolaceConsumePartialArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
			Path: pulumi.String("string"),
		},
	},
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	Route: &konnect.GatewayPluginSolaceConsumeRouteArgs{
		Id: pulumi.String("string"),
	},
	Service: &konnect.GatewayPluginSolaceConsumeServiceArgs{
		Id: pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UpdatedAt: pulumi.Float64(0),
})

    var gatewayPluginSolaceConsumeResource = new GatewayPluginSolaceConsume("gatewayPluginSolaceConsumeResource", GatewayPluginSolaceConsumeArgs.builder()
    .config(GatewayPluginSolaceConsumeConfigArgs.builder()
        .flow(GatewayPluginSolaceConsumeConfigFlowArgs.builder()
            .binds(GatewayPluginSolaceConsumeConfigFlowBindArgs.builder()
                .name("string")
                .type("string")
                .build())
            .ackMode("string")
            .functions("string")
            .maxUnackedMessages(0.0)
            .properties(Map.of("string", "string"))
            .selector("string")
            .waitTimeout(0.0)
            .windowSize(0.0)
            .build())
        .session(GatewayPluginSolaceConsumeConfigSessionArgs.builder()
            .host("string")
            .authentication(GatewayPluginSolaceConsumeConfigSessionAuthenticationArgs.builder()
                .accessToken("string")
                .accessTokenHeader("string")
                .idToken("string")
                .idTokenHeader("string")
                .password("string")
                .scheme("string")
                .username("string")
                .build())
            .calculateMessageExpiry(false)
            .connectTimeout(0.0)
            .generateRcvTimestamps(false)
            .generateSendTimestamps(false)
            .generateSenderId(false)
            .generateSequenceNumber(false)
            .properties(Map.of("string", "string"))
            .sslValidateCertificate(false)
            .vpnName("string")
            .build())
        .mode("string")
        .polling(GatewayPluginSolaceConsumeConfigPollingArgs.builder()
            .timeout(0.0)
            .build())
        .websocket(GatewayPluginSolaceConsumeConfigWebsocketArgs.builder()
            .maxRecvLen(0.0)
            .maxSendLen(0.0)
            .timeout(0.0)
            .build())
        .build())
    .controlPlaneId("string")
    .createdAt(0.0)
    .enabled(false)
    .gatewayPluginSolaceConsumeId("string")
    .instanceName("string")
    .ordering(GatewayPluginSolaceConsumeOrderingArgs.builder()
        .after(GatewayPluginSolaceConsumeOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginSolaceConsumeOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .partials(GatewayPluginSolaceConsumePartialArgs.builder()
        .id("string")
        .name("string")
        .path("string")
        .build())
    .protocols("string")
    .route(GatewayPluginSolaceConsumeRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginSolaceConsumeServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .updatedAt(0.0)
    .build());

    gateway_plugin_solace_consume_resource = konnect.GatewayPluginSolaceConsume("gatewayPluginSolaceConsumeResource",
    config={
        "flow": {
            "binds": [{
                "name": "string",
                "type": "string",
            }],
            "ack_mode": "string",
            "functions": ["string"],
            "max_unacked_messages": 0,
            "properties": {
                "string": "string",
            },
            "selector": "string",
            "wait_timeout": 0,
            "window_size": 0,
        },
        "session": {
            "host": "string",
            "authentication": {
                "access_token": "string",
                "access_token_header": "string",
                "id_token": "string",
                "id_token_header": "string",
                "password": "string",
                "scheme": "string",
                "username": "string",
            },
            "calculate_message_expiry": False,
            "connect_timeout": 0,
            "generate_rcv_timestamps": False,
            "generate_send_timestamps": False,
            "generate_sender_id": False,
            "generate_sequence_number": False,
            "properties": {
                "string": "string",
            },
            "ssl_validate_certificate": False,
            "vpn_name": "string",
        },
        "mode": "string",
        "polling": {
            "timeout": 0,
        },
        "websocket": {
            "max_recv_len": 0,
            "max_send_len": 0,
            "timeout": 0,
        },
    },
    control_plane_id="string",
    created_at=0,
    enabled=False,
    gateway_plugin_solace_consume_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    partials=[{
        "id": "string",
        "name": "string",
        "path": "string",
    }],
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    updated_at=0)

    const gatewayPluginSolaceConsumeResource = new konnect.GatewayPluginSolaceConsume("gatewayPluginSolaceConsumeResource", {
    config: {
        flow: {
            binds: [{
                name: "string",
                type: "string",
            }],
            ackMode: "string",
            functions: ["string"],
            maxUnackedMessages: 0,
            properties: {
                string: "string",
            },
            selector: "string",
            waitTimeout: 0,
            windowSize: 0,
        },
        session: {
            host: "string",
            authentication: {
                accessToken: "string",
                accessTokenHeader: "string",
                idToken: "string",
                idTokenHeader: "string",
                password: "string",
                scheme: "string",
                username: "string",
            },
            calculateMessageExpiry: false,
            connectTimeout: 0,
            generateRcvTimestamps: false,
            generateSendTimestamps: false,
            generateSenderId: false,
            generateSequenceNumber: false,
            properties: {
                string: "string",
            },
            sslValidateCertificate: false,
            vpnName: "string",
        },
        mode: "string",
        polling: {
            timeout: 0,
        },
        websocket: {
            maxRecvLen: 0,
            maxSendLen: 0,
            timeout: 0,
        },
    },
    controlPlaneId: "string",
    createdAt: 0,
    enabled: false,
    gatewayPluginSolaceConsumeId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    partials: [{
        id: "string",
        name: "string",
        path: "string",
    }],
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
});

    type: konnect:GatewayPluginSolaceConsume
properties:
    config:
        flow:
            ackMode: string
            binds:
                - name: string
                  type: string
            functions:
                - string
            maxUnackedMessages: 0
            properties:
                string: string
            selector: string
            waitTimeout: 0
            windowSize: 0
        mode: string
        polling:
            timeout: 0
        session:
            authentication:
                accessToken: string
                accessTokenHeader: string
                idToken: string
                idTokenHeader: string
                password: string
                scheme: string
                username: string
            calculateMessageExpiry: false
            connectTimeout: 0
            generateRcvTimestamps: false
            generateSendTimestamps: false
            generateSenderId: false
            generateSequenceNumber: false
            host: string
            properties:
                string: string
            sslValidateCertificate: false
            vpnName: string
        websocket:
            maxRecvLen: 0
            maxSendLen: 0
            timeout: 0
    controlPlaneId: string
    createdAt: 0
    enabled: false
    gatewayPluginSolaceConsumeId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    partials:
        - id: string
          name: string
          path: string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    updatedAt: 0

    GatewayPluginSolaceConsume 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 GatewayPluginSolaceConsume resource accepts the following input properties:

    Config GatewayPluginSolaceConsumeConfig
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    CreatedAt double
    Unix epoch when the resource was created.
    Enabled bool
    Whether the plugin is applied. Default: true
    GatewayPluginSolaceConsumeId string
    A string representing a UUID (universally unique identifier).
    InstanceName string
    A unique string representing a UTF-8 encoded name.
    Ordering GatewayPluginSolaceConsumeOrdering
    Partials List<GatewayPluginSolaceConsumePartial>
    A list of partials to be used by the plugin.
    Protocols List<string>
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    Route GatewayPluginSolaceConsumeRoute
    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 GatewayPluginSolaceConsumeService
    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.
    Config GatewayPluginSolaceConsumeConfigArgs
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    CreatedAt float64
    Unix epoch when the resource was created.
    Enabled bool
    Whether the plugin is applied. Default: true
    GatewayPluginSolaceConsumeId string
    A string representing a UUID (universally unique identifier).
    InstanceName string
    A unique string representing a UTF-8 encoded name.
    Ordering GatewayPluginSolaceConsumeOrderingArgs
    Partials []GatewayPluginSolaceConsumePartialArgs
    A list of partials to be used by the plugin.
    Protocols []string
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    Route GatewayPluginSolaceConsumeRouteArgs
    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 GatewayPluginSolaceConsumeServiceArgs
    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.
    config GatewayPluginSolaceConsumeConfig
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt Double
    Unix epoch when the resource was created.
    enabled Boolean
    Whether the plugin is applied. Default: true
    gatewayPluginSolaceConsumeId String
    A string representing a UUID (universally unique identifier).
    instanceName String
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginSolaceConsumeOrdering
    partials List<GatewayPluginSolaceConsumePartial>
    A list of partials to be used by the plugin.
    protocols List<String>
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    route GatewayPluginSolaceConsumeRoute
    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 GatewayPluginSolaceConsumeService
    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.
    config GatewayPluginSolaceConsumeConfig
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt number
    Unix epoch when the resource was created.
    enabled boolean
    Whether the plugin is applied. Default: true
    gatewayPluginSolaceConsumeId string
    A string representing a UUID (universally unique identifier).
    instanceName string
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginSolaceConsumeOrdering
    partials GatewayPluginSolaceConsumePartial[]
    A list of partials to be used by the plugin.
    protocols string[]
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    route GatewayPluginSolaceConsumeRoute
    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 GatewayPluginSolaceConsumeService
    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.
    config GatewayPluginSolaceConsumeConfigArgs
    control_plane_id str
    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_solace_consume_id str
    A string representing a UUID (universally unique identifier).
    instance_name str
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginSolaceConsumeOrderingArgs
    partials Sequence[GatewayPluginSolaceConsumePartialArgs]
    A list of partials to be used by the plugin.
    protocols Sequence[str]
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    route GatewayPluginSolaceConsumeRouteArgs
    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 GatewayPluginSolaceConsumeServiceArgs
    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.
    config Property Map
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt Number
    Unix epoch when the resource was created.
    enabled Boolean
    Whether the plugin is applied. Default: true
    gatewayPluginSolaceConsumeId String
    A string representing a UUID (universally unique identifier).
    instanceName 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 set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayPluginSolaceConsume 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 GatewayPluginSolaceConsume Resource

    Get an existing GatewayPluginSolaceConsume 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?: GatewayPluginSolaceConsumeState, opts?: CustomResourceOptions): GatewayPluginSolaceConsume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginSolaceConsumeConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_solace_consume_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginSolaceConsumeOrderingArgs] = None,
        partials: Optional[Sequence[GatewayPluginSolaceConsumePartialArgs]] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginSolaceConsumeRouteArgs] = None,
        service: Optional[GatewayPluginSolaceConsumeServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginSolaceConsume
    func GetGatewayPluginSolaceConsume(ctx *Context, name string, id IDInput, state *GatewayPluginSolaceConsumeState, opts ...ResourceOption) (*GatewayPluginSolaceConsume, error)
    public static GatewayPluginSolaceConsume Get(string name, Input<string> id, GatewayPluginSolaceConsumeState? state, CustomResourceOptions? opts = null)
    public static GatewayPluginSolaceConsume get(String name, Output<String> id, GatewayPluginSolaceConsumeState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayPluginSolaceConsume    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.
    The following state arguments are supported:
    Config GatewayPluginSolaceConsumeConfig
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    CreatedAt double
    Unix epoch when the resource was created.
    Enabled bool
    Whether the plugin is applied. Default: true
    GatewayPluginSolaceConsumeId string
    A string representing a UUID (universally unique identifier).
    InstanceName string
    A unique string representing a UTF-8 encoded name.
    Ordering GatewayPluginSolaceConsumeOrdering
    Partials List<GatewayPluginSolaceConsumePartial>
    A list of partials to be used by the plugin.
    Protocols List<string>
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    Route GatewayPluginSolaceConsumeRoute
    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 GatewayPluginSolaceConsumeService
    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.
    Config GatewayPluginSolaceConsumeConfigArgs
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    CreatedAt float64
    Unix epoch when the resource was created.
    Enabled bool
    Whether the plugin is applied. Default: true
    GatewayPluginSolaceConsumeId string
    A string representing a UUID (universally unique identifier).
    InstanceName string
    A unique string representing a UTF-8 encoded name.
    Ordering GatewayPluginSolaceConsumeOrderingArgs
    Partials []GatewayPluginSolaceConsumePartialArgs
    A list of partials to be used by the plugin.
    Protocols []string
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    Route GatewayPluginSolaceConsumeRouteArgs
    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 GatewayPluginSolaceConsumeServiceArgs
    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.
    config GatewayPluginSolaceConsumeConfig
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt Double
    Unix epoch when the resource was created.
    enabled Boolean
    Whether the plugin is applied. Default: true
    gatewayPluginSolaceConsumeId String
    A string representing a UUID (universally unique identifier).
    instanceName String
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginSolaceConsumeOrdering
    partials List<GatewayPluginSolaceConsumePartial>
    A list of partials to be used by the plugin.
    protocols List<String>
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    route GatewayPluginSolaceConsumeRoute
    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 GatewayPluginSolaceConsumeService
    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.
    config GatewayPluginSolaceConsumeConfig
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt number
    Unix epoch when the resource was created.
    enabled boolean
    Whether the plugin is applied. Default: true
    gatewayPluginSolaceConsumeId string
    A string representing a UUID (universally unique identifier).
    instanceName string
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginSolaceConsumeOrdering
    partials GatewayPluginSolaceConsumePartial[]
    A list of partials to be used by the plugin.
    protocols string[]
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    route GatewayPluginSolaceConsumeRoute
    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 GatewayPluginSolaceConsumeService
    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.
    config GatewayPluginSolaceConsumeConfigArgs
    control_plane_id str
    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_solace_consume_id str
    A string representing a UUID (universally unique identifier).
    instance_name str
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginSolaceConsumeOrderingArgs
    partials Sequence[GatewayPluginSolaceConsumePartialArgs]
    A list of partials to be used by the plugin.
    protocols Sequence[str]
    A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    route GatewayPluginSolaceConsumeRouteArgs
    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 GatewayPluginSolaceConsumeServiceArgs
    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.
    config Property Map
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt Number
    Unix epoch when the resource was created.
    enabled Boolean
    Whether the plugin is applied. Default: true
    gatewayPluginSolaceConsumeId String
    A string representing a UUID (universally unique identifier).
    instanceName 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 set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]
    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.

    Supporting Types

    GatewayPluginSolaceConsumeConfig, GatewayPluginSolaceConsumeConfigArgs

    Flow GatewayPluginSolaceConsumeConfigFlow
    The flow related configuration.
    Session GatewayPluginSolaceConsumeConfigSession
    Session related configuration.
    Mode string
    The mode of operation for the plugin. The AUTO determines the mode automatically from the client request. Default: "POLLING"; must be one of ["AUTO", "POLLING", "SERVER-SENT-EVENTS", "WEBSOCKET"]
    Polling GatewayPluginSolaceConsumeConfigPolling
    The POLLING mode related configuration settings.
    Websocket GatewayPluginSolaceConsumeConfigWebsocket
    The WEBSOCKET mode related configuration settings.
    Flow GatewayPluginSolaceConsumeConfigFlow
    The flow related configuration.
    Session GatewayPluginSolaceConsumeConfigSession
    Session related configuration.
    Mode string
    The mode of operation for the plugin. The AUTO determines the mode automatically from the client request. Default: "POLLING"; must be one of ["AUTO", "POLLING", "SERVER-SENT-EVENTS", "WEBSOCKET"]
    Polling GatewayPluginSolaceConsumeConfigPolling
    The POLLING mode related configuration settings.
    Websocket GatewayPluginSolaceConsumeConfigWebsocket
    The WEBSOCKET mode related configuration settings.
    flow GatewayPluginSolaceConsumeConfigFlow
    The flow related configuration.
    session GatewayPluginSolaceConsumeConfigSession
    Session related configuration.
    mode String
    The mode of operation for the plugin. The AUTO determines the mode automatically from the client request. Default: "POLLING"; must be one of ["AUTO", "POLLING", "SERVER-SENT-EVENTS", "WEBSOCKET"]
    polling GatewayPluginSolaceConsumeConfigPolling
    The POLLING mode related configuration settings.
    websocket GatewayPluginSolaceConsumeConfigWebsocket
    The WEBSOCKET mode related configuration settings.
    flow GatewayPluginSolaceConsumeConfigFlow
    The flow related configuration.
    session GatewayPluginSolaceConsumeConfigSession
    Session related configuration.
    mode string
    The mode of operation for the plugin. The AUTO determines the mode automatically from the client request. Default: "POLLING"; must be one of ["AUTO", "POLLING", "SERVER-SENT-EVENTS", "WEBSOCKET"]
    polling GatewayPluginSolaceConsumeConfigPolling
    The POLLING mode related configuration settings.
    websocket GatewayPluginSolaceConsumeConfigWebsocket
    The WEBSOCKET mode related configuration settings.
    flow GatewayPluginSolaceConsumeConfigFlow
    The flow related configuration.
    session GatewayPluginSolaceConsumeConfigSession
    Session related configuration.
    mode str
    The mode of operation for the plugin. The AUTO determines the mode automatically from the client request. Default: "POLLING"; must be one of ["AUTO", "POLLING", "SERVER-SENT-EVENTS", "WEBSOCKET"]
    polling GatewayPluginSolaceConsumeConfigPolling
    The POLLING mode related configuration settings.
    websocket GatewayPluginSolaceConsumeConfigWebsocket
    The WEBSOCKET mode related configuration settings.
    flow Property Map
    The flow related configuration.
    session Property Map
    Session related configuration.
    mode String
    The mode of operation for the plugin. The AUTO determines the mode automatically from the client request. Default: "POLLING"; must be one of ["AUTO", "POLLING", "SERVER-SENT-EVENTS", "WEBSOCKET"]
    polling Property Map
    The POLLING mode related configuration settings.
    websocket Property Map
    The WEBSOCKET mode related configuration settings.

    GatewayPluginSolaceConsumeConfigFlow, GatewayPluginSolaceConsumeConfigFlowArgs

    Binds List<GatewayPluginSolaceConsumeConfigFlowBind>
    AckMode string
    Controls how acknowledgments are generated for received Guaranteed messages. When set to AUTO, the messages are positively acknowledged upon receiving them. When set to 'CLIENT', the messages are positively or negatively acknowledged by Kong regarding to client delivery status. Default: "CLIENT"; must be one of ["AUTO", "CLIENT"]
    Functions List<string>
    The Lua functions that manipulates the message being received from Solace. The message variable can be used to access the current message content, and the function can return a new content.
    MaxUnackedMessages double
    This property controls the maximum number of messages that may be unacknowledged on the Flow. Default: -1
    Properties Dictionary<string, string>
    Additional Solace flow properties (each setting needs to have FLOW_ prefix).
    Selector string
    The selector when binding to an endpoint.
    WaitTimeout double
    Specifies in milliseconds how long to wait for messages to appear on each poll before giving up or retrying. Default: 50
    WindowSize double
    The Guaranteed message window size for the Flow. Default: 255
    Binds []GatewayPluginSolaceConsumeConfigFlowBind
    AckMode string
    Controls how acknowledgments are generated for received Guaranteed messages. When set to AUTO, the messages are positively acknowledged upon receiving them. When set to 'CLIENT', the messages are positively or negatively acknowledged by Kong regarding to client delivery status. Default: "CLIENT"; must be one of ["AUTO", "CLIENT"]
    Functions []string
    The Lua functions that manipulates the message being received from Solace. The message variable can be used to access the current message content, and the function can return a new content.
    MaxUnackedMessages float64
    This property controls the maximum number of messages that may be unacknowledged on the Flow. Default: -1
    Properties map[string]string
    Additional Solace flow properties (each setting needs to have FLOW_ prefix).
    Selector string
    The selector when binding to an endpoint.
    WaitTimeout float64
    Specifies in milliseconds how long to wait for messages to appear on each poll before giving up or retrying. Default: 50
    WindowSize float64
    The Guaranteed message window size for the Flow. Default: 255
    binds List<GatewayPluginSolaceConsumeConfigFlowBind>
    ackMode String
    Controls how acknowledgments are generated for received Guaranteed messages. When set to AUTO, the messages are positively acknowledged upon receiving them. When set to 'CLIENT', the messages are positively or negatively acknowledged by Kong regarding to client delivery status. Default: "CLIENT"; must be one of ["AUTO", "CLIENT"]
    functions List<String>
    The Lua functions that manipulates the message being received from Solace. The message variable can be used to access the current message content, and the function can return a new content.
    maxUnackedMessages Double
    This property controls the maximum number of messages that may be unacknowledged on the Flow. Default: -1
    properties Map<String,String>
    Additional Solace flow properties (each setting needs to have FLOW_ prefix).
    selector String
    The selector when binding to an endpoint.
    waitTimeout Double
    Specifies in milliseconds how long to wait for messages to appear on each poll before giving up or retrying. Default: 50
    windowSize Double
    The Guaranteed message window size for the Flow. Default: 255
    binds GatewayPluginSolaceConsumeConfigFlowBind[]
    ackMode string
    Controls how acknowledgments are generated for received Guaranteed messages. When set to AUTO, the messages are positively acknowledged upon receiving them. When set to 'CLIENT', the messages are positively or negatively acknowledged by Kong regarding to client delivery status. Default: "CLIENT"; must be one of ["AUTO", "CLIENT"]
    functions string[]
    The Lua functions that manipulates the message being received from Solace. The message variable can be used to access the current message content, and the function can return a new content.
    maxUnackedMessages number
    This property controls the maximum number of messages that may be unacknowledged on the Flow. Default: -1
    properties {[key: string]: string}
    Additional Solace flow properties (each setting needs to have FLOW_ prefix).
    selector string
    The selector when binding to an endpoint.
    waitTimeout number
    Specifies in milliseconds how long to wait for messages to appear on each poll before giving up or retrying. Default: 50
    windowSize number
    The Guaranteed message window size for the Flow. Default: 255
    binds Sequence[GatewayPluginSolaceConsumeConfigFlowBind]
    ack_mode str
    Controls how acknowledgments are generated for received Guaranteed messages. When set to AUTO, the messages are positively acknowledged upon receiving them. When set to 'CLIENT', the messages are positively or negatively acknowledged by Kong regarding to client delivery status. Default: "CLIENT"; must be one of ["AUTO", "CLIENT"]
    functions Sequence[str]
    The Lua functions that manipulates the message being received from Solace. The message variable can be used to access the current message content, and the function can return a new content.
    max_unacked_messages float
    This property controls the maximum number of messages that may be unacknowledged on the Flow. Default: -1
    properties Mapping[str, str]
    Additional Solace flow properties (each setting needs to have FLOW_ prefix).
    selector str
    The selector when binding to an endpoint.
    wait_timeout float
    Specifies in milliseconds how long to wait for messages to appear on each poll before giving up or retrying. Default: 50
    window_size float
    The Guaranteed message window size for the Flow. Default: 255
    binds List<Property Map>
    ackMode String
    Controls how acknowledgments are generated for received Guaranteed messages. When set to AUTO, the messages are positively acknowledged upon receiving them. When set to 'CLIENT', the messages are positively or negatively acknowledged by Kong regarding to client delivery status. Default: "CLIENT"; must be one of ["AUTO", "CLIENT"]
    functions List<String>
    The Lua functions that manipulates the message being received from Solace. The message variable can be used to access the current message content, and the function can return a new content.
    maxUnackedMessages Number
    This property controls the maximum number of messages that may be unacknowledged on the Flow. Default: -1
    properties Map<String>
    Additional Solace flow properties (each setting needs to have FLOW_ prefix).
    selector String
    The selector when binding to an endpoint.
    waitTimeout Number
    Specifies in milliseconds how long to wait for messages to appear on each poll before giving up or retrying. Default: 50
    windowSize Number
    The Guaranteed message window size for the Flow. Default: 255

    GatewayPluginSolaceConsumeConfigFlowBind, GatewayPluginSolaceConsumeConfigFlowBindArgs

    Name string
    The name of the Queue that is the target of the bind. You can use $(uri_captures['\n\n']) in this field (replace <capture-identifier> with a real value, for example $uri_captures['queue'] when the matched route has a path ~/(?<queue>[a-z]+)). Not Null
    Type string
    The type of object to which this Flow is bound. Default: "QUEUE"; must be "QUEUE"
    Name string
    The name of the Queue that is the target of the bind. You can use $(uri_captures['\n\n']) in this field (replace <capture-identifier> with a real value, for example $uri_captures['queue'] when the matched route has a path ~/(?<queue>[a-z]+)). Not Null
    Type string
    The type of object to which this Flow is bound. Default: "QUEUE"; must be "QUEUE"
    name String
    The name of the Queue that is the target of the bind. You can use $(uri_captures['\n\n']) in this field (replace <capture-identifier> with a real value, for example $uri_captures['queue'] when the matched route has a path ~/(?<queue>[a-z]+)). Not Null
    type String
    The type of object to which this Flow is bound. Default: "QUEUE"; must be "QUEUE"
    name string
    The name of the Queue that is the target of the bind. You can use $(uri_captures['\n\n']) in this field (replace <capture-identifier> with a real value, for example $uri_captures['queue'] when the matched route has a path ~/(?<queue>[a-z]+)). Not Null
    type string
    The type of object to which this Flow is bound. Default: "QUEUE"; must be "QUEUE"
    name str
    The name of the Queue that is the target of the bind. You can use $(uri_captures['\n\n']) in this field (replace <capture-identifier> with a real value, for example $uri_captures['queue'] when the matched route has a path ~/(?<queue>[a-z]+)). Not Null
    type str
    The type of object to which this Flow is bound. Default: "QUEUE"; must be "QUEUE"
    name String
    The name of the Queue that is the target of the bind. You can use $(uri_captures['\n\n']) in this field (replace <capture-identifier> with a real value, for example $uri_captures['queue'] when the matched route has a path ~/(?<queue>[a-z]+)). Not Null
    type String
    The type of object to which this Flow is bound. Default: "QUEUE"; must be "QUEUE"

    GatewayPluginSolaceConsumeConfigPolling, GatewayPluginSolaceConsumeConfigPollingArgs

    Timeout double
    Polling timeout in milliseconds. When set to 0, the polling works like short-polling and waits at maximum the Flow wait_timeout amount of time for the new messages (short-polling). When set to larger than 0, the connection is kept open and only closed after the timeout or in case messages appear earlier (long-polling). Default: 0
    Timeout float64
    Polling timeout in milliseconds. When set to 0, the polling works like short-polling and waits at maximum the Flow wait_timeout amount of time for the new messages (short-polling). When set to larger than 0, the connection is kept open and only closed after the timeout or in case messages appear earlier (long-polling). Default: 0
    timeout Double
    Polling timeout in milliseconds. When set to 0, the polling works like short-polling and waits at maximum the Flow wait_timeout amount of time for the new messages (short-polling). When set to larger than 0, the connection is kept open and only closed after the timeout or in case messages appear earlier (long-polling). Default: 0
    timeout number
    Polling timeout in milliseconds. When set to 0, the polling works like short-polling and waits at maximum the Flow wait_timeout amount of time for the new messages (short-polling). When set to larger than 0, the connection is kept open and only closed after the timeout or in case messages appear earlier (long-polling). Default: 0
    timeout float
    Polling timeout in milliseconds. When set to 0, the polling works like short-polling and waits at maximum the Flow wait_timeout amount of time for the new messages (short-polling). When set to larger than 0, the connection is kept open and only closed after the timeout or in case messages appear earlier (long-polling). Default: 0
    timeout Number
    Polling timeout in milliseconds. When set to 0, the polling works like short-polling and waits at maximum the Flow wait_timeout amount of time for the new messages (short-polling). When set to larger than 0, the connection is kept open and only closed after the timeout or in case messages appear earlier (long-polling). Default: 0

    GatewayPluginSolaceConsumeConfigSession, GatewayPluginSolaceConsumeConfigSessionArgs

    Host string
    The IPv4 or IPv6 address or host name to connect to (see: https://docs.solace.com/API-Developer-Online-Ref-Documentation/c/index.html#host-entry).
    Authentication GatewayPluginSolaceConsumeConfigSessionAuthentication
    Session authentication related configuration.
    CalculateMessageExpiry bool
    If this property is true and time-to-live has a positive value in a message, the expiration time is calculated when the message is sent or received. Default: true
    ConnectTimeout double
    The timeout period (in milliseconds) for a connect operation to a given host (per host). Default: 3000
    GenerateRcvTimestamps bool
    When enabled, a receive timestamp is recorded for each message. Default: true
    GenerateSendTimestamps bool
    When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    GenerateSenderId bool
    When enabled, a sender id is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    GenerateSequenceNumber bool
    When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    Properties Dictionary<string, string>
    Additional Solace session properties (each setting needs to have SESSION_ prefix).
    SslValidateCertificate bool
    Indicates whether the API should validate server certificates with the trusted certificates. Default: false
    VpnName string
    The name of the Message VPN to attempt to join when connecting to an event broker.
    Host string
    The IPv4 or IPv6 address or host name to connect to (see: https://docs.solace.com/API-Developer-Online-Ref-Documentation/c/index.html#host-entry).
    Authentication GatewayPluginSolaceConsumeConfigSessionAuthentication
    Session authentication related configuration.
    CalculateMessageExpiry bool
    If this property is true and time-to-live has a positive value in a message, the expiration time is calculated when the message is sent or received. Default: true
    ConnectTimeout float64
    The timeout period (in milliseconds) for a connect operation to a given host (per host). Default: 3000
    GenerateRcvTimestamps bool
    When enabled, a receive timestamp is recorded for each message. Default: true
    GenerateSendTimestamps bool
    When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    GenerateSenderId bool
    When enabled, a sender id is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    GenerateSequenceNumber bool
    When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    Properties map[string]string
    Additional Solace session properties (each setting needs to have SESSION_ prefix).
    SslValidateCertificate bool
    Indicates whether the API should validate server certificates with the trusted certificates. Default: false
    VpnName string
    The name of the Message VPN to attempt to join when connecting to an event broker.
    host String
    The IPv4 or IPv6 address or host name to connect to (see: https://docs.solace.com/API-Developer-Online-Ref-Documentation/c/index.html#host-entry).
    authentication GatewayPluginSolaceConsumeConfigSessionAuthentication
    Session authentication related configuration.
    calculateMessageExpiry Boolean
    If this property is true and time-to-live has a positive value in a message, the expiration time is calculated when the message is sent or received. Default: true
    connectTimeout Double
    The timeout period (in milliseconds) for a connect operation to a given host (per host). Default: 3000
    generateRcvTimestamps Boolean
    When enabled, a receive timestamp is recorded for each message. Default: true
    generateSendTimestamps Boolean
    When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    generateSenderId Boolean
    When enabled, a sender id is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    generateSequenceNumber Boolean
    When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    properties Map<String,String>
    Additional Solace session properties (each setting needs to have SESSION_ prefix).
    sslValidateCertificate Boolean
    Indicates whether the API should validate server certificates with the trusted certificates. Default: false
    vpnName String
    The name of the Message VPN to attempt to join when connecting to an event broker.
    host string
    The IPv4 or IPv6 address or host name to connect to (see: https://docs.solace.com/API-Developer-Online-Ref-Documentation/c/index.html#host-entry).
    authentication GatewayPluginSolaceConsumeConfigSessionAuthentication
    Session authentication related configuration.
    calculateMessageExpiry boolean
    If this property is true and time-to-live has a positive value in a message, the expiration time is calculated when the message is sent or received. Default: true
    connectTimeout number
    The timeout period (in milliseconds) for a connect operation to a given host (per host). Default: 3000
    generateRcvTimestamps boolean
    When enabled, a receive timestamp is recorded for each message. Default: true
    generateSendTimestamps boolean
    When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    generateSenderId boolean
    When enabled, a sender id is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    generateSequenceNumber boolean
    When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    properties {[key: string]: string}
    Additional Solace session properties (each setting needs to have SESSION_ prefix).
    sslValidateCertificate boolean
    Indicates whether the API should validate server certificates with the trusted certificates. Default: false
    vpnName string
    The name of the Message VPN to attempt to join when connecting to an event broker.
    host str
    The IPv4 or IPv6 address or host name to connect to (see: https://docs.solace.com/API-Developer-Online-Ref-Documentation/c/index.html#host-entry).
    authentication GatewayPluginSolaceConsumeConfigSessionAuthentication
    Session authentication related configuration.
    calculate_message_expiry bool
    If this property is true and time-to-live has a positive value in a message, the expiration time is calculated when the message is sent or received. Default: true
    connect_timeout float
    The timeout period (in milliseconds) for a connect operation to a given host (per host). Default: 3000
    generate_rcv_timestamps bool
    When enabled, a receive timestamp is recorded for each message. Default: true
    generate_send_timestamps bool
    When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    generate_sender_id bool
    When enabled, a sender id is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    generate_sequence_number bool
    When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    properties Mapping[str, str]
    Additional Solace session properties (each setting needs to have SESSION_ prefix).
    ssl_validate_certificate bool
    Indicates whether the API should validate server certificates with the trusted certificates. Default: false
    vpn_name str
    The name of the Message VPN to attempt to join when connecting to an event broker.
    host String
    The IPv4 or IPv6 address or host name to connect to (see: https://docs.solace.com/API-Developer-Online-Ref-Documentation/c/index.html#host-entry).
    authentication Property Map
    Session authentication related configuration.
    calculateMessageExpiry Boolean
    If this property is true and time-to-live has a positive value in a message, the expiration time is calculated when the message is sent or received. Default: true
    connectTimeout Number
    The timeout period (in milliseconds) for a connect operation to a given host (per host). Default: 3000
    generateRcvTimestamps Boolean
    When enabled, a receive timestamp is recorded for each message. Default: true
    generateSendTimestamps Boolean
    When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    generateSenderId Boolean
    When enabled, a sender id is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    generateSequenceNumber Boolean
    When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent. Default: true
    properties Map<String>
    Additional Solace session properties (each setting needs to have SESSION_ prefix).
    sslValidateCertificate Boolean
    Indicates whether the API should validate server certificates with the trusted certificates. Default: false
    vpnName String
    The name of the Message VPN to attempt to join when connecting to an event broker.

    GatewayPluginSolaceConsumeConfigSessionAuthentication, GatewayPluginSolaceConsumeConfigSessionAuthenticationArgs

    AccessToken string
    The OAuth2 access token used with OAUTH2 authentication scheme when connecting to an event broker.
    AccessTokenHeader string
    IdToken string
    The OpenID Connect ID token used with OAUTH2 authentication scheme when connecting to an event broker.
    IdTokenHeader string
    Password string
    The password used with BASIC authentication scheme when connecting to an event broker.
    Scheme string
    The client authentication scheme used when connection to an event broker. Default: "BASIC"; must be one of ["BASIC", "NONE", "OAUTH2"]
    Username string
    The username used with BASIC authentication scheme when connecting to an event broker.
    AccessToken string
    The OAuth2 access token used with OAUTH2 authentication scheme when connecting to an event broker.
    AccessTokenHeader string
    IdToken string
    The OpenID Connect ID token used with OAUTH2 authentication scheme when connecting to an event broker.
    IdTokenHeader string
    Password string
    The password used with BASIC authentication scheme when connecting to an event broker.
    Scheme string
    The client authentication scheme used when connection to an event broker. Default: "BASIC"; must be one of ["BASIC", "NONE", "OAUTH2"]
    Username string
    The username used with BASIC authentication scheme when connecting to an event broker.
    accessToken String
    The OAuth2 access token used with OAUTH2 authentication scheme when connecting to an event broker.
    accessTokenHeader String
    idToken String
    The OpenID Connect ID token used with OAUTH2 authentication scheme when connecting to an event broker.
    idTokenHeader String
    password String
    The password used with BASIC authentication scheme when connecting to an event broker.
    scheme String
    The client authentication scheme used when connection to an event broker. Default: "BASIC"; must be one of ["BASIC", "NONE", "OAUTH2"]
    username String
    The username used with BASIC authentication scheme when connecting to an event broker.
    accessToken string
    The OAuth2 access token used with OAUTH2 authentication scheme when connecting to an event broker.
    accessTokenHeader string
    idToken string
    The OpenID Connect ID token used with OAUTH2 authentication scheme when connecting to an event broker.
    idTokenHeader string
    password string
    The password used with BASIC authentication scheme when connecting to an event broker.
    scheme string
    The client authentication scheme used when connection to an event broker. Default: "BASIC"; must be one of ["BASIC", "NONE", "OAUTH2"]
    username string
    The username used with BASIC authentication scheme when connecting to an event broker.
    access_token str
    The OAuth2 access token used with OAUTH2 authentication scheme when connecting to an event broker.
    access_token_header str
    id_token str
    The OpenID Connect ID token used with OAUTH2 authentication scheme when connecting to an event broker.
    id_token_header str
    password str
    The password used with BASIC authentication scheme when connecting to an event broker.
    scheme str
    The client authentication scheme used when connection to an event broker. Default: "BASIC"; must be one of ["BASIC", "NONE", "OAUTH2"]
    username str
    The username used with BASIC authentication scheme when connecting to an event broker.
    accessToken String
    The OAuth2 access token used with OAUTH2 authentication scheme when connecting to an event broker.
    accessTokenHeader String
    idToken String
    The OpenID Connect ID token used with OAUTH2 authentication scheme when connecting to an event broker.
    idTokenHeader String
    password String
    The password used with BASIC authentication scheme when connecting to an event broker.
    scheme String
    The client authentication scheme used when connection to an event broker. Default: "BASIC"; must be one of ["BASIC", "NONE", "OAUTH2"]
    username String
    The username used with BASIC authentication scheme when connecting to an event broker.

    GatewayPluginSolaceConsumeConfigWebsocket, GatewayPluginSolaceConsumeConfigWebsocketArgs

    MaxRecvLen double
    Specifies the maximal length of payload allowed when receiving WebSocket frames. Default: 65536
    MaxSendLen double
    Specifies the maximal length of payload allowed when sending WebSocket frames. Default: 65536
    Timeout double
    Specifies the network timeout threshold in milliseconds. Default: 1000
    MaxRecvLen float64
    Specifies the maximal length of payload allowed when receiving WebSocket frames. Default: 65536
    MaxSendLen float64
    Specifies the maximal length of payload allowed when sending WebSocket frames. Default: 65536
    Timeout float64
    Specifies the network timeout threshold in milliseconds. Default: 1000
    maxRecvLen Double
    Specifies the maximal length of payload allowed when receiving WebSocket frames. Default: 65536
    maxSendLen Double
    Specifies the maximal length of payload allowed when sending WebSocket frames. Default: 65536
    timeout Double
    Specifies the network timeout threshold in milliseconds. Default: 1000
    maxRecvLen number
    Specifies the maximal length of payload allowed when receiving WebSocket frames. Default: 65536
    maxSendLen number
    Specifies the maximal length of payload allowed when sending WebSocket frames. Default: 65536
    timeout number
    Specifies the network timeout threshold in milliseconds. Default: 1000
    max_recv_len float
    Specifies the maximal length of payload allowed when receiving WebSocket frames. Default: 65536
    max_send_len float
    Specifies the maximal length of payload allowed when sending WebSocket frames. Default: 65536
    timeout float
    Specifies the network timeout threshold in milliseconds. Default: 1000
    maxRecvLen Number
    Specifies the maximal length of payload allowed when receiving WebSocket frames. Default: 65536
    maxSendLen Number
    Specifies the maximal length of payload allowed when sending WebSocket frames. Default: 65536
    timeout Number
    Specifies the network timeout threshold in milliseconds. Default: 1000

    GatewayPluginSolaceConsumeOrdering, GatewayPluginSolaceConsumeOrderingArgs

    GatewayPluginSolaceConsumeOrderingAfter, GatewayPluginSolaceConsumeOrderingAfterArgs

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GatewayPluginSolaceConsumeOrderingBefore, GatewayPluginSolaceConsumeOrderingBeforeArgs

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GatewayPluginSolaceConsumePartial, GatewayPluginSolaceConsumePartialArgs

    Id string
    A string representing a UUID (universally unique identifier).
    Name string
    A unique string representing a UTF-8 encoded name.
    Path string
    Id string
    A string representing a UUID (universally unique identifier).
    Name string
    A unique string representing a UTF-8 encoded name.
    Path string
    id String
    A string representing a UUID (universally unique identifier).
    name String
    A unique string representing a UTF-8 encoded name.
    path String
    id string
    A string representing a UUID (universally unique identifier).
    name string
    A unique string representing a UTF-8 encoded name.
    path string
    id str
    A string representing a UUID (universally unique identifier).
    name str
    A unique string representing a UTF-8 encoded name.
    path str
    id String
    A string representing a UUID (universally unique identifier).
    name String
    A unique string representing a UTF-8 encoded name.
    path String

    GatewayPluginSolaceConsumeRoute, GatewayPluginSolaceConsumeRouteArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    GatewayPluginSolaceConsumeService, GatewayPluginSolaceConsumeServiceArgs

    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_solace_consume.my_konnect_gateway_plugin_solace_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/gatewayPluginSolaceConsume:GatewayPluginSolaceConsume my_konnect_gateway_plugin_solace_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.
    konnect logo
    konnect 3.4.1 published on Wednesday, Oct 29, 2025 by kong
    kong/terraform-provider-konnect
      Meet Neo: Your AI Platform Teammate