1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getSnippets
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getSnippets

Explore with Pulumi AI

cloudflare logo
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 exampleSnippets = cloudflare.getSnippets({
        zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
        snippetName: "snippet_name_01",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_snippets = cloudflare.get_snippets(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
        snippet_name="snippet_name_01")
    
    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.LookupSnippets(ctx, &cloudflare.LookupSnippetsArgs{
    			ZoneId:      "023e105f4ecef8ad9ca31a8372d0c353",
    			SnippetName: "snippet_name_01",
    		}, 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 exampleSnippets = Cloudflare.GetSnippets.Invoke(new()
        {
            ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
            SnippetName = "snippet_name_01",
        });
    
    });
    
    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.GetSnippetsArgs;
    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 exampleSnippets = CloudflareFunctions.getSnippets(GetSnippetsArgs.builder()
                .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
                .snippetName("snippet_name_01")
                .build());
    
        }
    }
    
    variables:
      exampleSnippets:
        fn::invoke:
          function: cloudflare:getSnippets
          arguments:
            zoneId: 023e105f4ecef8ad9ca31a8372d0c353
            snippetName: snippet_name_01
    

    Using getSnippets

    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 getSnippets(args: GetSnippetsArgs, opts?: InvokeOptions): Promise<GetSnippetsResult>
    function getSnippetsOutput(args: GetSnippetsOutputArgs, opts?: InvokeOptions): Output<GetSnippetsResult>
    def get_snippets(snippet_name: Optional[str] = None,
                     zone_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSnippetsResult
    def get_snippets_output(snippet_name: Optional[pulumi.Input[str]] = None,
                     zone_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSnippetsResult]
    func LookupSnippets(ctx *Context, args *LookupSnippetsArgs, opts ...InvokeOption) (*LookupSnippetsResult, error)
    func LookupSnippetsOutput(ctx *Context, args *LookupSnippetsOutputArgs, opts ...InvokeOption) LookupSnippetsResultOutput

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

    public static class GetSnippets 
    {
        public static Task<GetSnippetsResult> InvokeAsync(GetSnippetsArgs args, InvokeOptions? opts = null)
        public static Output<GetSnippetsResult> Invoke(GetSnippetsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSnippetsResult> getSnippets(GetSnippetsArgs args, InvokeOptions options)
    public static Output<GetSnippetsResult> getSnippets(GetSnippetsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getSnippets:getSnippets
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SnippetName string
    Snippet identifying name
    ZoneId string
    Identifier
    SnippetName string
    Snippet identifying name
    ZoneId string
    Identifier
    snippetName String
    Snippet identifying name
    zoneId String
    Identifier
    snippetName string
    Snippet identifying name
    zoneId string
    Identifier
    snippet_name str
    Snippet identifying name
    zone_id str
    Identifier
    snippetName String
    Snippet identifying name
    zoneId String
    Identifier

    getSnippets Result

    The following output properties are available:

    CreatedOn string
    Creation time of the snippet
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    Modification time of the snippet
    SnippetName string
    Snippet identifying name
    ZoneId string
    Identifier
    CreatedOn string
    Creation time of the snippet
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    Modification time of the snippet
    SnippetName string
    Snippet identifying name
    ZoneId string
    Identifier
    createdOn String
    Creation time of the snippet
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    Modification time of the snippet
    snippetName String
    Snippet identifying name
    zoneId String
    Identifier
    createdOn string
    Creation time of the snippet
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn string
    Modification time of the snippet
    snippetName string
    Snippet identifying name
    zoneId string
    Identifier
    created_on str
    Creation time of the snippet
    id str
    The provider-assigned unique ID for this managed resource.
    modified_on str
    Modification time of the snippet
    snippet_name str
    Snippet identifying name
    zone_id str
    Identifier
    createdOn String
    Creation time of the snippet
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    Modification time of the snippet
    snippetName String
    Snippet identifying name
    zoneId String
    Identifier

    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