1. Packages
  2. Bigip Provider
  3. API Docs
  4. ltm
  5. PersistenceProfileDstAddr
f5 BIG-IP v3.17.6 published on Monday, Oct 28, 2024 by Pulumi

f5bigip.ltm.PersistenceProfileDstAddr

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.6 published on Monday, Oct 28, 2024 by Pulumi

    Configures a cookie persistence profile

    Example

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const dstaddr = new f5bigip.ltm.PersistenceProfileDstAddr("dstaddr", {
        name: "/Common/terraform_ppdstaddr",
        defaultsFrom: "/Common/dest_addr",
        matchAcrossPools: "enabled",
        matchAcrossServices: "enabled",
        matchAcrossVirtuals: "enabled",
        mirror: "enabled",
        timeout: 3600,
        overrideConnLimit: "enabled",
        hashAlgorithm: "carp",
        mask: "255.255.255.255",
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    dstaddr = f5bigip.ltm.PersistenceProfileDstAddr("dstaddr",
        name="/Common/terraform_ppdstaddr",
        defaults_from="/Common/dest_addr",
        match_across_pools="enabled",
        match_across_services="enabled",
        match_across_virtuals="enabled",
        mirror="enabled",
        timeout=3600,
        override_conn_limit="enabled",
        hash_algorithm="carp",
        mask="255.255.255.255")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ltm.NewPersistenceProfileDstAddr(ctx, "dstaddr", &ltm.PersistenceProfileDstAddrArgs{
    			Name:                pulumi.String("/Common/terraform_ppdstaddr"),
    			DefaultsFrom:        pulumi.String("/Common/dest_addr"),
    			MatchAcrossPools:    pulumi.String("enabled"),
    			MatchAcrossServices: pulumi.String("enabled"),
    			MatchAcrossVirtuals: pulumi.String("enabled"),
    			Mirror:              pulumi.String("enabled"),
    			Timeout:             pulumi.Int(3600),
    			OverrideConnLimit:   pulumi.String("enabled"),
    			HashAlgorithm:       pulumi.String("carp"),
    			Mask:                pulumi.String("255.255.255.255"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var dstaddr = new F5BigIP.Ltm.PersistenceProfileDstAddr("dstaddr", new()
        {
            Name = "/Common/terraform_ppdstaddr",
            DefaultsFrom = "/Common/dest_addr",
            MatchAcrossPools = "enabled",
            MatchAcrossServices = "enabled",
            MatchAcrossVirtuals = "enabled",
            Mirror = "enabled",
            Timeout = 3600,
            OverrideConnLimit = "enabled",
            HashAlgorithm = "carp",
            Mask = "255.255.255.255",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.ltm.PersistenceProfileDstAddr;
    import com.pulumi.f5bigip.ltm.PersistenceProfileDstAddrArgs;
    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 dstaddr = new PersistenceProfileDstAddr("dstaddr", PersistenceProfileDstAddrArgs.builder()
                .name("/Common/terraform_ppdstaddr")
                .defaultsFrom("/Common/dest_addr")
                .matchAcrossPools("enabled")
                .matchAcrossServices("enabled")
                .matchAcrossVirtuals("enabled")
                .mirror("enabled")
                .timeout(3600)
                .overrideConnLimit("enabled")
                .hashAlgorithm("carp")
                .mask("255.255.255.255")
                .build());
    
        }
    }
    
    resources:
      dstaddr:
        type: f5bigip:ltm:PersistenceProfileDstAddr
        properties:
          name: /Common/terraform_ppdstaddr
          defaultsFrom: /Common/dest_addr
          matchAcrossPools: enabled
          matchAcrossServices: enabled
          matchAcrossVirtuals: enabled
          mirror: enabled
          timeout: 3600
          overrideConnLimit: enabled
          hashAlgorithm: carp
          mask: 255.255.255.255
    

    Reference

    name - (Required) Name of the virtual address

    defaults_from - (Optional) Specifies the existing profile from which the system imports settings for the new profile.

    match_across_pools (Optional) (enabled or disabled) match across pools with given persistence record

    match_across_services (Optional) (enabled or disabled) match across services with given persistence record

    match_across_virtuals (Optional) (enabled or disabled) match across virtual servers with given persistence record

    mirror (Optional) (enabled or disabled) mirror persistence record

    timeout (Optional) (enabled or disabled) Timeout for persistence of the session in seconds

    override_conn_limit (Optional) (enabled or disabled) Enable or dissable pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.

    Create PersistenceProfileDstAddr Resource

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

    Constructor syntax

    new PersistenceProfileDstAddr(name: string, args: PersistenceProfileDstAddrArgs, opts?: CustomResourceOptions);
    @overload
    def PersistenceProfileDstAddr(resource_name: str,
                                  args: PersistenceProfileDstAddrArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def PersistenceProfileDstAddr(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  defaults_from: Optional[str] = None,
                                  name: Optional[str] = None,
                                  app_service: Optional[str] = None,
                                  hash_algorithm: Optional[str] = None,
                                  mask: Optional[str] = None,
                                  match_across_pools: Optional[str] = None,
                                  match_across_services: Optional[str] = None,
                                  match_across_virtuals: Optional[str] = None,
                                  mirror: Optional[str] = None,
                                  override_conn_limit: Optional[str] = None,
                                  timeout: Optional[int] = None)
    func NewPersistenceProfileDstAddr(ctx *Context, name string, args PersistenceProfileDstAddrArgs, opts ...ResourceOption) (*PersistenceProfileDstAddr, error)
    public PersistenceProfileDstAddr(string name, PersistenceProfileDstAddrArgs args, CustomResourceOptions? opts = null)
    public PersistenceProfileDstAddr(String name, PersistenceProfileDstAddrArgs args)
    public PersistenceProfileDstAddr(String name, PersistenceProfileDstAddrArgs args, CustomResourceOptions options)
    
    type: f5bigip:ltm:PersistenceProfileDstAddr
    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 PersistenceProfileDstAddrArgs
    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 PersistenceProfileDstAddrArgs
    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 PersistenceProfileDstAddrArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PersistenceProfileDstAddrArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PersistenceProfileDstAddrArgs
    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 persistenceProfileDstAddrResource = new F5BigIP.Ltm.PersistenceProfileDstAddr("persistenceProfileDstAddrResource", new()
    {
        DefaultsFrom = "string",
        Name = "string",
        AppService = "string",
        HashAlgorithm = "string",
        Mask = "string",
        MatchAcrossPools = "string",
        MatchAcrossServices = "string",
        MatchAcrossVirtuals = "string",
        Mirror = "string",
        OverrideConnLimit = "string",
        Timeout = 0,
    });
    
    example, err := ltm.NewPersistenceProfileDstAddr(ctx, "persistenceProfileDstAddrResource", &ltm.PersistenceProfileDstAddrArgs{
    	DefaultsFrom:        pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	AppService:          pulumi.String("string"),
    	HashAlgorithm:       pulumi.String("string"),
    	Mask:                pulumi.String("string"),
    	MatchAcrossPools:    pulumi.String("string"),
    	MatchAcrossServices: pulumi.String("string"),
    	MatchAcrossVirtuals: pulumi.String("string"),
    	Mirror:              pulumi.String("string"),
    	OverrideConnLimit:   pulumi.String("string"),
    	Timeout:             pulumi.Int(0),
    })
    
    var persistenceProfileDstAddrResource = new PersistenceProfileDstAddr("persistenceProfileDstAddrResource", PersistenceProfileDstAddrArgs.builder()
        .defaultsFrom("string")
        .name("string")
        .appService("string")
        .hashAlgorithm("string")
        .mask("string")
        .matchAcrossPools("string")
        .matchAcrossServices("string")
        .matchAcrossVirtuals("string")
        .mirror("string")
        .overrideConnLimit("string")
        .timeout(0)
        .build());
    
    persistence_profile_dst_addr_resource = f5bigip.ltm.PersistenceProfileDstAddr("persistenceProfileDstAddrResource",
        defaults_from="string",
        name="string",
        app_service="string",
        hash_algorithm="string",
        mask="string",
        match_across_pools="string",
        match_across_services="string",
        match_across_virtuals="string",
        mirror="string",
        override_conn_limit="string",
        timeout=0)
    
    const persistenceProfileDstAddrResource = new f5bigip.ltm.PersistenceProfileDstAddr("persistenceProfileDstAddrResource", {
        defaultsFrom: "string",
        name: "string",
        appService: "string",
        hashAlgorithm: "string",
        mask: "string",
        matchAcrossPools: "string",
        matchAcrossServices: "string",
        matchAcrossVirtuals: "string",
        mirror: "string",
        overrideConnLimit: "string",
        timeout: 0,
    });
    
    type: f5bigip:ltm:PersistenceProfileDstAddr
    properties:
        appService: string
        defaultsFrom: string
        hashAlgorithm: string
        mask: string
        matchAcrossPools: string
        matchAcrossServices: string
        matchAcrossVirtuals: string
        mirror: string
        name: string
        overrideConnLimit: string
        timeout: 0
    

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

    DefaultsFrom string
    Inherit defaults from parent profile
    Name string
    Name of the persistence profile
    AppService string
    HashAlgorithm string
    Specify the hash algorithm
    Mask string
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    MatchAcrossPools string
    To enable _ disable match across pools with given persistence record
    MatchAcrossServices string
    To enable _ disable match across services with given persistence record
    MatchAcrossVirtuals string
    To enable _ disable match across services with given persistence record
    Mirror string
    To enable _ disable
    OverrideConnLimit string
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    Timeout int
    Timeout for persistence of the session
    DefaultsFrom string
    Inherit defaults from parent profile
    Name string
    Name of the persistence profile
    AppService string
    HashAlgorithm string
    Specify the hash algorithm
    Mask string
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    MatchAcrossPools string
    To enable _ disable match across pools with given persistence record
    MatchAcrossServices string
    To enable _ disable match across services with given persistence record
    MatchAcrossVirtuals string
    To enable _ disable match across services with given persistence record
    Mirror string
    To enable _ disable
    OverrideConnLimit string
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    Timeout int
    Timeout for persistence of the session
    defaultsFrom String
    Inherit defaults from parent profile
    name String
    Name of the persistence profile
    appService String
    hashAlgorithm String
    Specify the hash algorithm
    mask String
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    matchAcrossPools String
    To enable _ disable match across pools with given persistence record
    matchAcrossServices String
    To enable _ disable match across services with given persistence record
    matchAcrossVirtuals String
    To enable _ disable match across services with given persistence record
    mirror String
    To enable _ disable
    overrideConnLimit String
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    timeout Integer
    Timeout for persistence of the session
    defaultsFrom string
    Inherit defaults from parent profile
    name string
    Name of the persistence profile
    appService string
    hashAlgorithm string
    Specify the hash algorithm
    mask string
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    matchAcrossPools string
    To enable _ disable match across pools with given persistence record
    matchAcrossServices string
    To enable _ disable match across services with given persistence record
    matchAcrossVirtuals string
    To enable _ disable match across services with given persistence record
    mirror string
    To enable _ disable
    overrideConnLimit string
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    timeout number
    Timeout for persistence of the session
    defaults_from str
    Inherit defaults from parent profile
    name str
    Name of the persistence profile
    app_service str
    hash_algorithm str
    Specify the hash algorithm
    mask str
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    match_across_pools str
    To enable _ disable match across pools with given persistence record
    match_across_services str
    To enable _ disable match across services with given persistence record
    match_across_virtuals str
    To enable _ disable match across services with given persistence record
    mirror str
    To enable _ disable
    override_conn_limit str
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    timeout int
    Timeout for persistence of the session
    defaultsFrom String
    Inherit defaults from parent profile
    name String
    Name of the persistence profile
    appService String
    hashAlgorithm String
    Specify the hash algorithm
    mask String
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    matchAcrossPools String
    To enable _ disable match across pools with given persistence record
    matchAcrossServices String
    To enable _ disable match across services with given persistence record
    matchAcrossVirtuals String
    To enable _ disable match across services with given persistence record
    mirror String
    To enable _ disable
    overrideConnLimit String
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    timeout Number
    Timeout for persistence of the session

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PersistenceProfileDstAddr 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 PersistenceProfileDstAddr Resource

    Get an existing PersistenceProfileDstAddr 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?: PersistenceProfileDstAddrState, opts?: CustomResourceOptions): PersistenceProfileDstAddr
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_service: Optional[str] = None,
            defaults_from: Optional[str] = None,
            hash_algorithm: Optional[str] = None,
            mask: Optional[str] = None,
            match_across_pools: Optional[str] = None,
            match_across_services: Optional[str] = None,
            match_across_virtuals: Optional[str] = None,
            mirror: Optional[str] = None,
            name: Optional[str] = None,
            override_conn_limit: Optional[str] = None,
            timeout: Optional[int] = None) -> PersistenceProfileDstAddr
    func GetPersistenceProfileDstAddr(ctx *Context, name string, id IDInput, state *PersistenceProfileDstAddrState, opts ...ResourceOption) (*PersistenceProfileDstAddr, error)
    public static PersistenceProfileDstAddr Get(string name, Input<string> id, PersistenceProfileDstAddrState? state, CustomResourceOptions? opts = null)
    public static PersistenceProfileDstAddr get(String name, Output<String> id, PersistenceProfileDstAddrState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AppService string
    DefaultsFrom string
    Inherit defaults from parent profile
    HashAlgorithm string
    Specify the hash algorithm
    Mask string
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    MatchAcrossPools string
    To enable _ disable match across pools with given persistence record
    MatchAcrossServices string
    To enable _ disable match across services with given persistence record
    MatchAcrossVirtuals string
    To enable _ disable match across services with given persistence record
    Mirror string
    To enable _ disable
    Name string
    Name of the persistence profile
    OverrideConnLimit string
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    Timeout int
    Timeout for persistence of the session
    AppService string
    DefaultsFrom string
    Inherit defaults from parent profile
    HashAlgorithm string
    Specify the hash algorithm
    Mask string
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    MatchAcrossPools string
    To enable _ disable match across pools with given persistence record
    MatchAcrossServices string
    To enable _ disable match across services with given persistence record
    MatchAcrossVirtuals string
    To enable _ disable match across services with given persistence record
    Mirror string
    To enable _ disable
    Name string
    Name of the persistence profile
    OverrideConnLimit string
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    Timeout int
    Timeout for persistence of the session
    appService String
    defaultsFrom String
    Inherit defaults from parent profile
    hashAlgorithm String
    Specify the hash algorithm
    mask String
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    matchAcrossPools String
    To enable _ disable match across pools with given persistence record
    matchAcrossServices String
    To enable _ disable match across services with given persistence record
    matchAcrossVirtuals String
    To enable _ disable match across services with given persistence record
    mirror String
    To enable _ disable
    name String
    Name of the persistence profile
    overrideConnLimit String
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    timeout Integer
    Timeout for persistence of the session
    appService string
    defaultsFrom string
    Inherit defaults from parent profile
    hashAlgorithm string
    Specify the hash algorithm
    mask string
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    matchAcrossPools string
    To enable _ disable match across pools with given persistence record
    matchAcrossServices string
    To enable _ disable match across services with given persistence record
    matchAcrossVirtuals string
    To enable _ disable match across services with given persistence record
    mirror string
    To enable _ disable
    name string
    Name of the persistence profile
    overrideConnLimit string
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    timeout number
    Timeout for persistence of the session
    app_service str
    defaults_from str
    Inherit defaults from parent profile
    hash_algorithm str
    Specify the hash algorithm
    mask str
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    match_across_pools str
    To enable _ disable match across pools with given persistence record
    match_across_services str
    To enable _ disable match across services with given persistence record
    match_across_virtuals str
    To enable _ disable match across services with given persistence record
    mirror str
    To enable _ disable
    name str
    Name of the persistence profile
    override_conn_limit str
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    timeout int
    Timeout for persistence of the session
    appService String
    defaultsFrom String
    Inherit defaults from parent profile
    hashAlgorithm String
    Specify the hash algorithm
    mask String
    Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
    matchAcrossPools String
    To enable _ disable match across pools with given persistence record
    matchAcrossServices String
    To enable _ disable match across services with given persistence record
    matchAcrossVirtuals String
    To enable _ disable match across services with given persistence record
    mirror String
    To enable _ disable
    name String
    Name of the persistence profile
    overrideConnLimit String
    To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
    timeout Number
    Timeout for persistence of the session

    Import

    ing

    An dest-addr persistence profile can be imported into this resource by supplying the Name in full path as id. An example is below:

    $ terraform import bigip_ltm_persistence_profile_dstaddr.dstaddr "/Common/terraform_ppdstaddr"
    

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

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.6 published on Monday, Oct 28, 2024 by Pulumi