Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. IpSet
Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
pulumiverse/pulumi-cpln

cpln.IpSet

Explore with Pulumi AI

cpln logo
Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
pulumiverse/pulumi-cpln

    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

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cpln = Pulumiverse.Cpln;

return await Deployment.RunAsync(() => 
{
    var @new = new Cpln.IpSet("new", new()
    {
        Description = "example",
        Link = "SELF_LINK_TO_WORKLOAD",
        Locations = new[]
        {
            new Cpln.Inputs.IpSetLocationArgs
            {
                Name = "SELF_LINK_TO_LOCATION",
                RetentionPolicy = "keep",
            },
        },
        Tags = 
        {
            { "terraform_generated", "true" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-cpln/sdk/go/cpln"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cpln.NewIpSet(ctx, "new", &cpln.IpSetArgs{
			Description: pulumi.String("example"),
			Link:        pulumi.String("SELF_LINK_TO_WORKLOAD"),
			Locations: cpln.IpSetLocationArray{
				&cpln.IpSetLocationArgs{
					Name:            pulumi.String("SELF_LINK_TO_LOCATION"),
					RetentionPolicy: pulumi.String("keep"),
				},
			},
			Tags: pulumi.StringMap{
				"terraform_generated": pulumi.String("true"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cpln.IpSet;
import com.pulumi.cpln.IpSetArgs;
import com.pulumi.cpln.inputs.IpSetLocationArgs;
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 new_ = new IpSet("new", IpSetArgs.builder()        
            .description("example")
            .link("SELF_LINK_TO_WORKLOAD")
            .locations(IpSetLocationArgs.builder()
                .name("SELF_LINK_TO_LOCATION")
                .retentionPolicy("keep")
                .build())
            .tags(Map.of("terraform_generated", "true"))
            .build());

    }
}

    import pulumi
import pulumiverse_cpln as cpln

new = cpln.IpSet("new",
    description="example",
    link="SELF_LINK_TO_WORKLOAD",
    locations=[cpln.IpSetLocationArgs(
        name="SELF_LINK_TO_LOCATION",
        retention_policy="keep",
    )],
    tags={
        "terraform_generated": "true",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as cpln from "@pulumiverse/cpln";

const _new = new cpln.IpSet("new", {
    description: "example",
    link: "SELF_LINK_TO_WORKLOAD",
    locations: [{
        name: "SELF_LINK_TO_LOCATION",
        retentionPolicy: "keep",
    }],
    tags: {
        terraform_generated: "true",
    },
});

    resources:
  new:
    type: cpln:IpSet
    properties:
      description: example
      link: SELF_LINK_TO_WORKLOAD
      locations:
        - name: SELF_LINK_TO_LOCATION
          retentionPolicy: keep
      tags:
        terraform_generated: 'true'

    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

    name string
    The unique name of the resource.
    args IpSetArgs
    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 IpSetArgs
    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 IpSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpSetArgs
    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 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IpSet resource accepts the following input properties:

    Description string
    Description of the IpSet.
    Link string
    The self link of a workload.
    Locations List<Pulumiverse.Cpln.Inputs.IpSetLocation>
    Name string
    Name of the IpSet.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    Description string
    Description of the IpSet.
    Link string
    The self link of a workload.
    Locations []IpSetLocationArgs
    Name string
    Name of the IpSet.
    Tags map[string]string
    Key-value map of resource tags.
    description String
    Description of the IpSet.
    link String
    The self link of a workload.
    locations List<IpSetLocation>
    name String
    Name of the IpSet.
    tags Map<String,String>
    Key-value map of resource tags.
    description string
    Description of the IpSet.
    link string
    The self link of a workload.
    locations IpSetLocation[]
    name string
    Name of the IpSet.
    tags {[key: string]: string}
    Key-value map of resource tags.
    description str
    Description of the IpSet.
    link str
    The self link of a workload.
    locations Sequence[IpSetLocationArgs]
    name str
    Name of the IpSet.
    tags Mapping[str, str]
    Key-value map of resource tags.
    description String
    Description of the IpSet.
    link String
    The self link of a workload.
    locations List<Property Map>
    name String
    Name of the IpSet.
    tags Map<String>
    Key-value map of resource tags.

    Outputs

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

    CplnId string
    The ID, in GUID format, of the IpSet.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses List<Pulumiverse.Cpln.Outputs.IpSetStatus>
    Status of the IpSet.
    CplnId string
    The ID, in GUID format, of the IpSet.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses []IpSetStatus
    Status of the IpSet.
    cplnId String
    The ID, in GUID format, of the IpSet.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<IpSetStatus>
    Status of the IpSet.
    cplnId string
    The ID, in GUID format, of the IpSet.
    id string
    The provider-assigned unique ID for this managed resource.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    statuses IpSetStatus[]
    Status of the IpSet.
    cpln_id str
    The ID, in GUID format, of the IpSet.
    id str
    The provider-assigned unique ID for this managed resource.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    statuses Sequence[IpSetStatus]
    Status of the IpSet.
    cplnId String
    The ID, in GUID format, of the IpSet.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<Property Map>
    Status of the IpSet.

    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)
    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:
    CplnId string
    The ID, in GUID format, of the IpSet.
    Description string
    Description of the IpSet.
    Link string
    The self link of a workload.
    Locations List<Pulumiverse.Cpln.Inputs.IpSetLocation>
    Name string
    Name of the IpSet.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses List<Pulumiverse.Cpln.Inputs.IpSetStatus>
    Status of the IpSet.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    CplnId string
    The ID, in GUID format, of the IpSet.
    Description string
    Description of the IpSet.
    Link string
    The self link of a workload.
    Locations []IpSetLocationArgs
    Name string
    Name of the IpSet.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses []IpSetStatusArgs
    Status of the IpSet.
    Tags map[string]string
    Key-value map of resource tags.
    cplnId String
    The ID, in GUID format, of the IpSet.
    description String
    Description of the IpSet.
    link String
    The self link of a workload.
    locations List<IpSetLocation>
    name String
    Name of the IpSet.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<IpSetStatus>
    Status of the IpSet.
    tags Map<String,String>
    Key-value map of resource tags.
    cplnId string
    The ID, in GUID format, of the IpSet.
    description string
    Description of the IpSet.
    link string
    The self link of a workload.
    locations IpSetLocation[]
    name string
    Name of the IpSet.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    statuses IpSetStatus[]
    Status of the IpSet.
    tags {[key: string]: string}
    Key-value map of resource tags.
    cpln_id str
    The ID, in GUID format, of the IpSet.
    description str
    Description of the IpSet.
    link str
    The self link of a workload.
    locations Sequence[IpSetLocationArgs]
    name str
    Name of the IpSet.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    statuses Sequence[IpSetStatusArgs]
    Status of the IpSet.
    tags Mapping[str, str]
    Key-value map of resource tags.
    cplnId String
    The ID, in GUID format, of the IpSet.
    description String
    Description of the IpSet.
    link String
    The self link of a workload.
    locations List<Property Map>
    name String
    Name of the IpSet.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<Property Map>
    Status of the IpSet.
    tags Map<String>
    Key-value map of resource tags.

    Supporting Types

    IpSetLocation, IpSetLocationArgs

    Name string
    RetentionPolicy string
    Name string
    RetentionPolicy string
    name String
    retentionPolicy String
    name string
    retentionPolicy string
    name String
    retentionPolicy String

    IpSetStatus, IpSetStatusArgs

    IpSetStatusIpAddress, IpSetStatusIpAddressArgs

    Created string
    Id string
    Ip string
    Name string
    State string
    Created string
    Id string
    Ip string
    Name string
    State string
    created String
    id String
    ip String
    name String
    state String
    created string
    id string
    ip string
    name string
    state string
    created str
    id str
    ip str
    name str
    state str
    created String
    id String
    ip String
    name String
    state String

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
    pulumiverse/pulumi-cpln