1. Packages
  2. Cloudflare
  3. API Docs
  4. TeamsList
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

cloudflare.TeamsList

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.34.0 published on Friday, Jul 12, 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.TeamsList("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.TeamsList("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.NewTeamsList(ctx, "example", &cloudflare.TeamsListArgs{
    			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.TeamsList("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.TeamsList;
    import com.pulumi.cloudflare.TeamsListArgs;
    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 TeamsList("example", TeamsListArgs.builder()
                .accountId("f037e56e89293a057740de681ac9abbe")
                .name("Corporate devices")
                .type("SERIAL")
                .description("Serial numbers for all corporate devices.")
                .items(            
                    "8GE8721REF",
                    "5RE8543EGG",
                    "1YE2880LNP")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:TeamsList
        properties:
          accountId: f037e56e89293a057740de681ac9abbe
          name: Corporate devices
          type: SERIAL
          description: Serial numbers for all corporate devices.
          items:
            - 8GE8721REF
            - 5RE8543EGG
            - 1YE2880LNP
    

    Create TeamsList Resource

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

    Constructor syntax

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

    TeamsList 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 TeamsList 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.
    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.
    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.
    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.
    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.
    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.

    Outputs

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

    Get an existing TeamsList 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?: TeamsListState, opts?: CustomResourceOptions): TeamsList
    @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,
            name: Optional[str] = None,
            type: Optional[str] = None) -> TeamsList
    func GetTeamsList(ctx *Context, name string, id IDInput, state *TeamsListState, opts ...ResourceOption) (*TeamsList, error)
    public static TeamsList Get(string name, Input<string> id, TeamsListState? state, CustomResourceOptions? opts = null)
    public static TeamsList get(String name, Output<String> id, TeamsListState 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.
    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.
    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.
    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.
    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.
    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.
    name String
    Name of the teams list.
    type String
    The teams list type. Available values: IP, SERIAL, URL, DOMAIN, EMAIL.

    Import

    $ pulumi import cloudflare:index/teamsList:TeamsList 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.34.0 published on Friday, Jul 12, 2024 by Pulumi