Cloudflare v6.0.1, Apr 16 25

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.getLists

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleLists = cloudflare.getLists({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_lists = cloudflare.get_lists(account_id="023e105f4ecef8ad9ca31a8372d0c353")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupLists(ctx, &cloudflare.LookupListsArgs{
			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
		}, nil)
		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 exampleLists = Cloudflare.GetLists.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetListsArgs;
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) {
        final var exampleLists = CloudflareFunctions.getLists(GetListsArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .build());

    }
}

variables:
  exampleLists:
    fn::invoke:
      function: cloudflare:getLists
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353

Using getLists

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getLists(args: GetListsArgs, opts?: InvokeOptions): Promise<GetListsResult>
function getListsOutput(args: GetListsOutputArgs, opts?: InvokeOptions): Output<GetListsResult>

def get_lists(account_id: Optional[str] = None,
              max_items: Optional[int] = None,
              opts: Optional[InvokeOptions] = None) -> GetListsResult
def get_lists_output(account_id: Optional[pulumi.Input[str]] = None,
              max_items: Optional[pulumi.Input[int]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetListsResult]

func LookupLists(ctx *Context, args *LookupListsArgs, opts ...InvokeOption) (*LookupListsResult, error)
func LookupListsOutput(ctx *Context, args *LookupListsOutputArgs, opts ...InvokeOption) LookupListsResultOutput

> Note: This function is named LookupLists in the Go SDK.

public static class GetLists 
{
    public static Task<GetListsResult> InvokeAsync(GetListsArgs args, InvokeOptions? opts = null)
    public static Output<GetListsResult> Invoke(GetListsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetListsResult> getLists(GetListsArgs args, InvokeOptions options)
public static Output<GetListsResult> getLists(GetListsArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getLists:getLists
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string: Identifier
MaxItems int: Max items to fetch, default: 1000

AccountId string: Identifier
MaxItems int: Max items to fetch, default: 1000

accountId String: Identifier
maxItems Integer: Max items to fetch, default: 1000

accountId string: Identifier
maxItems number: Max items to fetch, default: 1000

account_id str: Identifier
max_items int: Max items to fetch, default: 1000

accountId String: Identifier
maxItems Number: Max items to fetch, default: 1000

getLists Result

The following output properties are available:

AccountId string: Identifier
Id string: The provider-assigned unique ID for this managed resource.
Results List<GetListsResult>: The items returned by the data source
MaxItems int: Max items to fetch, default: 1000

AccountId string: Identifier
Id string: The provider-assigned unique ID for this managed resource.
Results []GetListsResult: The items returned by the data source
MaxItems int: Max items to fetch, default: 1000

accountId String: Identifier
id String: The provider-assigned unique ID for this managed resource.
results List<GetListsResult>: The items returned by the data source
maxItems Integer: Max items to fetch, default: 1000

accountId string: Identifier
id string: The provider-assigned unique ID for this managed resource.
results GetListsResult[]: The items returned by the data source
maxItems number: Max items to fetch, default: 1000

account_id str: Identifier
id str: The provider-assigned unique ID for this managed resource.
results Sequence[GetListsResult]: The items returned by the data source
max_items int: Max items to fetch, default: 1000

accountId String: Identifier
id String: The provider-assigned unique ID for this managed resource.
results List<Property Map>: The items returned by the data source
maxItems Number: Max items to fetch, default: 1000

Supporting Types

GetListsResult

CreatedOn string: The RFC 3339 timestamp of when the list was created.
Description string: An informative summary of the list.
Id string: The unique ID of the list.
Kind string: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
ModifiedOn string: The RFC 3339 timestamp of when the list was last modified.
Name string: An informative name for the list. Use this name in filter and rule expressions.
NumItems double: The number of items in the list.
NumReferencingFilters double: The number of filters referencing the list.

CreatedOn string: The RFC 3339 timestamp of when the list was created.
Description string: An informative summary of the list.
Id string: The unique ID of the list.
Kind string: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
ModifiedOn string: The RFC 3339 timestamp of when the list was last modified.
Name string: An informative name for the list. Use this name in filter and rule expressions.
NumItems float64: The number of items in the list.
NumReferencingFilters float64: The number of filters referencing the list.

createdOn String: The RFC 3339 timestamp of when the list was created.
description String: An informative summary of the list.
id String: The unique ID of the list.
kind String: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
modifiedOn String: The RFC 3339 timestamp of when the list was last modified.
name String: An informative name for the list. Use this name in filter and rule expressions.
numItems Double: The number of items in the list.
numReferencingFilters Double: The number of filters referencing the list.

createdOn string: The RFC 3339 timestamp of when the list was created.
description string: An informative summary of the list.
id string: The unique ID of the list.
kind string: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
modifiedOn string: The RFC 3339 timestamp of when the list was last modified.
name string: An informative name for the list. Use this name in filter and rule expressions.
numItems number: The number of items in the list.
numReferencingFilters number: The number of filters referencing the list.

created_on str: The RFC 3339 timestamp of when the list was created.
description str: An informative summary of the list.
id str: The unique ID of the list.
kind str: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
modified_on str: The RFC 3339 timestamp of when the list was last modified.
name str: An informative name for the list. Use this name in filter and rule expressions.
num_items float: The number of items in the list.
num_referencing_filters float: The number of filters referencing the list.

createdOn String: The RFC 3339 timestamp of when the list was created.
description String: An informative summary of the list.
id String: The unique ID of the list.
kind String: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
modifiedOn String: The RFC 3339 timestamp of when the list was last modified.
name String: An informative name for the list. Use this name in filter and rule expressions.
numItems Number: The number of items in the list.
numReferencingFilters Number: The number of filters referencing the list.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getLists

On this page

On this page

Example Usage

Using getLists

getLists Result

Supporting Types

GetListsResult

Package Details

On this page

On this page