1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getSnippetsList
Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.getSnippetsList

Explore with Pulumi AI

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

Example Usage

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

const exampleSnippetsList = cloudflare.getSnippetsList({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_snippets_list = cloudflare.get_snippets_list(zone_id="023e105f4ecef8ad9ca31a8372d0c353")
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.LookupSnippetsList(ctx, &cloudflare.LookupSnippetsListArgs{
			ZoneId: "023e105f4ecef8ad9ca31a8372d0c353",
		}, 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 exampleSnippetsList = Cloudflare.GetSnippetsList.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
    });

});
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.GetSnippetsListArgs;
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 exampleSnippetsList = CloudflareFunctions.getSnippetsList(GetSnippetsListArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .build());

    }
}
Copy
variables:
  exampleSnippetsList:
    fn::invoke:
      function: cloudflare:getSnippetsList
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
Copy

Using getSnippetsList

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 getSnippetsList(args: GetSnippetsListArgs, opts?: InvokeOptions): Promise<GetSnippetsListResult>
function getSnippetsListOutput(args: GetSnippetsListOutputArgs, opts?: InvokeOptions): Output<GetSnippetsListResult>
Copy
def get_snippets_list(max_items: Optional[int] = None,
                      zone_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSnippetsListResult
def get_snippets_list_output(max_items: Optional[pulumi.Input[int]] = None,
                      zone_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSnippetsListResult]
Copy
func LookupSnippetsList(ctx *Context, args *LookupSnippetsListArgs, opts ...InvokeOption) (*LookupSnippetsListResult, error)
func LookupSnippetsListOutput(ctx *Context, args *LookupSnippetsListOutputArgs, opts ...InvokeOption) LookupSnippetsListResultOutput
Copy

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

public static class GetSnippetsList 
{
    public static Task<GetSnippetsListResult> InvokeAsync(GetSnippetsListArgs args, InvokeOptions? opts = null)
    public static Output<GetSnippetsListResult> Invoke(GetSnippetsListInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSnippetsListResult> getSnippetsList(GetSnippetsListArgs args, InvokeOptions options)
public static Output<GetSnippetsListResult> getSnippetsList(GetSnippetsListArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cloudflare:index/getSnippetsList:getSnippetsList
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ZoneId This property is required. string
Identifier
MaxItems int
Max items to fetch, default: 1000
ZoneId This property is required. string
Identifier
MaxItems int
Max items to fetch, default: 1000
zoneId This property is required. String
Identifier
maxItems Integer
Max items to fetch, default: 1000
zoneId This property is required. string
Identifier
maxItems number
Max items to fetch, default: 1000
zone_id This property is required. str
Identifier
max_items int
Max items to fetch, default: 1000
zoneId This property is required. String
Identifier
maxItems Number
Max items to fetch, default: 1000

getSnippetsList Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Results List<GetSnippetsListResult>
The items returned by the data source
ZoneId string
Identifier
MaxItems int
Max items to fetch, default: 1000
Id string
The provider-assigned unique ID for this managed resource.
Results []GetSnippetsListResult
The items returned by the data source
ZoneId string
Identifier
MaxItems int
Max items to fetch, default: 1000
id String
The provider-assigned unique ID for this managed resource.
results List<GetSnippetsListResult>
The items returned by the data source
zoneId String
Identifier
maxItems Integer
Max items to fetch, default: 1000
id string
The provider-assigned unique ID for this managed resource.
results GetSnippetsListResult[]
The items returned by the data source
zoneId string
Identifier
maxItems number
Max items to fetch, default: 1000
id str
The provider-assigned unique ID for this managed resource.
results Sequence[GetSnippetsListResult]
The items returned by the data source
zone_id str
Identifier
max_items int
Max items to fetch, default: 1000
id String
The provider-assigned unique ID for this managed resource.
results List<Property Map>
The items returned by the data source
zoneId String
Identifier
maxItems Number
Max items to fetch, default: 1000

Supporting Types

GetSnippetsListResult

CreatedOn This property is required. string
Creation time of the snippet
ModifiedOn This property is required. string
Modification time of the snippet
SnippetName This property is required. string
Snippet identifying name
CreatedOn This property is required. string
Creation time of the snippet
ModifiedOn This property is required. string
Modification time of the snippet
SnippetName This property is required. string
Snippet identifying name
createdOn This property is required. String
Creation time of the snippet
modifiedOn This property is required. String
Modification time of the snippet
snippetName This property is required. String
Snippet identifying name
createdOn This property is required. string
Creation time of the snippet
modifiedOn This property is required. string
Modification time of the snippet
snippetName This property is required. string
Snippet identifying name
created_on This property is required. str
Creation time of the snippet
modified_on This property is required. str
Modification time of the snippet
snippet_name This property is required. str
Snippet identifying name
createdOn This property is required. String
Creation time of the snippet
modifiedOn This property is required. String
Modification time of the snippet
snippetName This property is required. String
Snippet identifying name

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