Docs Packages
  1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. ltm
  5. SnatPool
f5 BIG-IP v3.17.2 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.ltm.SnatPool

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.2 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-f5bigip

    f5bigip.ltm.SnatPool Collections of SNAT translation addresses

    Resource should be named with their “full path”. The full path is the combination of the partition + name of the resource, for example /Common/my-snatpool.

    Example Usage

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

const snatpoolSanjose = new f5bigip.ltm.SnatPool("snatpool_sanjose", {
    name: "/Common/snatpool_sanjose",
    members: [
        "191.1.1.1",
        "194.2.2.2",
    ],
});

    import pulumi
import pulumi_f5bigip as f5bigip

snatpool_sanjose = f5bigip.ltm.SnatPool("snatpool_sanjose",
    name="/Common/snatpool_sanjose",
    members=[
        "191.1.1.1",
        "194.2.2.2",
    ])

    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.NewSnatPool(ctx, "snatpool_sanjose", &ltm.SnatPoolArgs{
			Name: pulumi.String("/Common/snatpool_sanjose"),
			Members: pulumi.StringArray{
				pulumi.String("191.1.1.1"),
				pulumi.String("194.2.2.2"),
			},
		})
		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 snatpoolSanjose = new F5BigIP.Ltm.SnatPool("snatpool_sanjose", new()
    {
        Name = "/Common/snatpool_sanjose",
        Members = new[]
        {
            "191.1.1.1",
            "194.2.2.2",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.ltm.SnatPool;
import com.pulumi.f5bigip.ltm.SnatPoolArgs;
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 snatpoolSanjose = new SnatPool("snatpoolSanjose", SnatPoolArgs.builder()
            .name("/Common/snatpool_sanjose")
            .members(            
                "191.1.1.1",
                "194.2.2.2")
            .build());

    }
}

    resources:
  snatpoolSanjose:
    type: f5bigip:ltm:SnatPool
    name: snatpool_sanjose
    properties:
      name: /Common/snatpool_sanjose
      members:
        - 191.1.1.1
        - 194.2.2.2

    Create SnatPool Resource

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

    Constructor syntax

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

@overload
def SnatPool(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             members: Optional[Sequence[str]] = None,
             name: Optional[str] = None)
    func NewSnatPool(ctx *Context, name string, args SnatPoolArgs, opts ...ResourceOption) (*SnatPool, error)
    public SnatPool(string name, SnatPoolArgs args, CustomResourceOptions? opts = null)
    public SnatPool(String name, SnatPoolArgs args)
public SnatPool(String name, SnatPoolArgs args, CustomResourceOptions options)

    type: f5bigip:ltm:SnatPool
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 SnatPoolArgs
    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 SnatPoolArgs
    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 SnatPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnatPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnatPoolArgs
    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 snatPoolResource = new F5BigIP.Ltm.SnatPool("snatPoolResource", new()
{
    Members = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := ltm.NewSnatPool(ctx, "snatPoolResource", &ltm.SnatPoolArgs{
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var snatPoolResource = new SnatPool("snatPoolResource", SnatPoolArgs.builder()
    .members("string")
    .name("string")
    .build());

    snat_pool_resource = f5bigip.ltm.SnatPool("snatPoolResource",
    members=["string"],
    name="string")

    const snatPoolResource = new f5bigip.ltm.SnatPool("snatPoolResource", {
    members: ["string"],
    name: "string",
});

    type: f5bigip:ltm:SnatPool
properties:
    members:
        - string
    name: string

    SnatPool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SnatPool resource accepts the following input properties:

    Members List<string>
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    Name string
    Name of the snatpool
    Members []string
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    Name string
    Name of the snatpool
    members List<String>
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    name String
    Name of the snatpool
    members string[]
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    name string
    Name of the snatpool
    members Sequence[str]
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    name str
    Name of the snatpool
    members List<String>
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    name String
    Name of the snatpool

    Outputs

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

    Get an existing SnatPool 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?: SnatPoolState, opts?: CustomResourceOptions): SnatPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        members: Optional[Sequence[str]] = None,
        name: Optional[str] = None) -> SnatPool
    func GetSnatPool(ctx *Context, name string, id IDInput, state *SnatPoolState, opts ...ResourceOption) (*SnatPool, error)
    public static SnatPool Get(string name, Input<string> id, SnatPoolState? state, CustomResourceOptions? opts = null)
    public static SnatPool get(String name, Output<String> id, SnatPoolState 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:
    Members List<string>
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    Name string
    Name of the snatpool
    Members []string
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    Name string
    Name of the snatpool
    members List<String>
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    name String
    Name of the snatpool
    members string[]
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    name string
    Name of the snatpool
    members Sequence[str]
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    name str
    Name of the snatpool
    members List<String>
    Specifies a translation address to add to or delete from a SNAT pool (at least one address is required)
    name String
    Name of the snatpool

    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.2 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-f5bigip