1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginSession
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayPluginSession

Explore with Pulumi AI

GatewayPluginSession Resource

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginSession;
import com.pulumi.konnect.GatewayPluginSessionArgs;
import com.pulumi.konnect.inputs.GatewayPluginSessionConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginSessionOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginSessionOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginSessionOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginSessionRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginSessionServiceArgs;
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 myGatewaypluginsession = new GatewayPluginSession("myGatewaypluginsession", GatewayPluginSessionArgs.builder()
            .config(GatewayPluginSessionConfigArgs.builder()
                .absolute_timeout(1.93)
                .audience("...my_audience...")
                .cookie_domain("...my_cookie_domain...")
                .cookie_http_only(true)
                .cookie_name("...my_cookie_name...")
                .cookie_path("...my_cookie_path...")
                .cookie_same_site("Strict")
                .cookie_secure(true)
                .idling_timeout(6.27)
                .logout_methods("GET")
                .logout_post_arg("...my_logout_post_arg...")
                .logout_query_arg("...my_logout_query_arg...")
                .read_body_for_logout(true)
                .remember(false)
                .remember_absolute_timeout(7.47)
                .remember_cookie_name("...my_remember_cookie_name...")
                .remember_rolling_timeout(6.77)
                .request_headers("idling-timeout")
                .response_headers("audience")
                .rolling_timeout(9.29)
                .secret("...my_secret...")
                .stale_ttl(3.88)
                .storage("cookie")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginSessionId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginSessionOrderingArgs.builder()
                .after(GatewayPluginSessionOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginSessionOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("wss")
            .route(GatewayPluginSessionRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginSessionServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}
Copy
resources:
  myGatewaypluginsession:
    type: konnect:GatewayPluginSession
    properties:
      config:
        absolute_timeout: 1.93
        audience: '...my_audience...'
        cookie_domain: '...my_cookie_domain...'
        cookie_http_only: true
        cookie_name: '...my_cookie_name...'
        cookie_path: '...my_cookie_path...'
        cookie_same_site: Strict
        cookie_secure: true
        idling_timeout: 6.27
        logout_methods:
          - GET
        logout_post_arg: '...my_logout_post_arg...'
        logout_query_arg: '...my_logout_query_arg...'
        read_body_for_logout: true
        remember: false
        remember_absolute_timeout: 7.47
        remember_cookie_name: '...my_remember_cookie_name...'
        remember_rolling_timeout: 6.77
        request_headers:
          - idling-timeout
        response_headers:
          - audience
        rolling_timeout: 9.29
        secret: '...my_secret...'
        stale_ttl: 3.88
        storage: cookie
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginSessionId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - wss
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
Copy

Create GatewayPluginSession Resource

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

Constructor syntax

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

@overload
def GatewayPluginSession(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         config: Optional[GatewayPluginSessionConfigArgs] = None,
                         control_plane_id: Optional[str] = None,
                         enabled: Optional[bool] = None,
                         gateway_plugin_session_id: Optional[str] = None,
                         instance_name: Optional[str] = None,
                         ordering: Optional[GatewayPluginSessionOrderingArgs] = None,
                         protocols: Optional[Sequence[str]] = None,
                         route: Optional[GatewayPluginSessionRouteArgs] = None,
                         service: Optional[GatewayPluginSessionServiceArgs] = None,
                         tags: Optional[Sequence[str]] = None)
func NewGatewayPluginSession(ctx *Context, name string, args GatewayPluginSessionArgs, opts ...ResourceOption) (*GatewayPluginSession, error)
public GatewayPluginSession(string name, GatewayPluginSessionArgs args, CustomResourceOptions? opts = null)
public GatewayPluginSession(String name, GatewayPluginSessionArgs args)
public GatewayPluginSession(String name, GatewayPluginSessionArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginSession
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginSessionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayPluginSessionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginSessionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginSessionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayPluginSessionArgs
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 gatewayPluginSessionResource = new Konnect.GatewayPluginSession("gatewayPluginSessionResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginSessionConfigArgs
    {
        AbsoluteTimeout = 0,
        Audience = "string",
        CookieDomain = "string",
        CookieHttpOnly = false,
        CookieName = "string",
        CookiePath = "string",
        CookieSameSite = "string",
        CookieSecure = false,
        IdlingTimeout = 0,
        LogoutMethods = new[]
        {
            "string",
        },
        LogoutPostArg = "string",
        LogoutQueryArg = "string",
        ReadBodyForLogout = false,
        Remember = false,
        RememberAbsoluteTimeout = 0,
        RememberCookieName = "string",
        RememberRollingTimeout = 0,
        RequestHeaders = new[]
        {
            "string",
        },
        ResponseHeaders = new[]
        {
            "string",
        },
        RollingTimeout = 0,
        Secret = "string",
        StaleTtl = 0,
        Storage = "string",
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginSessionId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginSessionOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginSessionOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginSessionOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginSessionRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginSessionServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayPluginSession(ctx, "gatewayPluginSessionResource", &konnect.GatewayPluginSessionArgs{
Config: &.GatewayPluginSessionConfigArgs{
AbsoluteTimeout: pulumi.Float64(0),
Audience: pulumi.String("string"),
CookieDomain: pulumi.String("string"),
CookieHttpOnly: pulumi.Bool(false),
CookieName: pulumi.String("string"),
CookiePath: pulumi.String("string"),
CookieSameSite: pulumi.String("string"),
CookieSecure: pulumi.Bool(false),
IdlingTimeout: pulumi.Float64(0),
LogoutMethods: pulumi.StringArray{
pulumi.String("string"),
},
LogoutPostArg: pulumi.String("string"),
LogoutQueryArg: pulumi.String("string"),
ReadBodyForLogout: pulumi.Bool(false),
Remember: pulumi.Bool(false),
RememberAbsoluteTimeout: pulumi.Float64(0),
RememberCookieName: pulumi.String("string"),
RememberRollingTimeout: pulumi.Float64(0),
RequestHeaders: pulumi.StringArray{
pulumi.String("string"),
},
ResponseHeaders: pulumi.StringArray{
pulumi.String("string"),
},
RollingTimeout: pulumi.Float64(0),
Secret: pulumi.String("string"),
StaleTtl: pulumi.Float64(0),
Storage: pulumi.String("string"),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginSessionId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginSessionOrderingArgs{
After: &.GatewayPluginSessionOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginSessionOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginSessionRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginSessionServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayPluginSessionResource = new GatewayPluginSession("gatewayPluginSessionResource", GatewayPluginSessionArgs.builder()
    .config(GatewayPluginSessionConfigArgs.builder()
        .absoluteTimeout(0)
        .audience("string")
        .cookieDomain("string")
        .cookieHttpOnly(false)
        .cookieName("string")
        .cookiePath("string")
        .cookieSameSite("string")
        .cookieSecure(false)
        .idlingTimeout(0)
        .logoutMethods("string")
        .logoutPostArg("string")
        .logoutQueryArg("string")
        .readBodyForLogout(false)
        .remember(false)
        .rememberAbsoluteTimeout(0)
        .rememberCookieName("string")
        .rememberRollingTimeout(0)
        .requestHeaders("string")
        .responseHeaders("string")
        .rollingTimeout(0)
        .secret("string")
        .staleTtl(0)
        .storage("string")
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginSessionId("string")
    .instanceName("string")
    .ordering(GatewayPluginSessionOrderingArgs.builder()
        .after(GatewayPluginSessionOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginSessionOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginSessionRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginSessionServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());
Copy
gateway_plugin_session_resource = konnect.GatewayPluginSession("gatewayPluginSessionResource",
    config={
        "absolute_timeout": 0,
        "audience": "string",
        "cookie_domain": "string",
        "cookie_http_only": False,
        "cookie_name": "string",
        "cookie_path": "string",
        "cookie_same_site": "string",
        "cookie_secure": False,
        "idling_timeout": 0,
        "logout_methods": ["string"],
        "logout_post_arg": "string",
        "logout_query_arg": "string",
        "read_body_for_logout": False,
        "remember": False,
        "remember_absolute_timeout": 0,
        "remember_cookie_name": "string",
        "remember_rolling_timeout": 0,
        "request_headers": ["string"],
        "response_headers": ["string"],
        "rolling_timeout": 0,
        "secret": "string",
        "stale_ttl": 0,
        "storage": "string",
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_session_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])
Copy
const gatewayPluginSessionResource = new konnect.GatewayPluginSession("gatewayPluginSessionResource", {
    config: {
        absoluteTimeout: 0,
        audience: "string",
        cookieDomain: "string",
        cookieHttpOnly: false,
        cookieName: "string",
        cookiePath: "string",
        cookieSameSite: "string",
        cookieSecure: false,
        idlingTimeout: 0,
        logoutMethods: ["string"],
        logoutPostArg: "string",
        logoutQueryArg: "string",
        readBodyForLogout: false,
        remember: false,
        rememberAbsoluteTimeout: 0,
        rememberCookieName: "string",
        rememberRollingTimeout: 0,
        requestHeaders: ["string"],
        responseHeaders: ["string"],
        rollingTimeout: 0,
        secret: "string",
        staleTtl: 0,
        storage: "string",
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginSessionId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});
Copy
type: konnect:GatewayPluginSession
properties:
    config:
        absoluteTimeout: 0
        audience: string
        cookieDomain: string
        cookieHttpOnly: false
        cookieName: string
        cookiePath: string
        cookieSameSite: string
        cookieSecure: false
        idlingTimeout: 0
        logoutMethods:
            - string
        logoutPostArg: string
        logoutQueryArg: string
        readBodyForLogout: false
        remember: false
        rememberAbsoluteTimeout: 0
        rememberCookieName: string
        rememberRollingTimeout: 0
        requestHeaders:
            - string
        responseHeaders:
            - string
        rollingTimeout: 0
        secret: string
        staleTtl: 0
        storage: string
    controlPlaneId: string
    enabled: false
    gatewayPluginSessionId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
Copy

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

Config This property is required. GatewayPluginSessionConfig
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool
Whether the plugin is applied.
GatewayPluginSessionId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginSessionOrdering
Protocols List<string>
A set of strings representing protocols.
Route GatewayPluginSessionRoute
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 GatewayPluginSessionService
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.
Config This property is required. GatewayPluginSessionConfigArgs
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool
Whether the plugin is applied.
GatewayPluginSessionId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginSessionOrderingArgs
Protocols []string
A set of strings representing protocols.
Route GatewayPluginSessionRouteArgs
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 GatewayPluginSessionServiceArgs
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.
config This property is required. GatewayPluginSessionConfig
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean
Whether the plugin is applied.
gatewayPluginSessionId String
The ID of this resource.
instanceName String
ordering GatewayPluginSessionOrdering
protocols List<String>
A set of strings representing protocols.
route GatewayPluginSessionRoute
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 GatewayPluginSessionService
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.
config This property is required. GatewayPluginSessionConfig
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled boolean
Whether the plugin is applied.
gatewayPluginSessionId string
The ID of this resource.
instanceName string
ordering GatewayPluginSessionOrdering
protocols string[]
A set of strings representing protocols.
route GatewayPluginSessionRoute
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 GatewayPluginSessionService
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.
config This property is required. GatewayPluginSessionConfigArgs
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled bool
Whether the plugin is applied.
gateway_plugin_session_id str
The ID of this resource.
instance_name str
ordering GatewayPluginSessionOrderingArgs
protocols Sequence[str]
A set of strings representing protocols.
route GatewayPluginSessionRouteArgs
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 GatewayPluginSessionServiceArgs
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.
config This property is required. Property Map
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean
Whether the plugin is applied.
gatewayPluginSessionId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing protocols.
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayPluginSession resource produces the following output properties:

CreatedAt double
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt double
Unix epoch when the resource was last updated.
CreatedAt float64
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt float64
Unix epoch when the resource was last updated.
createdAt Double
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt Double
Unix epoch when the resource was last updated.
createdAt number
Unix epoch when the resource was created.
id string
The provider-assigned unique ID for this managed resource.
updatedAt number
Unix epoch when the resource was last updated.
created_at float
Unix epoch when the resource was created.
id str
The provider-assigned unique ID for this managed resource.
updated_at float
Unix epoch when the resource was last updated.
createdAt Number
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt Number
Unix epoch when the resource was last updated.

Look up Existing GatewayPluginSession Resource

Get an existing GatewayPluginSession 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?: GatewayPluginSessionState, opts?: CustomResourceOptions): GatewayPluginSession
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginSessionConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_session_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginSessionOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginSessionRouteArgs] = None,
        service: Optional[GatewayPluginSessionServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginSession
func GetGatewayPluginSession(ctx *Context, name string, id IDInput, state *GatewayPluginSessionState, opts ...ResourceOption) (*GatewayPluginSession, error)
public static GatewayPluginSession Get(string name, Input<string> id, GatewayPluginSessionState? state, CustomResourceOptions? opts = null)
public static GatewayPluginSession get(String name, Output<String> id, GatewayPluginSessionState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayPluginSession    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 GatewayPluginSessionConfig
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.
GatewayPluginSessionId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginSessionOrdering
Protocols List<string>
A set of strings representing protocols.
Route GatewayPluginSessionRoute
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 GatewayPluginSessionService
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 GatewayPluginSessionConfigArgs
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.
GatewayPluginSessionId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginSessionOrderingArgs
Protocols []string
A set of strings representing protocols.
Route GatewayPluginSessionRouteArgs
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 GatewayPluginSessionServiceArgs
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 GatewayPluginSessionConfig
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.
gatewayPluginSessionId String
The ID of this resource.
instanceName String
ordering GatewayPluginSessionOrdering
protocols List<String>
A set of strings representing protocols.
route GatewayPluginSessionRoute
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 GatewayPluginSessionService
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 GatewayPluginSessionConfig
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.
gatewayPluginSessionId string
The ID of this resource.
instanceName string
ordering GatewayPluginSessionOrdering
protocols string[]
A set of strings representing protocols.
route GatewayPluginSessionRoute
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 GatewayPluginSessionService
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 GatewayPluginSessionConfigArgs
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.
gateway_plugin_session_id str
The ID of this resource.
instance_name str
ordering GatewayPluginSessionOrderingArgs
protocols Sequence[str]
A set of strings representing protocols.
route GatewayPluginSessionRouteArgs
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 GatewayPluginSessionServiceArgs
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.
gatewayPluginSessionId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing protocols.
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

GatewayPluginSessionConfig
, GatewayPluginSessionConfigArgs

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. must be one of ["Default", "Lax", "None", "Strict"]
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. must be one of ["cookie", "kong"]
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. must be one of ["Default", "Lax", "None", "Strict"]
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. must be one of ["cookie", "kong"]
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. must be one of ["Default", "Lax", "None", "Strict"]
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. must be one of ["cookie", "kong"]
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. must be one of ["Default", "Lax", "None", "Strict"]
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. must be one of ["cookie", "kong"]
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. must be one of ["Default", "Lax", "None", "Strict"]
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. must be one of ["cookie", "kong"]
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. must be one of ["Default", "Lax", "None", "Strict"]
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. must be one of ["cookie", "kong"]

GatewayPluginSessionOrdering
, GatewayPluginSessionOrderingArgs

GatewayPluginSessionOrderingAfter
, GatewayPluginSessionOrderingAfterArgs

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

GatewayPluginSessionOrderingBefore
, GatewayPluginSessionOrderingBeforeArgs

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

GatewayPluginSessionRoute
, GatewayPluginSessionRouteArgs

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

GatewayPluginSessionService
, GatewayPluginSessionServiceArgs

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

Import

$ pulumi import konnect:index/gatewayPluginSession:GatewayPluginSession my_konnect_gateway_plugin_session "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
Copy

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.