cloudflare.List (v4) | Pulumi Registry

Cloudflare v4.16.0 (4.x), Mar 9 26

Viewing docs for Cloudflare v4.16.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-cloudflare

Viewing docs for Cloudflare v4.16.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-cloudflare

Example Usage

Example coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.List;
import com.pulumi.cloudflare.ListArgs;
import com.pulumi.cloudflare.inputs.ListItemArgs;
import com.pulumi.cloudflare.inputs.ListItemValueArgs;
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 List("example", ListArgs.builder()        
            .accountId("f037e56e89293a057740de681ac9abbe")
            .description("example redirects for a list")
            .items(            
                ListItemArgs.builder()
                    .comment("one")
                    .value(ListItemValueArgs.builder()
                        .redirect(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .build())
                    .build(),
                ListItemArgs.builder()
                    .comment("two")
                    .value(ListItemValueArgs.builder()
                        .redirect(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .build())
                    .build())
            .kind("redirect")
            .name("example_list")
            .build());

    }
}

Example coming soon!

resources:
  # Redirect list
  example:
    type: cloudflare:List
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      description: example redirects for a list
      items:
        - comment: one
          value:
            redirect:
              - sourceUrl: example.com/blog
                targetUrl: https://blog.example.com
        - comment: two
          value:
            redirect:
              - includeSubdomains: enabled
                preservePathSuffix: disabled
                preserveQueryString: enabled
                sourceUrl: example.com/foo
                statusCode: 301
                subpathMatching: enabled
                targetUrl: https://foo.example.com
      kind: redirect
      name: example_list

Create List Resource

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

Constructor syntax

new List(name: string, args: ListArgs, opts?: CustomResourceOptions);

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

@overload
def List(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         account_id: Optional[str] = None,
         kind: Optional[str] = None,
         name: Optional[str] = None,
         description: Optional[str] = None,
         items: Optional[Sequence[ListItemArgs]] = None)

func NewList(ctx *Context, name string, args ListArgs, opts ...ResourceOption) (*List, error)

public List(string name, ListArgs args, CustomResourceOptions? opts = null)

public List(String name, ListArgs args)
public List(String name, ListArgs args, CustomResourceOptions options)

type: cloudflare:List
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 ListArgs: 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 ListArgs: 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 ListArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ListArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ListArgs: 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 listResource = new Cloudflare.List("listResource", new()
{
    AccountId = "string",
    Kind = "string",
    Name = "string",
    Description = "string",
    Items = new[]
    {
        new Cloudflare.Inputs.ListItemArgs
        {
            Value = new Cloudflare.Inputs.ListItemValueArgs
            {
                Ip = "string",
                Redirects = new[]
                {
                    new Cloudflare.Inputs.ListItemValueRedirectArgs
                    {
                        SourceUrl = "string",
                        TargetUrl = "string",
                        IncludeSubdomains = "string",
                        PreservePathSuffix = "string",
                        PreserveQueryString = "string",
                        StatusCode = 0,
                        SubpathMatching = "string",
                    },
                },
            },
            Comment = "string",
        },
    },
});

example, err := cloudflare.NewList(ctx, "listResource", &cloudflare.ListArgs{
	AccountId:   pulumi.String("string"),
	Kind:        pulumi.String("string"),
	Name:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Items: cloudflare.ListItemArray{
		&cloudflare.ListItemArgs{
			Value: &cloudflare.ListItemValueArgs{
				Ip: pulumi.String("string"),
				Redirects: cloudflare.ListItemValueRedirectArray{
					&cloudflare.ListItemValueRedirectArgs{
						SourceUrl:           pulumi.String("string"),
						TargetUrl:           pulumi.String("string"),
						IncludeSubdomains:   pulumi.String("string"),
						PreservePathSuffix:  pulumi.String("string"),
						PreserveQueryString: pulumi.String("string"),
						StatusCode:          pulumi.Int(0),
						SubpathMatching:     pulumi.String("string"),
					},
				},
			},
			Comment: pulumi.String("string"),
		},
	},
})

var listResource = new List("listResource", ListArgs.builder()
    .accountId("string")
    .kind("string")
    .name("string")
    .description("string")
    .items(ListItemArgs.builder()
        .value(ListItemValueArgs.builder()
            .ip("string")
            .redirects(ListItemValueRedirectArgs.builder()
                .sourceUrl("string")
                .targetUrl("string")
                .includeSubdomains("string")
                .preservePathSuffix("string")
                .preserveQueryString("string")
                .statusCode(0)
                .subpathMatching("string")
                .build())
            .build())
        .comment("string")
        .build())
    .build());

list_resource = cloudflare.List("listResource",
    account_id="string",
    kind="string",
    name="string",
    description="string",
    items=[{
        "value": {
            "ip": "string",
            "redirects": [{
                "source_url": "string",
                "target_url": "string",
                "include_subdomains": "string",
                "preserve_path_suffix": "string",
                "preserve_query_string": "string",
                "status_code": 0,
                "subpath_matching": "string",
            }],
        },
        "comment": "string",
    }])

const listResource = new cloudflare.List("listResource", {
    accountId: "string",
    kind: "string",
    name: "string",
    description: "string",
    items: [{
        value: {
            ip: "string",
            redirects: [{
                sourceUrl: "string",
                targetUrl: "string",
                includeSubdomains: "string",
                preservePathSuffix: "string",
                preserveQueryString: "string",
                statusCode: 0,
                subpathMatching: "string",
            }],
        },
        comment: "string",
    }],
});

type: cloudflare:List
properties:
    accountId: string
    description: string
    items:
        - comment: string
          value:
            ip: string
            redirects:
                - includeSubdomains: string
                  preservePathSuffix: string
                  preserveQueryString: string
                  sourceUrl: string
                  statusCode: 0
                  subpathMatching: string
                  targetUrl: string
    kind: string
    name: string

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

AccountId string: The account identifier to target for the resource.
Kind string: The type of items the list will contain.
Name string: The name of the list. Modifying this attribute will force creation of a new resource.
Description string: An optional description of the list.
Items List<ListItem>

AccountId string: The account identifier to target for the resource.
Kind string: The type of items the list will contain.
Name string: The name of the list. Modifying this attribute will force creation of a new resource.
Description string: An optional description of the list.
Items []ListItemArgs

accountId String: The account identifier to target for the resource.
kind String: The type of items the list will contain.
name String: The name of the list. Modifying this attribute will force creation of a new resource.
description String: An optional description of the list.
items List<ListItem>

accountId string: The account identifier to target for the resource.
kind string: The type of items the list will contain.
name string: The name of the list. Modifying this attribute will force creation of a new resource.
description string: An optional description of the list.
items ListItem[]

account_id str: The account identifier to target for the resource.
kind str: The type of items the list will contain.
name str: The name of the list. Modifying this attribute will force creation of a new resource.
description str: An optional description of the list.
items Sequence[ListItemArgs]

accountId String: The account identifier to target for the resource.
kind String: The type of items the list will contain.
name String: The name of the list. Modifying this attribute will force creation of a new resource.
description String: An optional description of the list.
items List<Property Map>

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        description: Optional[str] = None,
        items: Optional[Sequence[ListItemArgs]] = None,
        kind: Optional[str] = None,
        name: Optional[str] = None) -> List

func GetList(ctx *Context, name string, id IDInput, state *ListState, opts ...ResourceOption) (*List, error)

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

public static List get(String name, Output<String> id, ListState state, CustomResourceOptions options)

resources:  _:    type: cloudflare:List    get:      id: ${id}

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: An optional description of the list.
Items List<ListItem>
Kind string: The type of items the list will contain.
Name string: The name of the list. Modifying this attribute will force creation of a new resource.

AccountId string: The account identifier to target for the resource.
Description string: An optional description of the list.
Items []ListItemArgs
Kind string: The type of items the list will contain.
Name string: The name of the list. Modifying this attribute will force creation of a new resource.

accountId String: The account identifier to target for the resource.
description String: An optional description of the list.
items List<ListItem>
kind String: The type of items the list will contain.
name String: The name of the list. Modifying this attribute will force creation of a new resource.

accountId string: The account identifier to target for the resource.
description string: An optional description of the list.
items ListItem[]
kind string: The type of items the list will contain.
name string: The name of the list. Modifying this attribute will force creation of a new resource.

account_id str: The account identifier to target for the resource.
description str: An optional description of the list.
items Sequence[ListItemArgs]
kind str: The type of items the list will contain.
name str: The name of the list. Modifying this attribute will force creation of a new resource.

accountId String: The account identifier to target for the resource.
description String: An optional description of the list.
items List<Property Map>
kind String: The type of items the list will contain.
name String: The name of the list. Modifying this attribute will force creation of a new resource.

Supporting Types

ListItem, ListItemArgs

Value ListItemValue
Comment string: An optional comment for the item.

Value ListItemValue
Comment string: An optional comment for the item.

value ListItemValue
comment String: An optional comment for the item.

value ListItemValue
comment string: An optional comment for the item.

value ListItemValue
comment str: An optional comment for the item.

value Property Map
comment String: An optional comment for the item.

ListItemValue, ListItemValueArgs

Ip string
Redirects List<ListItemValueRedirect>

Ip string
Redirects []ListItemValueRedirect

ip String
redirects List<ListItemValueRedirect>

ip string
redirects ListItemValueRedirect[]

ip str
redirects Sequence[ListItemValueRedirect]

ip String
redirects List<Property Map>

ListItemValueRedirect, ListItemValueRedirectArgs

SourceUrl string
TargetUrl string
IncludeSubdomains string
PreservePathSuffix string
PreserveQueryString string
StatusCode int
SubpathMatching string

SourceUrl string
TargetUrl string
IncludeSubdomains string
PreservePathSuffix string
PreserveQueryString string
StatusCode int
SubpathMatching string

sourceUrl String
targetUrl String
includeSubdomains String
preservePathSuffix String
preserveQueryString String
statusCode Integer
subpathMatching String

sourceUrl string
targetUrl string
includeSubdomains string
preservePathSuffix string
preserveQueryString string
statusCode number
subpathMatching string

source_url str
target_url str
include_subdomains str
preserve_path_suffix str
preserve_query_string str
status_code int
subpath_matching str

sourceUrl String
targetUrl String
includeSubdomains String
preservePathSuffix String
preserveQueryString String
statusCode Number
subpathMatching String

Import

 $ pulumi import cloudflare:index/list:List example <account_id>/<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.

Viewing docs for Cloudflare v4.16.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-cloudflare

cloudflare.List

On this page

On this page

Example Usage

Create List Resource

Constructor syntax

Parameters

Constructor example

List Resource Properties

Inputs

Outputs

Look up Existing List Resource

Supporting Types

ListItem, ListItemArgs

ListItemValue, ListItemValueArgs

ListItemValueRedirect, ListItemValueRedirectArgs

Import

Package Details

On this page

On this page