konnect.GatewayPluginSolaceLog

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

name string

The unique name of the resource.

args GatewayPluginSolaceLogArgs

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 GatewayPluginSolaceLogArgs

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 GatewayPluginSolaceLogArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GatewayPluginSolaceLogArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GatewayPluginSolaceLogArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Config GatewayPluginSolaceLogConfig

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

GatewayPluginSolaceLogId string

A string representing a UUID (universally unique identifier).

InstanceName string

A unique string representing a UTF-8 encoded name.

Ordering GatewayPluginSolaceLogOrdering

Partials List<GatewayPluginSolaceLogPartial>

A list of partials to be used by the plugin.

Protocols List<string>

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]

Route GatewayPluginSolaceLogRoute

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 GatewayPluginSolaceLogService

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 GatewayPluginSolaceLogConfigArgs

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

GatewayPluginSolaceLogId string

A string representing a UUID (universally unique identifier).

InstanceName string

A unique string representing a UTF-8 encoded name.

Ordering GatewayPluginSolaceLogOrderingArgs

Partials []GatewayPluginSolaceLogPartialArgs

A list of partials to be used by the plugin.

Protocols []string

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]

Route GatewayPluginSolaceLogRouteArgs

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 GatewayPluginSolaceLogServiceArgs

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 GatewayPluginSolaceLogConfig

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

gatewayPluginSolaceLogId String

A string representing a UUID (universally unique identifier).

instanceName String

A unique string representing a UTF-8 encoded name.

ordering GatewayPluginSolaceLogOrdering

partials List<GatewayPluginSolaceLogPartial>

A list of partials to be used by the plugin.

protocols List<String>

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]

route GatewayPluginSolaceLogRoute

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 GatewayPluginSolaceLogService

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 GatewayPluginSolaceLogConfig

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

gatewayPluginSolaceLogId string

A string representing a UUID (universally unique identifier).

instanceName string

A unique string representing a UTF-8 encoded name.

ordering GatewayPluginSolaceLogOrdering

partials GatewayPluginSolaceLogPartial[]

A list of partials to be used by the plugin.

protocols string[]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]

route GatewayPluginSolaceLogRoute

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 GatewayPluginSolaceLogService

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 GatewayPluginSolaceLogConfigArgs

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_log_id str

A string representing a UUID (universally unique identifier).

instance_name str

A unique string representing a UTF-8 encoded name.

ordering GatewayPluginSolaceLogOrderingArgs

partials Sequence[GatewayPluginSolaceLogPartialArgs]

A list of partials to be used by the plugin.

protocols Sequence[str]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]

route GatewayPluginSolaceLogRouteArgs

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 GatewayPluginSolaceLogServiceArgs

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

gatewayPluginSolaceLogId 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 list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]

route Property Map

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service Property Map

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

tags List<String>

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

updatedAt Number

Unix epoch when the resource was last updated.

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

Message GatewayPluginSolaceLogConfigMessage

The log message related configuration.

Session GatewayPluginSolaceLogConfigSession

Session related configuration.

Message GatewayPluginSolaceLogConfigMessage

The log message related configuration.

Session GatewayPluginSolaceLogConfigSession

Session related configuration.

message GatewayPluginSolaceLogConfigMessage

The log message related configuration.

session GatewayPluginSolaceLogConfigSession

Session related configuration.

message GatewayPluginSolaceLogConfigMessage

The log message related configuration.

session GatewayPluginSolaceLogConfigSession

Session related configuration.

message GatewayPluginSolaceLogConfigMessage

The log message related configuration.

session GatewayPluginSolaceLogConfigSession

Session related configuration.

message Property Map

The log message related configuration.

session Property Map

Session related configuration.

Destinations List<GatewayPluginSolaceLogConfigMessageDestination>

The log message destinations.

AckTimeout double

When using a non-DIRECT guaranteed delivery mode, this property sets the log message acknowledgement timeout (waiting time). Default: 2000

CustomFieldsByLua Dictionary<string, string>

A key-value map that dynamically modifies log fields using Lua code.

DeliveryMode string

Sets the log message delivery mode. Default: "DIRECT"; must be one of ["DIRECT", "PERSISTENT"]

DmqEligible bool

Sets the dead message queue (DMQ) eligible property on the log message. Default: false

Priority double

Sets the log message priority. Default: 4

SenderId string

Allows the application to set the sender identifier.

Tracing bool

Enable or disable the tracing. This is primarily used for distributed tracing and log message correlation, especially in debugging or tracking log message flows across multiple systems. Default: false

TracingSampled bool

Indicates whether the log message should be included in distributed tracing (i.e., if it should be "sampled" for the tracing). Default: false

Ttl double

Sets the time to live (TTL) in milliseconds for the log message. Setting the time to live to zero disables the TTL for the log message. Default: 0

Destinations []GatewayPluginSolaceLogConfigMessageDestination

The log message destinations.

AckTimeout float64

When using a non-DIRECT guaranteed delivery mode, this property sets the log message acknowledgement timeout (waiting time). Default: 2000

CustomFieldsByLua map[string]string

A key-value map that dynamically modifies log fields using Lua code.

DeliveryMode string

Sets the log message delivery mode. Default: "DIRECT"; must be one of ["DIRECT", "PERSISTENT"]

DmqEligible bool

Sets the dead message queue (DMQ) eligible property on the log message. Default: false

Priority float64

Sets the log message priority. Default: 4

SenderId string

Allows the application to set the sender identifier.

Tracing bool

Enable or disable the tracing. This is primarily used for distributed tracing and log message correlation, especially in debugging or tracking log message flows across multiple systems. Default: false

TracingSampled bool

Indicates whether the log message should be included in distributed tracing (i.e., if it should be "sampled" for the tracing). Default: false

Ttl float64

Sets the time to live (TTL) in milliseconds for the log message. Setting the time to live to zero disables the TTL for the log message. Default: 0

destinations List<GatewayPluginSolaceLogConfigMessageDestination>

The log message destinations.

ackTimeout Double

When using a non-DIRECT guaranteed delivery mode, this property sets the log message acknowledgement timeout (waiting time). Default: 2000

customFieldsByLua Map<String,String>

A key-value map that dynamically modifies log fields using Lua code.

deliveryMode String

Sets the log message delivery mode. Default: "DIRECT"; must be one of ["DIRECT", "PERSISTENT"]

dmqEligible Boolean

Sets the dead message queue (DMQ) eligible property on the log message. Default: false

priority Double

Sets the log message priority. Default: 4

senderId String

Allows the application to set the sender identifier.

tracing Boolean

Enable or disable the tracing. This is primarily used for distributed tracing and log message correlation, especially in debugging or tracking log message flows across multiple systems. Default: false

tracingSampled Boolean

Indicates whether the log message should be included in distributed tracing (i.e., if it should be "sampled" for the tracing). Default: false

ttl Double

Sets the time to live (TTL) in milliseconds for the log message. Setting the time to live to zero disables the TTL for the log message. Default: 0

destinations GatewayPluginSolaceLogConfigMessageDestination[]

The log message destinations.

ackTimeout number

When using a non-DIRECT guaranteed delivery mode, this property sets the log message acknowledgement timeout (waiting time). Default: 2000

customFieldsByLua {[key: string]: string}

A key-value map that dynamically modifies log fields using Lua code.

deliveryMode string

Sets the log message delivery mode. Default: "DIRECT"; must be one of ["DIRECT", "PERSISTENT"]

dmqEligible boolean

Sets the dead message queue (DMQ) eligible property on the log message. Default: false

priority number

Sets the log message priority. Default: 4

senderId string

Allows the application to set the sender identifier.

tracing boolean

Enable or disable the tracing. This is primarily used for distributed tracing and log message correlation, especially in debugging or tracking log message flows across multiple systems. Default: false

tracingSampled boolean

Indicates whether the log message should be included in distributed tracing (i.e., if it should be "sampled" for the tracing). Default: false

ttl number

Sets the time to live (TTL) in milliseconds for the log message. Setting the time to live to zero disables the TTL for the log message. Default: 0

destinations Sequence[GatewayPluginSolaceLogConfigMessageDestination]

The log message destinations.

ack_timeout float

When using a non-DIRECT guaranteed delivery mode, this property sets the log message acknowledgement timeout (waiting time). Default: 2000

custom_fields_by_lua Mapping[str, str]

A key-value map that dynamically modifies log fields using Lua code.

delivery_mode str

Sets the log message delivery mode. Default: "DIRECT"; must be one of ["DIRECT", "PERSISTENT"]

dmq_eligible bool

Sets the dead message queue (DMQ) eligible property on the log message. Default: false

priority float

Sets the log message priority. Default: 4

sender_id str

Allows the application to set the sender identifier.

tracing bool

Enable or disable the tracing. This is primarily used for distributed tracing and log message correlation, especially in debugging or tracking log message flows across multiple systems. Default: false

tracing_sampled bool

Indicates whether the log message should be included in distributed tracing (i.e., if it should be "sampled" for the tracing). Default: false

ttl float

Sets the time to live (TTL) in milliseconds for the log message. Setting the time to live to zero disables the TTL for the log message. Default: 0

destinations List<Property Map>

The log message destinations.

ackTimeout Number

When using a non-DIRECT guaranteed delivery mode, this property sets the log message acknowledgement timeout (waiting time). Default: 2000

customFieldsByLua Map<String>

A key-value map that dynamically modifies log fields using Lua code.

deliveryMode String

Sets the log message delivery mode. Default: "DIRECT"; must be one of ["DIRECT", "PERSISTENT"]

dmqEligible Boolean

Sets the dead message queue (DMQ) eligible property on the log message. Default: false

priority Number

Sets the log message priority. Default: 4

senderId String

Allows the application to set the sender identifier.

tracing Boolean

Enable or disable the tracing. This is primarily used for distributed tracing and log message correlation, especially in debugging or tracking log message flows across multiple systems. Default: false

tracingSampled Boolean

Indicates whether the log message should be included in distributed tracing (i.e., if it should be "sampled" for the tracing). Default: false

ttl Number

Sets the time to live (TTL) in milliseconds for the log message. Setting the time to live to zero disables the TTL for the log message. Default: 0

Name string

The name of the destination. You can use $(uri_captures['<capture-identifier>']) in this field to capture the name from a regex request URI (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 the destination. Default: "QUEUE"; must be one of ["QUEUE", "TOPIC"]

Name string

The name of the destination. You can use $(uri_captures['<capture-identifier>']) in this field to capture the name from a regex request URI (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 the destination. Default: "QUEUE"; must be one of ["QUEUE", "TOPIC"]

name String

The name of the destination. You can use $(uri_captures['<capture-identifier>']) in this field to capture the name from a regex request URI (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 the destination. Default: "QUEUE"; must be one of ["QUEUE", "TOPIC"]

name string

The name of the destination. You can use $(uri_captures['<capture-identifier>']) in this field to capture the name from a regex request URI (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 the destination. Default: "QUEUE"; must be one of ["QUEUE", "TOPIC"]

name str

The name of the destination. You can use $(uri_captures['<capture-identifier>']) in this field to capture the name from a regex request URI (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 the destination. Default: "QUEUE"; must be one of ["QUEUE", "TOPIC"]

name String

The name of the destination. You can use $(uri_captures['<capture-identifier>']) in this field to capture the name from a regex request URI (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 the destination. Default: "QUEUE"; must be one of ["QUEUE", "TOPIC"]

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 GatewayPluginSolaceLogConfigSessionAuthentication

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 GatewayPluginSolaceLogConfigSessionAuthentication

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 GatewayPluginSolaceLogConfigSessionAuthentication

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 GatewayPluginSolaceLogConfigSessionAuthentication

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 GatewayPluginSolaceLogConfigSessionAuthentication

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.

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.