1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getListItem
Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi

cloudflare.getListItem

Explore with Pulumi AI

Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi

Example Usage

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

const exampleListItem = cloudflare.getListItem({
    accountIdentifier: "023e105f4ecef8ad9ca31a8372d0c353",
    listId: "2c0fc9fa937b11eaa1b71c4d701ab86e",
    itemId: "34b12448945f11eaa1b71c4d701ab86e",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_list_item = cloudflare.get_list_item(account_identifier="023e105f4ecef8ad9ca31a8372d0c353",
    list_id="2c0fc9fa937b11eaa1b71c4d701ab86e",
    item_id="34b12448945f11eaa1b71c4d701ab86e")
Copy
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.LookupListItem(ctx, &cloudflare.LookupListItemArgs{
			AccountIdentifier: "023e105f4ecef8ad9ca31a8372d0c353",
			ListId:            "2c0fc9fa937b11eaa1b71c4d701ab86e",
			ItemId:            "34b12448945f11eaa1b71c4d701ab86e",
		}, nil)
		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 exampleListItem = Cloudflare.GetListItem.Invoke(new()
    {
        AccountIdentifier = "023e105f4ecef8ad9ca31a8372d0c353",
        ListId = "2c0fc9fa937b11eaa1b71c4d701ab86e",
        ItemId = "34b12448945f11eaa1b71c4d701ab86e",
    });

});
Copy
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.GetListItemArgs;
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 exampleListItem = CloudflareFunctions.getListItem(GetListItemArgs.builder()
            .accountIdentifier("023e105f4ecef8ad9ca31a8372d0c353")
            .listId("2c0fc9fa937b11eaa1b71c4d701ab86e")
            .itemId("34b12448945f11eaa1b71c4d701ab86e")
            .build());

    }
}
Copy
variables:
  exampleListItem:
    fn::invoke:
      function: cloudflare:getListItem
      arguments:
        accountIdentifier: 023e105f4ecef8ad9ca31a8372d0c353
        listId: 2c0fc9fa937b11eaa1b71c4d701ab86e
        itemId: 34b12448945f11eaa1b71c4d701ab86e
Copy

Using getListItem

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 getListItem(args: GetListItemArgs, opts?: InvokeOptions): Promise<GetListItemResult>
function getListItemOutput(args: GetListItemOutputArgs, opts?: InvokeOptions): Output<GetListItemResult>
Copy
def get_list_item(account_identifier: Optional[str] = None,
                  item_id: Optional[str] = None,
                  list_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetListItemResult
def get_list_item_output(account_identifier: Optional[pulumi.Input[str]] = None,
                  item_id: Optional[pulumi.Input[str]] = None,
                  list_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetListItemResult]
Copy
func LookupListItem(ctx *Context, args *LookupListItemArgs, opts ...InvokeOption) (*LookupListItemResult, error)
func LookupListItemOutput(ctx *Context, args *LookupListItemOutputArgs, opts ...InvokeOption) LookupListItemResultOutput
Copy

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

public static class GetListItem 
{
    public static Task<GetListItemResult> InvokeAsync(GetListItemArgs args, InvokeOptions? opts = null)
    public static Output<GetListItemResult> Invoke(GetListItemInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetListItemResult> getListItem(GetListItemArgs args, InvokeOptions options)
public static Output<GetListItemResult> getListItem(GetListItemArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cloudflare:index/getListItem:getListItem
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountIdentifier This property is required. string
Identifier
ItemId This property is required. string
The unique ID of the item in the List.
ListId This property is required. string
The unique ID of the list.
AccountIdentifier This property is required. string
Identifier
ItemId This property is required. string
The unique ID of the item in the List.
ListId This property is required. string
The unique ID of the list.
accountIdentifier This property is required. String
Identifier
itemId This property is required. String
The unique ID of the item in the List.
listId This property is required. String
The unique ID of the list.
accountIdentifier This property is required. string
Identifier
itemId This property is required. string
The unique ID of the item in the List.
listId This property is required. string
The unique ID of the list.
account_identifier This property is required. str
Identifier
item_id This property is required. str
The unique ID of the item in the List.
list_id This property is required. str
The unique ID of the list.
accountIdentifier This property is required. String
Identifier
itemId This property is required. String
The unique ID of the item in the List.
listId This property is required. String
The unique ID of the list.

getListItem Result

The following output properties are available:

AccountIdentifier string
Identifier
Asn int
A non-negative 32 bit integer
Comment string
An informative summary of the list item.
CreatedOn string
The RFC 3339 timestamp of when the item was created.
Hostname GetListItemHostname
Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
Id string
The unique ID of the list.
Ip string
An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
ItemId string
The unique ID of the item in the List.
ListId string
The unique ID of the list.
ModifiedOn string
The RFC 3339 timestamp of when the item was last modified.
Redirect GetListItemRedirect
The definition of the redirect.
AccountIdentifier string
Identifier
Asn int
A non-negative 32 bit integer
Comment string
An informative summary of the list item.
CreatedOn string
The RFC 3339 timestamp of when the item was created.
Hostname GetListItemHostname
Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
Id string
The unique ID of the list.
Ip string
An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
ItemId string
The unique ID of the item in the List.
ListId string
The unique ID of the list.
ModifiedOn string
The RFC 3339 timestamp of when the item was last modified.
Redirect GetListItemRedirect
The definition of the redirect.
accountIdentifier String
Identifier
asn Integer
A non-negative 32 bit integer
comment String
An informative summary of the list item.
createdOn String
The RFC 3339 timestamp of when the item was created.
hostname GetListItemHostname
Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
id String
The unique ID of the list.
ip String
An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
itemId String
The unique ID of the item in the List.
listId String
The unique ID of the list.
modifiedOn String
The RFC 3339 timestamp of when the item was last modified.
redirect GetListItemRedirect
The definition of the redirect.
accountIdentifier string
Identifier
asn number
A non-negative 32 bit integer
comment string
An informative summary of the list item.
createdOn string
The RFC 3339 timestamp of when the item was created.
hostname GetListItemHostname
Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
id string
The unique ID of the list.
ip string
An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
itemId string
The unique ID of the item in the List.
listId string
The unique ID of the list.
modifiedOn string
The RFC 3339 timestamp of when the item was last modified.
redirect GetListItemRedirect
The definition of the redirect.
account_identifier str
Identifier
asn int
A non-negative 32 bit integer
comment str
An informative summary of the list item.
created_on str
The RFC 3339 timestamp of when the item was created.
hostname GetListItemHostname
Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
id str
The unique ID of the list.
ip str
An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
item_id str
The unique ID of the item in the List.
list_id str
The unique ID of the list.
modified_on str
The RFC 3339 timestamp of when the item was last modified.
redirect GetListItemRedirect
The definition of the redirect.
accountIdentifier String
Identifier
asn Number
A non-negative 32 bit integer
comment String
An informative summary of the list item.
createdOn String
The RFC 3339 timestamp of when the item was created.
hostname Property Map
Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
id String
The unique ID of the list.
ip String
An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
itemId String
The unique ID of the item in the List.
listId String
The unique ID of the list.
modifiedOn String
The RFC 3339 timestamp of when the item was last modified.
redirect Property Map
The definition of the redirect.

Supporting Types

GetListItemHostname

UrlHostname This property is required. string
UrlHostname This property is required. string
urlHostname This property is required. String
urlHostname This property is required. string
url_hostname This property is required. str
urlHostname This property is required. String

GetListItemRedirect

IncludeSubdomains This property is required. bool
PreservePathSuffix This property is required. bool
PreserveQueryString This property is required. bool
SourceUrl This property is required. string
StatusCode This property is required. int
Available values: 301, 302, 307, 308.
SubpathMatching This property is required. bool
TargetUrl This property is required. string
IncludeSubdomains This property is required. bool
PreservePathSuffix This property is required. bool
PreserveQueryString This property is required. bool
SourceUrl This property is required. string
StatusCode This property is required. int
Available values: 301, 302, 307, 308.
SubpathMatching This property is required. bool
TargetUrl This property is required. string
includeSubdomains This property is required. Boolean
preservePathSuffix This property is required. Boolean
preserveQueryString This property is required. Boolean
sourceUrl This property is required. String
statusCode This property is required. Integer
Available values: 301, 302, 307, 308.
subpathMatching This property is required. Boolean
targetUrl This property is required. String
includeSubdomains This property is required. boolean
preservePathSuffix This property is required. boolean
preserveQueryString This property is required. boolean
sourceUrl This property is required. string
statusCode This property is required. number
Available values: 301, 302, 307, 308.
subpathMatching This property is required. boolean
targetUrl This property is required. string
include_subdomains This property is required. bool
preserve_path_suffix This property is required. bool
preserve_query_string This property is required. bool
source_url This property is required. str
status_code This property is required. int
Available values: 301, 302, 307, 308.
subpath_matching This property is required. bool
target_url This property is required. str
includeSubdomains This property is required. Boolean
preservePathSuffix This property is required. Boolean
preserveQueryString This property is required. Boolean
sourceUrl This property is required. String
statusCode This property is required. Number
Available values: 301, 302, 307, 308.
subpathMatching This property is required. Boolean
targetUrl This property is required. String

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.0 published on Friday, Apr 18, 2025 by Pulumi