Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getPageShieldCookiesList
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.getPageShieldCookiesList

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

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

const examplePageShieldCookiesList = cloudflare.getPageShieldCookiesList({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    direction: "asc",
    domain: "example.com",
    "export": "csv",
    hosts: "blog.cloudflare.com,www.example*,*cloudflare.com",
    httpOnly: true,
    name: "session_id",
    orderBy: "first_seen_at",
    page: "2",
    pageUrl: "example.com/page,*/checkout,example.com/*,*checkout*",
    path: "/",
    perPage: 100,
    sameSite: "strict",
    secure: true,
    type: "first_party",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_page_shield_cookies_list = cloudflare.get_page_shield_cookies_list(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    direction="asc",
    domain="example.com",
    export="csv",
    hosts="blog.cloudflare.com,www.example*,*cloudflare.com",
    http_only=True,
    name="session_id",
    order_by="first_seen_at",
    page="2",
    page_url="example.com/page,*/checkout,example.com/*,*checkout*",
    path="/",
    per_page=100,
    same_site="strict",
    secure=True,
    type="first_party")

    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.LookupPageShieldCookiesList(ctx, &cloudflare.LookupPageShieldCookiesListArgs{
			ZoneId:    "023e105f4ecef8ad9ca31a8372d0c353",
			Direction: pulumi.StringRef("asc"),
			Domain:    pulumi.StringRef("example.com"),
			Export:    pulumi.StringRef("csv"),
			Hosts:     pulumi.StringRef("blog.cloudflare.com,www.example*,*cloudflare.com"),
			HttpOnly:  pulumi.BoolRef(true),
			Name:      pulumi.StringRef("session_id"),
			OrderBy:   pulumi.StringRef("first_seen_at"),
			Page:      pulumi.StringRef("2"),
			PageUrl:   pulumi.StringRef("example.com/page,*/checkout,example.com/*,*checkout*"),
			Path:      pulumi.StringRef("/"),
			PerPage:   pulumi.Float64Ref(100),
			SameSite:  pulumi.StringRef("strict"),
			Secure:    pulumi.BoolRef(true),
			Type:      pulumi.StringRef("first_party"),
		}, 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 examplePageShieldCookiesList = Cloudflare.GetPageShieldCookiesList.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Direction = "asc",
        Domain = "example.com",
        Export = "csv",
        Hosts = "blog.cloudflare.com,www.example*,*cloudflare.com",
        HttpOnly = true,
        Name = "session_id",
        OrderBy = "first_seen_at",
        Page = "2",
        PageUrl = "example.com/page,*/checkout,example.com/*,*checkout*",
        Path = "/",
        PerPage = 100,
        SameSite = "strict",
        Secure = true,
        Type = "first_party",
    });

});

    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.GetPageShieldCookiesListArgs;
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 examplePageShieldCookiesList = CloudflareFunctions.getPageShieldCookiesList(GetPageShieldCookiesListArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .direction("asc")
            .domain("example.com")
            .export("csv")
            .hosts("blog.cloudflare.com,www.example*,*cloudflare.com")
            .httpOnly(true)
            .name("session_id")
            .orderBy("first_seen_at")
            .page("2")
            .pageUrl("example.com/page,*/checkout,example.com/*,*checkout*")
            .path("/")
            .perPage(100)
            .sameSite("strict")
            .secure(true)
            .type("first_party")
            .build());

    }
}

    variables:
  examplePageShieldCookiesList:
    fn::invoke:
      function: cloudflare:getPageShieldCookiesList
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        direction: asc
        domain: example.com
        export: csv
        hosts: blog.cloudflare.com,www.example*,*cloudflare.com
        httpOnly: true
        name: session_id
        orderBy: first_seen_at
        page: '2'
        pageUrl: example.com/page,*/checkout,example.com/*,*checkout*
        path: /
        perPage: 100
        sameSite: strict
        secure: true
        type: first_party

    Using getPageShieldCookiesList

    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 getPageShieldCookiesList(args: GetPageShieldCookiesListArgs, opts?: InvokeOptions): Promise<GetPageShieldCookiesListResult>
function getPageShieldCookiesListOutput(args: GetPageShieldCookiesListOutputArgs, opts?: InvokeOptions): Output<GetPageShieldCookiesListResult>
    def get_page_shield_cookies_list(direction: Optional[str] = None,
                                 domain: Optional[str] = None,
                                 export: Optional[str] = None,
                                 hosts: Optional[str] = None,
                                 http_only: Optional[bool] = None,
                                 max_items: Optional[int] = None,
                                 name: Optional[str] = None,
                                 order_by: Optional[str] = None,
                                 page: Optional[str] = None,
                                 page_url: Optional[str] = None,
                                 path: Optional[str] = None,
                                 per_page: Optional[float] = None,
                                 same_site: Optional[str] = None,
                                 secure: Optional[bool] = None,
                                 type: Optional[str] = None,
                                 zone_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetPageShieldCookiesListResult
def get_page_shield_cookies_list_output(direction: Optional[pulumi.Input[str]] = None,
                                 domain: Optional[pulumi.Input[str]] = None,
                                 export: Optional[pulumi.Input[str]] = None,
                                 hosts: Optional[pulumi.Input[str]] = None,
                                 http_only: Optional[pulumi.Input[bool]] = None,
                                 max_items: Optional[pulumi.Input[int]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 order_by: Optional[pulumi.Input[str]] = None,
                                 page: Optional[pulumi.Input[str]] = None,
                                 page_url: Optional[pulumi.Input[str]] = None,
                                 path: Optional[pulumi.Input[str]] = None,
                                 per_page: Optional[pulumi.Input[float]] = None,
                                 same_site: Optional[pulumi.Input[str]] = None,
                                 secure: Optional[pulumi.Input[bool]] = None,
                                 type: Optional[pulumi.Input[str]] = None,
                                 zone_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetPageShieldCookiesListResult]
    func LookupPageShieldCookiesList(ctx *Context, args *LookupPageShieldCookiesListArgs, opts ...InvokeOption) (*LookupPageShieldCookiesListResult, error)
func LookupPageShieldCookiesListOutput(ctx *Context, args *LookupPageShieldCookiesListOutputArgs, opts ...InvokeOption) LookupPageShieldCookiesListResultOutput

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

    public static class GetPageShieldCookiesList 
{
    public static Task<GetPageShieldCookiesListResult> InvokeAsync(GetPageShieldCookiesListArgs args, InvokeOptions? opts = null)
    public static Output<GetPageShieldCookiesListResult> Invoke(GetPageShieldCookiesListInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPageShieldCookiesListResult> getPageShieldCookiesList(GetPageShieldCookiesListArgs args, InvokeOptions options)
public static Output<GetPageShieldCookiesListResult> getPageShieldCookiesList(GetPageShieldCookiesListArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ZoneId string
    Identifier
    Direction string
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    Domain string
    Filters the returned cookies that match the specified domain attribute
    Export string
    Export the list of cookies as a file. Available values: "csv".
    Hosts string
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    HttpOnly bool
    MaxItems int
    Name string
    OrderBy string
    Page string
    PageUrl string
    Path string
    PerPage double
    SameSite string
    Secure bool
    Type string
    ZoneId string
    Identifier
    Direction string
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    Domain string
    Filters the returned cookies that match the specified domain attribute
    Export string
    Export the list of cookies as a file. Available values: "csv".
    Hosts string
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    HttpOnly bool
    MaxItems int
    Name string
    OrderBy string
    Page string
    PageUrl string
    Path string
    PerPage float64
    SameSite string
    Secure bool
    Type string
    zoneId String
    Identifier
    direction String
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    domain String
    Filters the returned cookies that match the specified domain attribute
    export String
    Export the list of cookies as a file. Available values: "csv".
    hosts String
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    httpOnly Boolean
    maxItems Integer
    name String
    orderBy String
    page String
    pageUrl String
    path String
    perPage Double
    sameSite String
    secure Boolean
    type String
    zoneId string
    Identifier
    direction string
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    domain string
    Filters the returned cookies that match the specified domain attribute
    export string
    Export the list of cookies as a file. Available values: "csv".
    hosts string
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    httpOnly boolean
    maxItems number
    name string
    orderBy string
    page string
    pageUrl string
    path string
    perPage number
    sameSite string
    secure boolean
    type string
    zone_id str
    Identifier
    direction str
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    domain str
    Filters the returned cookies that match the specified domain attribute
    export str
    Export the list of cookies as a file. Available values: "csv".
    hosts str
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    http_only bool
    max_items int
    name str
    order_by str
    page str
    page_url str
    path str
    per_page float
    same_site str
    secure bool
    type str
    zoneId String
    Identifier
    direction String
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    domain String
    Filters the returned cookies that match the specified domain attribute
    export String
    Export the list of cookies as a file. Available values: "csv".
    hosts String
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    httpOnly Boolean
    maxItems Number
    name String
    orderBy String
    page String
    pageUrl String
    path String
    perPage Number
    sameSite String
    secure Boolean
    type String

    getPageShieldCookiesList Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetPageShieldCookiesListResult>
    ZoneId string
    Identifier
    Direction string
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    Domain string
    Filters the returned cookies that match the specified domain attribute
    Export string
    Export the list of cookies as a file. Available values: "csv".
    Hosts string
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    HttpOnly bool
    MaxItems int
    Name string
    OrderBy string
    Page string
    PageUrl string
    Path string
    PerPage double
    SameSite string
    Secure bool
    Type string
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetPageShieldCookiesListResult
    ZoneId string
    Identifier
    Direction string
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    Domain string
    Filters the returned cookies that match the specified domain attribute
    Export string
    Export the list of cookies as a file. Available values: "csv".
    Hosts string
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    HttpOnly bool
    MaxItems int
    Name string
    OrderBy string
    Page string
    PageUrl string
    Path string
    PerPage float64
    SameSite string
    Secure bool
    Type string
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetPageShieldCookiesListResult>
    zoneId String
    Identifier
    direction String
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    domain String
    Filters the returned cookies that match the specified domain attribute
    export String
    Export the list of cookies as a file. Available values: "csv".
    hosts String
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    httpOnly Boolean
    maxItems Integer
    name String
    orderBy String
    page String
    pageUrl String
    path String
    perPage Double
    sameSite String
    secure Boolean
    type String
    id string
    The provider-assigned unique ID for this managed resource.
    results GetPageShieldCookiesListResult[]
    zoneId string
    Identifier
    direction string
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    domain string
    Filters the returned cookies that match the specified domain attribute
    export string
    Export the list of cookies as a file. Available values: "csv".
    hosts string
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    httpOnly boolean
    maxItems number
    name string
    orderBy string
    page string
    pageUrl string
    path string
    perPage number
    sameSite string
    secure boolean
    type string
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetPageShieldCookiesListResult]
    zone_id str
    Identifier
    direction str
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    domain str
    Filters the returned cookies that match the specified domain attribute
    export str
    Export the list of cookies as a file. Available values: "csv".
    hosts str
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    http_only bool
    max_items int
    name str
    order_by str
    page str
    page_url str
    path str
    per_page float
    same_site str
    secure bool
    type str
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    zoneId String
    Identifier
    direction String
    The direction used to sort returned cookies.' Available values: "asc", "desc".
    domain String
    Filters the returned cookies that match the specified domain attribute
    export String
    Export the list of cookies as a file. Available values: "csv".
    hosts String
    Includes cookies that match one or more URL-encoded hostnames separated by commas.
    httpOnly Boolean
    maxItems Number
    name String
    orderBy String
    page String
    pageUrl String
    path String
    perPage Number
    sameSite String
    secure Boolean
    type String

    Supporting Types

    GetPageShieldCookiesListResult

    DomainAttribute string
    ExpiresAttribute string
    FirstSeenAt string
    Host string
    HttpOnlyAttribute bool
    Id string
    Identifier
    LastSeenAt string
    MaxAgeAttribute int
    Name string
    PageUrls List<string>
    PathAttribute string
    SameSiteAttribute string
    Available values: "lax", "strict", "none".
    SecureAttribute bool
    Type string
    Available values: "first_party", "unknown".
    DomainAttribute string
    ExpiresAttribute string
    FirstSeenAt string
    Host string
    HttpOnlyAttribute bool
    Id string
    Identifier
    LastSeenAt string
    MaxAgeAttribute int
    Name string
    PageUrls []string
    PathAttribute string
    SameSiteAttribute string
    Available values: "lax", "strict", "none".
    SecureAttribute bool
    Type string
    Available values: "first_party", "unknown".
    domainAttribute String
    expiresAttribute String
    firstSeenAt String
    host String
    httpOnlyAttribute Boolean
    id String
    Identifier
    lastSeenAt String
    maxAgeAttribute Integer
    name String
    pageUrls List<String>
    pathAttribute String
    sameSiteAttribute String
    Available values: "lax", "strict", "none".
    secureAttribute Boolean
    type String
    Available values: "first_party", "unknown".
    domainAttribute string
    expiresAttribute string
    firstSeenAt string
    host string
    httpOnlyAttribute boolean
    id string
    Identifier
    lastSeenAt string
    maxAgeAttribute number
    name string
    pageUrls string[]
    pathAttribute string
    sameSiteAttribute string
    Available values: "lax", "strict", "none".
    secureAttribute boolean
    type string
    Available values: "first_party", "unknown".
    domain_attribute str
    expires_attribute str
    first_seen_at str
    host str
    http_only_attribute bool
    id str
    Identifier
    last_seen_at str
    max_age_attribute int
    name str
    page_urls Sequence[str]
    path_attribute str
    same_site_attribute str
    Available values: "lax", "strict", "none".
    secure_attribute bool
    type str
    Available values: "first_party", "unknown".
    domainAttribute String
    expiresAttribute String
    firstSeenAt String
    host String
    httpOnlyAttribute Boolean
    id String
    Identifier
    lastSeenAt String
    maxAgeAttribute Number
    name String
    pageUrls List<String>
    pathAttribute String
    sameSiteAttribute String
    Available values: "lax", "strict", "none".
    secureAttribute Boolean
    type String
    Available values: "first_party", "unknown".

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare