konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.getGatewayPluginSession

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

Using getGatewayPluginSession

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getGatewayPluginSession(args: GetGatewayPluginSessionArgs, opts?: InvokeOptions): Promise<GetGatewayPluginSessionResult>
function getGatewayPluginSessionOutput(args: GetGatewayPluginSessionOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginSessionResult>

def get_gateway_plugin_session(control_plane_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetGatewayPluginSessionResult
def get_gateway_plugin_session_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginSessionResult]

func LookupGatewayPluginSession(ctx *Context, args *LookupGatewayPluginSessionArgs, opts ...InvokeOption) (*LookupGatewayPluginSessionResult, error)
func LookupGatewayPluginSessionOutput(ctx *Context, args *LookupGatewayPluginSessionOutputArgs, opts ...InvokeOption) LookupGatewayPluginSessionResultOutput

> Note: This function is named LookupGatewayPluginSession in the Go SDK.

public static class GetGatewayPluginSession 
{
    public static Task<GetGatewayPluginSessionResult> InvokeAsync(GetGatewayPluginSessionArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginSessionResult> Invoke(GetGatewayPluginSessionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginSessionResult> getGatewayPluginSession(GetGatewayPluginSessionArgs args, InvokeOptions options)
public static Output<GetGatewayPluginSessionResult> getGatewayPluginSession(GetGatewayPluginSessionArgs args, InvokeOptions options)

fn::invoke:
  function: konnect:index/getGatewayPluginSession:getGatewayPluginSession
  arguments:
    # arguments dictionary

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginSession Result

The following output properties are available:

Config GetGatewayPluginSessionConfig
ControlPlaneId string
CreatedAt double
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginSessionOrdering
Protocols List<string>
Route GetGatewayPluginSessionRoute
Service GetGatewayPluginSessionService
Tags List<string>
UpdatedAt double

Config GetGatewayPluginSessionConfig
ControlPlaneId string
CreatedAt float64
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginSessionOrdering
Protocols []string
Route GetGatewayPluginSessionRoute
Service GetGatewayPluginSessionService
Tags []string
UpdatedAt float64

config GetGatewayPluginSessionConfig
controlPlaneId String
createdAt Double
enabled Boolean
id String
instanceName String
ordering GetGatewayPluginSessionOrdering
protocols List<String>
route GetGatewayPluginSessionRoute
service GetGatewayPluginSessionService
tags List<String>
updatedAt Double

config GetGatewayPluginSessionConfig
controlPlaneId string
createdAt number
enabled boolean
id string
instanceName string
ordering GetGatewayPluginSessionOrdering
protocols string[]
route GetGatewayPluginSessionRoute
service GetGatewayPluginSessionService
tags string[]
updatedAt number

config GetGatewayPluginSessionConfig
control_plane_id str
created_at float
enabled bool
id str
instance_name str
ordering GetGatewayPluginSessionOrdering
protocols Sequence[str]
route GetGatewayPluginSessionRoute
service GetGatewayPluginSessionService
tags Sequence[str]
updated_at float

config Property Map
controlPlaneId String
createdAt Number
enabled Boolean
id String
instanceName String
ordering Property Map
protocols List<String>
route Property Map
service Property Map
tags List<String>
updatedAt Number

Supporting Types

GetGatewayPluginSessionConfig

AbsoluteTimeout double: The session cookie absolute timeout, in seconds. Specifies how long the session can be used until it is no longer valid.
Audience string: The session audience, which is the intended target application. For example "my-application".
CookieDomain string: The domain with which the cookie is intended to be exchanged.
CookieHttpOnly bool: Applies the HttpOnly tag so that the cookie is sent only to a server.
CookieName string: The name of the cookie.
CookiePath string: The resource in the host where the cookie is available.
CookieSameSite string: Determines whether and how a cookie may be sent with cross-site requests.
CookieSecure bool: Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol.
IdlingTimeout double: The session cookie idle time, in seconds.
LogoutMethods List<string>: A set of HTTP methods that the plugin will respond to.
LogoutPostArg string: The POST argument passed to logout requests. Do not change this property.
LogoutQueryArg string: The query argument passed to logout requests.
ReadBodyForLogout bool
Remember bool: Enables or disables persistent sessions.
RememberAbsoluteTimeout double: The persistent session absolute timeout limit, in seconds.
RememberCookieName string: Persistent session cookie name. Use with the remember configuration parameter.
RememberRollingTimeout double: The persistent session rolling timeout window, in seconds.
RequestHeaders List<string>: List of information to include, as headers, in the response to the downstream.
ResponseHeaders List<string>: List of information to include, as headers, in the response to the downstream.
RollingTimeout double: The session cookie rolling timeout, in seconds. Specifies how long the session can be used until it needs to be renewed.
Secret string: The secret that is used in keyed HMAC generation.
StaleTtl double: The duration, in seconds, after which an old cookie is discarded, starting from the moment when the session becomes outdated and is replaced by a new one.
Storage string: Determines where the session data is stored. kong: Stores encrypted session data into Kong's current database strategy; the cookie will not contain any session data. cookie: Stores encrypted session data within the cookie itself.

AbsoluteTimeout float64: The session cookie absolute timeout, in seconds. Specifies how long the session can be used until it is no longer valid.
Audience string: The session audience, which is the intended target application. For example "my-application".
CookieDomain string: The domain with which the cookie is intended to be exchanged.
CookieHttpOnly bool: Applies the HttpOnly tag so that the cookie is sent only to a server.
CookieName string: The name of the cookie.
CookiePath string: The resource in the host where the cookie is available.
CookieSameSite string: Determines whether and how a cookie may be sent with cross-site requests.
CookieSecure bool: Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol.
IdlingTimeout float64: The session cookie idle time, in seconds.
LogoutMethods []string: A set of HTTP methods that the plugin will respond to.
LogoutPostArg string: The POST argument passed to logout requests. Do not change this property.
LogoutQueryArg string: The query argument passed to logout requests.
ReadBodyForLogout bool
Remember bool: Enables or disables persistent sessions.
RememberAbsoluteTimeout float64: The persistent session absolute timeout limit, in seconds.
RememberCookieName string: Persistent session cookie name. Use with the remember configuration parameter.
RememberRollingTimeout float64: The persistent session rolling timeout window, in seconds.
RequestHeaders []string: List of information to include, as headers, in the response to the downstream.
ResponseHeaders []string: List of information to include, as headers, in the response to the downstream.
RollingTimeout float64: The session cookie rolling timeout, in seconds. Specifies how long the session can be used until it needs to be renewed.
Secret string: The secret that is used in keyed HMAC generation.
StaleTtl float64: The duration, in seconds, after which an old cookie is discarded, starting from the moment when the session becomes outdated and is replaced by a new one.
Storage string: Determines where the session data is stored. kong: Stores encrypted session data into Kong's current database strategy; the cookie will not contain any session data. cookie: Stores encrypted session data within the cookie itself.

absoluteTimeout Double: The session cookie absolute timeout, in seconds. Specifies how long the session can be used until it is no longer valid.
audience String: The session audience, which is the intended target application. For example "my-application".
cookieDomain String: The domain with which the cookie is intended to be exchanged.
cookieHttpOnly Boolean: Applies the HttpOnly tag so that the cookie is sent only to a server.
cookieName String: The name of the cookie.
cookiePath String: The resource in the host where the cookie is available.
cookieSameSite String: Determines whether and how a cookie may be sent with cross-site requests.
cookieSecure Boolean: Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol.
idlingTimeout Double: The session cookie idle time, in seconds.
logoutMethods List<String>: A set of HTTP methods that the plugin will respond to.
logoutPostArg String: The POST argument passed to logout requests. Do not change this property.
logoutQueryArg String: The query argument passed to logout requests.
readBodyForLogout Boolean
remember Boolean: Enables or disables persistent sessions.
rememberAbsoluteTimeout Double: The persistent session absolute timeout limit, in seconds.
rememberCookieName String: Persistent session cookie name. Use with the remember configuration parameter.
rememberRollingTimeout Double: The persistent session rolling timeout window, in seconds.
requestHeaders List<String>: List of information to include, as headers, in the response to the downstream.
responseHeaders List<String>: List of information to include, as headers, in the response to the downstream.
rollingTimeout Double: The session cookie rolling timeout, in seconds. Specifies how long the session can be used until it needs to be renewed.
secret String: The secret that is used in keyed HMAC generation.
staleTtl Double: The duration, in seconds, after which an old cookie is discarded, starting from the moment when the session becomes outdated and is replaced by a new one.
storage String: Determines where the session data is stored. kong: Stores encrypted session data into Kong's current database strategy; the cookie will not contain any session data. cookie: Stores encrypted session data within the cookie itself.

absoluteTimeout number: The session cookie absolute timeout, in seconds. Specifies how long the session can be used until it is no longer valid.
audience string: The session audience, which is the intended target application. For example "my-application".
cookieDomain string: The domain with which the cookie is intended to be exchanged.
cookieHttpOnly boolean: Applies the HttpOnly tag so that the cookie is sent only to a server.
cookieName string: The name of the cookie.
cookiePath string: The resource in the host where the cookie is available.
cookieSameSite string: Determines whether and how a cookie may be sent with cross-site requests.
cookieSecure boolean: Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol.
idlingTimeout number: The session cookie idle time, in seconds.
logoutMethods string[]: A set of HTTP methods that the plugin will respond to.
logoutPostArg string: The POST argument passed to logout requests. Do not change this property.
logoutQueryArg string: The query argument passed to logout requests.
readBodyForLogout boolean
remember boolean: Enables or disables persistent sessions.
rememberAbsoluteTimeout number: The persistent session absolute timeout limit, in seconds.
rememberCookieName string: Persistent session cookie name. Use with the remember configuration parameter.
rememberRollingTimeout number: The persistent session rolling timeout window, in seconds.
requestHeaders string[]: List of information to include, as headers, in the response to the downstream.
responseHeaders string[]: List of information to include, as headers, in the response to the downstream.
rollingTimeout number: The session cookie rolling timeout, in seconds. Specifies how long the session can be used until it needs to be renewed.
secret string: The secret that is used in keyed HMAC generation.
staleTtl number: The duration, in seconds, after which an old cookie is discarded, starting from the moment when the session becomes outdated and is replaced by a new one.
storage string: Determines where the session data is stored. kong: Stores encrypted session data into Kong's current database strategy; the cookie will not contain any session data. cookie: Stores encrypted session data within the cookie itself.

absolute_timeout float: The session cookie absolute timeout, in seconds. Specifies how long the session can be used until it is no longer valid.
audience str: The session audience, which is the intended target application. For example "my-application".
cookie_domain str: The domain with which the cookie is intended to be exchanged.
cookie_http_only bool: Applies the HttpOnly tag so that the cookie is sent only to a server.
cookie_name str: The name of the cookie.
cookie_path str: The resource in the host where the cookie is available.
cookie_same_site str: Determines whether and how a cookie may be sent with cross-site requests.
cookie_secure bool: Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol.
idling_timeout float: The session cookie idle time, in seconds.
logout_methods Sequence[str]: A set of HTTP methods that the plugin will respond to.
logout_post_arg str: The POST argument passed to logout requests. Do not change this property.
logout_query_arg str: The query argument passed to logout requests.
read_body_for_logout bool
remember bool: Enables or disables persistent sessions.
remember_absolute_timeout float: The persistent session absolute timeout limit, in seconds.
remember_cookie_name str: Persistent session cookie name. Use with the remember configuration parameter.
remember_rolling_timeout float: The persistent session rolling timeout window, in seconds.
request_headers Sequence[str]: List of information to include, as headers, in the response to the downstream.
response_headers Sequence[str]: List of information to include, as headers, in the response to the downstream.
rolling_timeout float: The session cookie rolling timeout, in seconds. Specifies how long the session can be used until it needs to be renewed.
secret str: The secret that is used in keyed HMAC generation.
stale_ttl float: The duration, in seconds, after which an old cookie is discarded, starting from the moment when the session becomes outdated and is replaced by a new one.
storage str: Determines where the session data is stored. kong: Stores encrypted session data into Kong's current database strategy; the cookie will not contain any session data. cookie: Stores encrypted session data within the cookie itself.

absoluteTimeout Number: The session cookie absolute timeout, in seconds. Specifies how long the session can be used until it is no longer valid.
audience String: The session audience, which is the intended target application. For example "my-application".
cookieDomain String: The domain with which the cookie is intended to be exchanged.
cookieHttpOnly Boolean: Applies the HttpOnly tag so that the cookie is sent only to a server.
cookieName String: The name of the cookie.
cookiePath String: The resource in the host where the cookie is available.
cookieSameSite String: Determines whether and how a cookie may be sent with cross-site requests.
cookieSecure Boolean: Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol.
idlingTimeout Number: The session cookie idle time, in seconds.
logoutMethods List<String>: A set of HTTP methods that the plugin will respond to.
logoutPostArg String: The POST argument passed to logout requests. Do not change this property.
logoutQueryArg String: The query argument passed to logout requests.
readBodyForLogout Boolean
remember Boolean: Enables or disables persistent sessions.
rememberAbsoluteTimeout Number: The persistent session absolute timeout limit, in seconds.
rememberCookieName String: Persistent session cookie name. Use with the remember configuration parameter.
rememberRollingTimeout Number: The persistent session rolling timeout window, in seconds.
requestHeaders List<String>: List of information to include, as headers, in the response to the downstream.
responseHeaders List<String>: List of information to include, as headers, in the response to the downstream.
rollingTimeout Number: The session cookie rolling timeout, in seconds. Specifies how long the session can be used until it needs to be renewed.
secret String: The secret that is used in keyed HMAC generation.
staleTtl Number: The duration, in seconds, after which an old cookie is discarded, starting from the moment when the session becomes outdated and is replaced by a new one.
storage String: Determines where the session data is stored. kong: Stores encrypted session data into Kong's current database strategy; the cookie will not contain any session data. cookie: Stores encrypted session data within the cookie itself.

GetGatewayPluginSessionOrdering

After GetGatewayPluginSessionOrderingAfter
Before GetGatewayPluginSessionOrderingBefore

After GetGatewayPluginSessionOrderingAfter
Before GetGatewayPluginSessionOrderingBefore

after GetGatewayPluginSessionOrderingAfter
before GetGatewayPluginSessionOrderingBefore

after GetGatewayPluginSessionOrderingAfter
before GetGatewayPluginSessionOrderingBefore

after GetGatewayPluginSessionOrderingAfter
before GetGatewayPluginSessionOrderingBefore

after Property Map
before Property Map

GetGatewayPluginSessionOrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginSessionOrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginSessionRoute

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginSessionService

Id string

Id string

id String

id string

id str

id String

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayPluginSession

On this page

On this page

Using getGatewayPluginSession

getGatewayPluginSession Result

Supporting Types

GetGatewayPluginSessionConfig

GetGatewayPluginSessionOrdering

GetGatewayPluginSessionOrderingAfter

GetGatewayPluginSessionOrderingBefore

GetGatewayPluginSessionRoute

GetGatewayPluginSessionService

Package Details

On this page

On this page