cloudflare.getList

Explore with Pulumi AI

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

Example Usage

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

const exampleList = cloudflare.getList({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    listId: "2c0fc9fa937b11eaa1b71c4d701ab86e",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_list = cloudflare.get_list(account_id="023e105f4ecef8ad9ca31a8372d0c353",
    list_id="2c0fc9fa937b11eaa1b71c4d701ab86e")

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.LookupList(ctx, &cloudflare.LookupListArgs{
			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
			ListId:    pulumi.StringRef("2c0fc9fa937b11eaa1b71c4d701ab86e"),
		}, 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 exampleList = Cloudflare.GetList.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        ListId = "2c0fc9fa937b11eaa1b71c4d701ab86e",
    });

});

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.GetListArgs;
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 exampleList = CloudflareFunctions.getList(GetListArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .listId("2c0fc9fa937b11eaa1b71c4d701ab86e")
            .build());

    }
}

variables:
  exampleList:
    fn::invoke:
      function: cloudflare:getList
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        listId: 2c0fc9fa937b11eaa1b71c4d701ab86e

Using getList

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.

function getList(args: GetListArgs, opts?: InvokeOptions): Promise<GetListResult>
function getListOutput(args: GetListOutputArgs, opts?: InvokeOptions): Output<GetListResult>

def get_list(account_id: Optional[str] = None,
             list_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetListResult
def get_list_output(account_id: Optional[pulumi.Input[str]] = None,
             list_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetListResult]

func LookupList(ctx *Context, args *LookupListArgs, opts ...InvokeOption) (*LookupListResult, error)
func LookupListOutput(ctx *Context, args *LookupListOutputArgs, opts ...InvokeOption) LookupListResultOutput

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

public static class GetList 
{
    public static Task<GetListResult> InvokeAsync(GetListArgs args, InvokeOptions? opts = null)
    public static Output<GetListResult> Invoke(GetListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetListResult> getList(GetListArgs args, InvokeOptions options)
public static Output<GetListResult> getList(GetListArgs args, InvokeOptions options)

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

The following arguments are supported:

AccountId string: Identifier
ListId string: The unique ID of the list.

AccountId string: Identifier
ListId string: The unique ID of the list.

accountId String: Identifier
listId String: The unique ID of the list.

accountId string: Identifier
listId string: The unique ID of the list.

account_id str: Identifier
list_id str: The unique ID of the list.

accountId String: Identifier
listId String: The unique ID of the list.

getList Result

The following output properties are available:

AccountId string: Identifier
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.
ListId string: The unique ID of the list.

AccountId string: Identifier
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.
ListId string: The unique ID of the list.

accountId String: Identifier
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.
listId String: The unique ID of the list.

accountId string: Identifier
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.
listId string: The unique ID of the list.

account_id str: Identifier
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.
list_id str: The unique ID of the list.

accountId String: Identifier
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.
listId String: The unique ID of 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.1.2 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getList

On this page

On this page

Example Usage

Using getList

getList Result

Package Details

On this page

On this page