Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. lightsail
  5. LbStickinessPolicy
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

aws.lightsail.LbStickinessPolicy

Explore with Pulumi AI

aws logo
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

    Manages session stickiness for a Lightsail Load Balancer.

    Use this resource to configure session stickiness to ensure that user sessions are consistently routed to the same backend instance. This helps maintain session state for applications that store session data locally on the server.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lightsail.Lb("example", {
    name: "example-load-balancer",
    healthCheckPath: "/",
    instancePort: 80,
    tags: {
        foo: "bar",
    },
});
const exampleLbStickinessPolicy = new aws.lightsail.LbStickinessPolicy("example", {
    lbName: example.name,
    cookieDuration: 900,
    enabled: true,
});

    import pulumi
import pulumi_aws as aws

example = aws.lightsail.Lb("example",
    name="example-load-balancer",
    health_check_path="/",
    instance_port=80,
    tags={
        "foo": "bar",
    })
example_lb_stickiness_policy = aws.lightsail.LbStickinessPolicy("example",
    lb_name=example.name,
    cookie_duration=900,
    enabled=True)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lightsail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := lightsail.NewLb(ctx, "example", &lightsail.LbArgs{
			Name:            pulumi.String("example-load-balancer"),
			HealthCheckPath: pulumi.String("/"),
			InstancePort:    pulumi.Int(80),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		_, err = lightsail.NewLbStickinessPolicy(ctx, "example", &lightsail.LbStickinessPolicyArgs{
			LbName:         example.Name,
			CookieDuration: pulumi.Int(900),
			Enabled:        pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.LightSail.Lb("example", new()
    {
        Name = "example-load-balancer",
        HealthCheckPath = "/",
        InstancePort = 80,
        Tags = 
        {
            { "foo", "bar" },
        },
    });

    var exampleLbStickinessPolicy = new Aws.LightSail.LbStickinessPolicy("example", new()
    {
        LbName = example.Name,
        CookieDuration = 900,
        Enabled = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Lb;
import com.pulumi.aws.lightsail.LbArgs;
import com.pulumi.aws.lightsail.LbStickinessPolicy;
import com.pulumi.aws.lightsail.LbStickinessPolicyArgs;
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 example = new Lb("example", LbArgs.builder()
            .name("example-load-balancer")
            .healthCheckPath("/")
            .instancePort(80)
            .tags(Map.of("foo", "bar"))
            .build());

        var exampleLbStickinessPolicy = new LbStickinessPolicy("exampleLbStickinessPolicy", LbStickinessPolicyArgs.builder()
            .lbName(example.name())
            .cookieDuration(900)
            .enabled(true)
            .build());

    }
}

    resources:
  example:
    type: aws:lightsail:Lb
    properties:
      name: example-load-balancer
      healthCheckPath: /
      instancePort: '80'
      tags:
        foo: bar
  exampleLbStickinessPolicy:
    type: aws:lightsail:LbStickinessPolicy
    name: example
    properties:
      lbName: ${example.name}
      cookieDuration: 900
      enabled: true

    Create LbStickinessPolicy Resource

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

    Constructor syntax

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

@overload
def LbStickinessPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cookie_duration: Optional[int] = None,
                       enabled: Optional[bool] = None,
                       lb_name: Optional[str] = None)
    func NewLbStickinessPolicy(ctx *Context, name string, args LbStickinessPolicyArgs, opts ...ResourceOption) (*LbStickinessPolicy, error)
    public LbStickinessPolicy(string name, LbStickinessPolicyArgs args, CustomResourceOptions? opts = null)
    public LbStickinessPolicy(String name, LbStickinessPolicyArgs args)
public LbStickinessPolicy(String name, LbStickinessPolicyArgs args, CustomResourceOptions options)

    type: aws:lightsail:LbStickinessPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LbStickinessPolicyArgs
    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 LbStickinessPolicyArgs
    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 LbStickinessPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbStickinessPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbStickinessPolicyArgs
    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 lbStickinessPolicyResource = new Aws.LightSail.LbStickinessPolicy("lbStickinessPolicyResource", new()
{
    CookieDuration = 0,
    Enabled = false,
    LbName = "string",
});

    example, err := lightsail.NewLbStickinessPolicy(ctx, "lbStickinessPolicyResource", &lightsail.LbStickinessPolicyArgs{
	CookieDuration: pulumi.Int(0),
	Enabled:        pulumi.Bool(false),
	LbName:         pulumi.String("string"),
})

    var lbStickinessPolicyResource = new LbStickinessPolicy("lbStickinessPolicyResource", LbStickinessPolicyArgs.builder()
    .cookieDuration(0)
    .enabled(false)
    .lbName("string")
    .build());

    lb_stickiness_policy_resource = aws.lightsail.LbStickinessPolicy("lbStickinessPolicyResource",
    cookie_duration=0,
    enabled=False,
    lb_name="string")

    const lbStickinessPolicyResource = new aws.lightsail.LbStickinessPolicy("lbStickinessPolicyResource", {
    cookieDuration: 0,
    enabled: false,
    lbName: "string",
});

    type: aws:lightsail:LbStickinessPolicy
properties:
    cookieDuration: 0
    enabled: false
    lbName: string

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

    CookieDuration int
    Cookie duration in seconds. This determines the length of the session stickiness.
    Enabled bool
    Whether to enable session stickiness for the load balancer.
    LbName string
    Name of the load balancer to which you want to enable session stickiness.
    CookieDuration int
    Cookie duration in seconds. This determines the length of the session stickiness.
    Enabled bool
    Whether to enable session stickiness for the load balancer.
    LbName string
    Name of the load balancer to which you want to enable session stickiness.
    cookieDuration Integer
    Cookie duration in seconds. This determines the length of the session stickiness.
    enabled Boolean
    Whether to enable session stickiness for the load balancer.
    lbName String
    Name of the load balancer to which you want to enable session stickiness.
    cookieDuration number
    Cookie duration in seconds. This determines the length of the session stickiness.
    enabled boolean
    Whether to enable session stickiness for the load balancer.
    lbName string
    Name of the load balancer to which you want to enable session stickiness.
    cookie_duration int
    Cookie duration in seconds. This determines the length of the session stickiness.
    enabled bool
    Whether to enable session stickiness for the load balancer.
    lb_name str
    Name of the load balancer to which you want to enable session stickiness.
    cookieDuration Number
    Cookie duration in seconds. This determines the length of the session stickiness.
    enabled Boolean
    Whether to enable session stickiness for the load balancer.
    lbName String
    Name of the load balancer to which you want to enable session stickiness.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LbStickinessPolicy Resource

    Get an existing LbStickinessPolicy 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?: LbStickinessPolicyState, opts?: CustomResourceOptions): LbStickinessPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cookie_duration: Optional[int] = None,
        enabled: Optional[bool] = None,
        lb_name: Optional[str] = None) -> LbStickinessPolicy
    func GetLbStickinessPolicy(ctx *Context, name string, id IDInput, state *LbStickinessPolicyState, opts ...ResourceOption) (*LbStickinessPolicy, error)
    public static LbStickinessPolicy Get(string name, Input<string> id, LbStickinessPolicyState? state, CustomResourceOptions? opts = null)
    public static LbStickinessPolicy get(String name, Output<String> id, LbStickinessPolicyState state, CustomResourceOptions options)
    resources:  _:    type: aws:lightsail:LbStickinessPolicy    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CookieDuration int
    Cookie duration in seconds. This determines the length of the session stickiness.
    Enabled bool
    Whether to enable session stickiness for the load balancer.
    LbName string
    Name of the load balancer to which you want to enable session stickiness.
    CookieDuration int
    Cookie duration in seconds. This determines the length of the session stickiness.
    Enabled bool
    Whether to enable session stickiness for the load balancer.
    LbName string
    Name of the load balancer to which you want to enable session stickiness.
    cookieDuration Integer
    Cookie duration in seconds. This determines the length of the session stickiness.
    enabled Boolean
    Whether to enable session stickiness for the load balancer.
    lbName String
    Name of the load balancer to which you want to enable session stickiness.
    cookieDuration number
    Cookie duration in seconds. This determines the length of the session stickiness.
    enabled boolean
    Whether to enable session stickiness for the load balancer.
    lbName string
    Name of the load balancer to which you want to enable session stickiness.
    cookie_duration int
    Cookie duration in seconds. This determines the length of the session stickiness.
    enabled bool
    Whether to enable session stickiness for the load balancer.
    lb_name str
    Name of the load balancer to which you want to enable session stickiness.
    cookieDuration Number
    Cookie duration in seconds. This determines the length of the session stickiness.
    enabled Boolean
    Whether to enable session stickiness for the load balancer.
    lbName String
    Name of the load balancer to which you want to enable session stickiness.

    Import

    Using pulumi import, import aws_lightsail_lb_stickiness_policy using the lb_name attribute. For example:

    $ pulumi import aws:lightsail/lbStickinessPolicy:LbStickinessPolicy example example-load-balancer

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws