cpln.IpSet

Manages an org’s IpSet.

Declaration

Required

• name (String) Name of the IpSet.

Optional

• description - (String) Description of the IpSet.
• tags (Map of String) Key-value map of resource tags.
• link (String) The self link of a workload.
• location (Block List) (see below).

location

Required:

• name (String) The self link of a location.
• retention_policy (String) Exactly one of: keep and free.

Outputs

The following attributes are exported:

• cpln_id (String) The ID, in GUID format, of the IpSet.
• self_link (String) Full link to this resource. Can be referenced by other resources.
• status (Block List, Max: 1) (see below).

status

Status of the IpSet.

Read-Only:

• ip_address (Block List) (see below)
• error (String)

status.ip_address

• name (String)
• ip (String)
• id (String)
• state (String)
• created (String)

Example Usage

resource "cpln_ipset" "new" {
		
  name        = "example"
  description = "example"

  tags = {
    terraform_generated = "true"
  }

  link = "SELF_LINK_TO_WORKLOAD"
  
  location {
    name             = "SELF_LINK_TO_LOCATION"
    retention_policy = "keep"
  }
}

Create IpSet Resource

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

Constructor syntax

new IpSet(name: string, args?: IpSetArgs, opts?: CustomResourceOptions);

@overload
def IpSet(resource_name: str,
          args: Optional[IpSetArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def IpSet(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          link: Optional[str] = None,
          locations: Optional[Sequence[IpSetLocationArgs]] = None,
          name: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None)

func NewIpSet(ctx *Context, name string, args *IpSetArgs, opts ...ResourceOption) (*IpSet, error)

public IpSet(string name, IpSetArgs? args = null, CustomResourceOptions? opts = null)

public IpSet(String name, IpSetArgs args)
public IpSet(String name, IpSetArgs args, CustomResourceOptions options)

type: cpln:IpSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var ipSetResource = new Cpln.IpSet("ipSetResource", new()
{
    Description = "string",
    Link = "string",
    Locations = new[]
    {
        new Cpln.Inputs.IpSetLocationArgs
        {
            Name = "string",
            RetentionPolicy = "string",
        },
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

example, err := cpln.NewIpSet(ctx, "ipSetResource", &cpln.IpSetArgs{
	Description: pulumi.String("string"),
	Link:        pulumi.String("string"),
	Locations: cpln.IpSetLocationArray{
		&cpln.IpSetLocationArgs{
			Name:            pulumi.String("string"),
			RetentionPolicy: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var ipSetResource = new IpSet("ipSetResource", IpSetArgs.builder()
    .description("string")
    .link("string")
    .locations(IpSetLocationArgs.builder()
        .name("string")
        .retentionPolicy("string")
        .build())
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

ip_set_resource = cpln.IpSet("ipSetResource",
    description="string",
    link="string",
    locations=[{
        "name": "string",
        "retention_policy": "string",
    }],
    name="string",
    tags={
        "string": "string",
    })

const ipSetResource = new cpln.IpSet("ipSetResource", {
    description: "string",
    link: "string",
    locations: [{
        name: "string",
        retentionPolicy: "string",
    }],
    name: "string",
    tags: {
        string: "string",
    },
});

type: cpln:IpSet
properties:
    description: string
    link: string
    locations:
        - name: string
          retentionPolicy: string
    name: string
    tags:
        string: string

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

Outputs

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

Look up Existing IpSet Resource

Get an existing IpSet 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?: IpSetState, opts?: CustomResourceOptions): IpSet

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cpln_id: Optional[str] = None,
        description: Optional[str] = None,
        link: Optional[str] = None,
        locations: Optional[Sequence[IpSetLocationArgs]] = None,
        name: Optional[str] = None,
        self_link: Optional[str] = None,
        statuses: Optional[Sequence[IpSetStatusArgs]] = None,
        tags: Optional[Mapping[str, str]] = None) -> IpSet

func GetIpSet(ctx *Context, name string, id IDInput, state *IpSetState, opts ...ResourceOption) (*IpSet, error)

public static IpSet Get(string name, Input<string> id, IpSetState? state, CustomResourceOptions? opts = null)

public static IpSet get(String name, Output<String> id, IpSetState state, CustomResourceOptions options)

resources:  _:    type: cpln:IpSet    get:      id: ${id}

Supporting Types

IpSetLocation, IpSetLocationArgs

IpSetStatus, IpSetStatusArgs

IpSetStatusIpAddress, IpSetStatusIpAddressArgs

Package Details

Repository

cpln pulumiverse/pulumi-cpln

License

Apache-2.0

Notes

This Pulumi package is based on the cpln Terraform Provider.