1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. ZeroTrustList
Cloudflare v5.39.1 published on Tuesday, Sep 24, 2024 by Pulumi

cloudflare.ZeroTrustList

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.39.1 published on Tuesday, Sep 24, 2024 by Pulumi

    Provides a Cloudflare Teams List resource. Teams lists are referenced when creating secure web gateway policies or device posture rules.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.ZeroTrustList("example", {
        accountId: "f037e56e89293a057740de681ac9abbe",
        name: "Corporate devices",
        type: "SERIAL",
        description: "Serial numbers for all corporate devices.",
        items: [
            "8GE8721REF",
            "5RE8543EGG",
            "1YE2880LNP",
        ],
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.ZeroTrustList("example",
        account_id="f037e56e89293a057740de681ac9abbe",
        name="Corporate devices",
        type="SERIAL",
        description="Serial numbers for all corporate devices.",
        items=[
            "8GE8721REF",
            "5RE8543EGG",
            "1YE2880LNP",
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.NewZeroTrustList(ctx, "example", &cloudflare.ZeroTrustListArgs{
    			AccountId:   pulumi.String("f037e56e89293a057740de681ac9abbe"),
    			Name:        pulumi.String("Corporate devices"),
    			Type:        pulumi.String("SERIAL"),
    			Description: pulumi.String("Serial numbers for all corporate devices."),
    			Items: pulumi.StringArray{
    				pulumi.String("8GE8721REF"),
    				pulumi.String("5RE8543EGG"),
    				pulumi.String("1YE2880LNP"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Cloudflare.ZeroTrustList("example", new()
        {
            AccountId = "f037e56e89293a057740de681ac9abbe",
            Name = "Corporate devices",
            Type = "SERIAL",
            Description = "Serial numbers for all corporate devices.",
            Items = new[]
            {
                "8GE8721REF",
                "5RE8543EGG",
                "1YE2880LNP",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.ZeroTrustList;
    import com.pulumi.cloudflare.ZeroTrustListArgs;
    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 example = new ZeroTrustList("example", ZeroTrustListArgs.builder()
                .accountId("f037e56e89293a057740de681ac9abbe")
                .name("Corporate devices")
                .type("SERIAL")
                .description("Serial numbers for all corporate devices.")
                .items(            
                    "8GE8721REF",
                    "5RE8543EGG",
                    "1YE2880LNP")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:ZeroTrustList
        properties:
          accountId: f037e56e89293a057740de681ac9abbe
          name: Corporate devices
          type: SERIAL
          description: Serial numbers for all corporate devices.
          items:
            - 8GE8721REF
            - 5RE8543EGG
            - 1YE2880LNP
    

    Create ZeroTrustList Resource

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

    Constructor syntax

    new ZeroTrustList(name: string, args: ZeroTrustListArgs, opts?: CustomResourceOptions);
    @overload
    def ZeroTrustList(resource_name: str,
                      args: ZeroTrustListArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ZeroTrustList(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      account_id: Optional[str] = None,
                      name: Optional[str] = None,
                      type: Optional[str] = None,
                      description: Optional[str] = None,
                      items: Optional[Sequence[str]] = None,
                      items_with_descriptions: Optional[Sequence[ZeroTrustListItemsWithDescriptionArgs]] = None)
    func NewZeroTrustList(ctx *Context, name string, args ZeroTrustListArgs, opts ...ResourceOption) (*ZeroTrustList, error)
    public ZeroTrustList(string name, ZeroTrustListArgs args, CustomResourceOptions? opts = null)
    public ZeroTrustList(String name, ZeroTrustListArgs args)
    public ZeroTrustList(String name, ZeroTrustListArgs args, CustomResourceOptions options)
    
    type: cloudflare:ZeroTrustList
    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 ZeroTrustListArgs
    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 ZeroTrustListArgs
    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 ZeroTrustListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZeroTrustListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZeroTrustListArgs
    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 zeroTrustListResource = new Cloudflare.ZeroTrustList("zeroTrustListResource", new()
    {
        AccountId = "string",
        Name = "string",
        Type = "string",
        Description = "string",
        Items = new[]
        {
            "string",
        },
        ItemsWithDescriptions = new[]
        {
            new Cloudflare.Inputs.ZeroTrustListItemsWithDescriptionArgs
            {
                Description = "string",
                Value = "string",
            },
        },
    });
    
    example, err := cloudflare.NewZeroTrustList(ctx, "zeroTrustListResource", &cloudflare.ZeroTrustListArgs{
    	AccountId:   pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Type:        pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Items: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ItemsWithDescriptions: cloudflare.ZeroTrustListItemsWithDescriptionArray{
    		&cloudflare.ZeroTrustListItemsWithDescriptionArgs{
    			Description: pulumi.String("string"),
    			Value:       pulumi.String("string"),
    		},
    	},
    })
    
    var zeroTrustListResource = new ZeroTrustList("zeroTrustListResource", ZeroTrustListArgs.builder()
        .accountId("string")
        .name("string")
        .type("string")
        .description("string")
        .items("string")
        .itemsWithDescriptions(ZeroTrustListItemsWithDescriptionArgs.builder()
            .description("string")
            .value("string")
            .build())
        .build());
    
    zero_trust_list_resource = cloudflare.ZeroTrustList("zeroTrustListResource",
        account_id="string",
        name="string",
        type="string",
        description="string",
        items=["string"],
        items_with_descriptions=[cloudflare.ZeroTrustListItemsWithDescriptionArgs(
            description="string",
            value="string",
        )])
    
    const zeroTrustListResource = new cloudflare.ZeroTrustList("zeroTrustListResource", {
        accountId: "string",
        name: "string",
        type: "string",
        description: "string",
        items: ["string"],
        itemsWithDescriptions: [{
            description: "string",
            value: "string",
        }],
    });
    
    type: cloudflare:ZeroTrustList
    properties:
        accountId: string
        description: string
        items:
            - string
        itemsWithDescriptions:
            - description: string
              value: string
        name: string
        type: string
    

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

    AccountId string
    The account identifier to target for the resource.
    Name string
    Name of the teams list.
    Type string
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    Description string
    The description of the teams list.
    Items List<string>
    The items of the teams list.
    ItemsWithDescriptions List<ZeroTrustListItemsWithDescription>
    The items of the teams list that has explicit description.
    AccountId string
    The account identifier to target for the resource.
    Name string
    Name of the teams list.
    Type string
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    Description string
    The description of the teams list.
    Items []string
    The items of the teams list.
    ItemsWithDescriptions []ZeroTrustListItemsWithDescriptionArgs
    The items of the teams list that has explicit description.
    accountId String
    The account identifier to target for the resource.
    name String
    Name of the teams list.
    type String
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    description String
    The description of the teams list.
    items List<String>
    The items of the teams list.
    itemsWithDescriptions List<ZeroTrustListItemsWithDescription>
    The items of the teams list that has explicit description.
    accountId string
    The account identifier to target for the resource.
    name string
    Name of the teams list.
    type string
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    description string
    The description of the teams list.
    items string[]
    The items of the teams list.
    itemsWithDescriptions ZeroTrustListItemsWithDescription[]
    The items of the teams list that has explicit description.
    account_id str
    The account identifier to target for the resource.
    name str
    Name of the teams list.
    type str
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    description str
    The description of the teams list.
    items Sequence[str]
    The items of the teams list.
    items_with_descriptions Sequence[ZeroTrustListItemsWithDescriptionArgs]
    The items of the teams list that has explicit description.
    accountId String
    The account identifier to target for the resource.
    name String
    Name of the teams list.
    type String
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    description String
    The description of the teams list.
    items List<String>
    The items of the teams list.
    itemsWithDescriptions List<Property Map>
    The items of the teams list that has explicit description.

    Outputs

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

    Get an existing ZeroTrustList 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?: ZeroTrustListState, opts?: CustomResourceOptions): ZeroTrustList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            description: Optional[str] = None,
            items: Optional[Sequence[str]] = None,
            items_with_descriptions: Optional[Sequence[ZeroTrustListItemsWithDescriptionArgs]] = None,
            name: Optional[str] = None,
            type: Optional[str] = None) -> ZeroTrustList
    func GetZeroTrustList(ctx *Context, name string, id IDInput, state *ZeroTrustListState, opts ...ResourceOption) (*ZeroTrustList, error)
    public static ZeroTrustList Get(string name, Input<string> id, ZeroTrustListState? state, CustomResourceOptions? opts = null)
    public static ZeroTrustList get(String name, Output<String> id, ZeroTrustListState 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:
    AccountId string
    The account identifier to target for the resource.
    Description string
    The description of the teams list.
    Items List<string>
    The items of the teams list.
    ItemsWithDescriptions List<ZeroTrustListItemsWithDescription>
    The items of the teams list that has explicit description.
    Name string
    Name of the teams list.
    Type string
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    AccountId string
    The account identifier to target for the resource.
    Description string
    The description of the teams list.
    Items []string
    The items of the teams list.
    ItemsWithDescriptions []ZeroTrustListItemsWithDescriptionArgs
    The items of the teams list that has explicit description.
    Name string
    Name of the teams list.
    Type string
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    accountId String
    The account identifier to target for the resource.
    description String
    The description of the teams list.
    items List<String>
    The items of the teams list.
    itemsWithDescriptions List<ZeroTrustListItemsWithDescription>
    The items of the teams list that has explicit description.
    name String
    Name of the teams list.
    type String
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    accountId string
    The account identifier to target for the resource.
    description string
    The description of the teams list.
    items string[]
    The items of the teams list.
    itemsWithDescriptions ZeroTrustListItemsWithDescription[]
    The items of the teams list that has explicit description.
    name string
    Name of the teams list.
    type string
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    account_id str
    The account identifier to target for the resource.
    description str
    The description of the teams list.
    items Sequence[str]
    The items of the teams list.
    items_with_descriptions Sequence[ZeroTrustListItemsWithDescriptionArgs]
    The items of the teams list that has explicit description.
    name str
    Name of the teams list.
    type str
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    accountId String
    The account identifier to target for the resource.
    description String
    The description of the teams list.
    items List<String>
    The items of the teams list.
    itemsWithDescriptions List<Property Map>
    The items of the teams list that has explicit description.
    name String
    Name of the teams list.
    type String
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.

    Supporting Types

    ZeroTrustListItemsWithDescription, ZeroTrustListItemsWithDescriptionArgs

    Description string
    Value string
    Description string
    Value string
    description String
    value String
    description string
    value string
    description String
    value String

    Import

    $ pulumi import cloudflare:index/zeroTrustList:ZeroTrustList example <account_id>/<teams_list_id>
    

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

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.39.1 published on Tuesday, Sep 24, 2024 by Pulumi