Class LbStickinessPolicy


  • public class LbStickinessPolicy
    extends com.pulumi.resources.CustomResource
    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
     
     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.ArrayList;
     import java.util.Arrays;
     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());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import `aws.lightsail.LbStickinessPolicy` using the `lbName` attribute. For example: ```sh $ pulumi import aws:lightsail/lbStickinessPolicy:LbStickinessPolicy example example-load-balancer ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.Integer> cookieDuration()  
      com.pulumi.core.Output<java.lang.Boolean> enabled()  
      static LbStickinessPolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, LbStickinessPolicyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lbName()  
      com.pulumi.core.Output<java.lang.String> region()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • LbStickinessPolicy

        public LbStickinessPolicy​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • LbStickinessPolicy

        public LbStickinessPolicy​(java.lang.String name,
                                  LbStickinessPolicyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • LbStickinessPolicy

        public LbStickinessPolicy​(java.lang.String name,
                                  LbStickinessPolicyArgs args,
                                  @Nullable
                                  com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • cookieDuration

        public com.pulumi.core.Output<java.lang.Integer> cookieDuration()
        Returns:
        Cookie duration in seconds. This determines the length of the session stickiness.
      • enabled

        public com.pulumi.core.Output<java.lang.Boolean> enabled()
        Returns:
        Whether to enable session stickiness for the load balancer.
      • lbName

        public com.pulumi.core.Output<java.lang.String> lbName()
        Returns:
        Name of the load balancer to which you want to enable session stickiness. The following arguments are optional:
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • get

        public static LbStickinessPolicy get​(java.lang.String name,
                                             com.pulumi.core.Output<java.lang.String> id,
                                             @Nullable
                                             LbStickinessPolicyState state,
                                             @Nullable
                                             com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.