Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. TeamsList
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.TeamsList

Explore with Pulumi AI

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

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",
    ],
});
Copy
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",
    ])
Copy
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
	})
}
Copy
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",
        },
    });

});
Copy
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());

    }
}
Copy
resources:
  example:
    type: cloudflare:TeamsList
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      name: Corporate devices
      type: SERIAL
      description: Serial numbers for all corporate devices.
      items:
        - 8GE8721REF
        - 5RE8543EGG
        - 1YE2880LNP
Copy

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,
              items_with_descriptions: Optional[Sequence[TeamsListItemsWithDescriptionArgs]] = 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 This property is required. string
The unique name of the resource.
args This property is required. TeamsListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. TeamsListArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TeamsListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
    },
    ItemsWithDescriptions = new[]
    {
        new Cloudflare.Inputs.TeamsListItemsWithDescriptionArgs
        {
            Description = "string",
            Value = "string",
        },
    },
});
Copy
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"),
	},
	ItemsWithDescriptions: cloudflare.TeamsListItemsWithDescriptionArray{
		&cloudflare.TeamsListItemsWithDescriptionArgs{
			Description: pulumi.String("string"),
			Value:       pulumi.String("string"),
		},
	},
})
Copy
var teamsListResource = new TeamsList("teamsListResource", TeamsListArgs.builder()
    .accountId("string")
    .name("string")
    .type("string")
    .description("string")
    .items("string")
    .itemsWithDescriptions(TeamsListItemsWithDescriptionArgs.builder()
        .description("string")
        .value("string")
        .build())
    .build());
Copy
teams_list_resource = cloudflare.TeamsList("teamsListResource",
    account_id="string",
    name="string",
    type="string",
    description="string",
    items=["string"],
    items_with_descriptions=[{
        "description": "string",
        "value": "string",
    }])
Copy
const teamsListResource = new cloudflare.TeamsList("teamsListResource", {
    accountId: "string",
    name: "string",
    type: "string",
    description: "string",
    items: ["string"],
    itemsWithDescriptions: [{
        description: "string",
        value: "string",
    }],
});
Copy
type: cloudflare:TeamsList
properties:
    accountId: string
    description: string
    items:
        - string
    itemsWithDescriptions:
        - description: string
          value: string
    name: string
    type: string
Copy

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

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

The TeamsList resource accepts the following input properties:

AccountId This property is required. string
The account identifier to target for the resource.
Name This property is required. string
Name of the teams list.
Type This property is required. 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<TeamsListItemsWithDescription>
The items of the teams list that has explicit description.
AccountId This property is required. string
The account identifier to target for the resource.
Name This property is required. string
Name of the teams list.
Type This property is required. 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 []TeamsListItemsWithDescriptionArgs
The items of the teams list that has explicit description.
accountId This property is required. String
The account identifier to target for the resource.
name This property is required. String
Name of the teams list.
type This property is required. 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<TeamsListItemsWithDescription>
The items of the teams list that has explicit description.
accountId This property is required. string
The account identifier to target for the resource.
name This property is required. string
Name of the teams list.
type This property is required. 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 TeamsListItemsWithDescription[]
The items of the teams list that has explicit description.
account_id This property is required. str
The account identifier to target for the resource.
name This property is required. str
Name of the teams list.
type This property is required. 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[TeamsListItemsWithDescriptionArgs]
The items of the teams list that has explicit description.
accountId This property is required. String
The account identifier to target for the resource.
name This property is required. String
Name of the teams list.
type This property is required. 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 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,
        items_with_descriptions: Optional[Sequence[TeamsListItemsWithDescriptionArgs]] = 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)
resources:  _:    type: cloudflare:TeamsList    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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<TeamsListItemsWithDescription>
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 []TeamsListItemsWithDescriptionArgs
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<TeamsListItemsWithDescription>
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 TeamsListItemsWithDescription[]
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[TeamsListItemsWithDescriptionArgs]
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

TeamsListItemsWithDescription
, TeamsListItemsWithDescriptionArgs

Description This property is required. string
Value This property is required. string
Description This property is required. string
Value This property is required. string
description This property is required. String
value This property is required. String
description This property is required. string
value This property is required. string
description This property is required. str
value This property is required. str
description This property is required. String
value This property is required. String

Import

$ pulumi import cloudflare:index/teamsList:TeamsList example <account_id>/<teams_list_id>
Copy

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 v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare