Cloudflare v6.6.0, Aug 20 25

Cloudflare v6.6.0 published on Wednesday, Aug 20, 2025 by Pulumi

cloudflare.Snippets

Explore with Pulumi AI

Cloudflare v6.6.0 published on Wednesday, Aug 20, 2025 by Pulumi

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  exampleSnippets:
    type: cloudflare:Snippets
    name: example_snippets
    properties:
      zoneId: 9f1839b6152d298aca64c4e906b6d074
      snippetName: my_snippet
      files:
        - null
      metadata:
        main_module: main.js

Create Snippets Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Snippets(name: string, args: SnippetsArgs, opts?: CustomResourceOptions);

@overload
def Snippets(resource_name: str,
             args: SnippetsArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Snippets(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             files: Optional[Sequence[str]] = None,
             metadata: Optional[SnippetsMetadataArgs] = None,
             snippet_name: Optional[str] = None,
             zone_id: Optional[str] = None)

func NewSnippets(ctx *Context, name string, args SnippetsArgs, opts ...ResourceOption) (*Snippets, error)

public Snippets(string name, SnippetsArgs args, CustomResourceOptions? opts = null)

public Snippets(String name, SnippetsArgs args)
public Snippets(String name, SnippetsArgs args, CustomResourceOptions options)

type: cloudflare:Snippets
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SnippetsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SnippetsArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SnippetsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SnippetsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SnippetsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var snippetsResource = new Cloudflare.Snippets("snippetsResource", new()
{
    Files = new[]
    {
        "string",
    },
    Metadata = new Cloudflare.Inputs.SnippetsMetadataArgs
    {
        MainModule = "string",
    },
    SnippetName = "string",
    ZoneId = "string",
});

example, err := cloudflare.NewSnippets(ctx, "snippetsResource", &cloudflare.SnippetsArgs{
	Files: pulumi.StringArray{
		pulumi.String("string"),
	},
	Metadata: &cloudflare.SnippetsMetadataArgs{
		MainModule: pulumi.String("string"),
	},
	SnippetName: pulumi.String("string"),
	ZoneId:      pulumi.String("string"),
})

var snippetsResource = new Snippets("snippetsResource", SnippetsArgs.builder()
    .files("string")
    .metadata(SnippetsMetadataArgs.builder()
        .mainModule("string")
        .build())
    .snippetName("string")
    .zoneId("string")
    .build());

snippets_resource = cloudflare.Snippets("snippetsResource",
    files=["string"],
    metadata={
        "main_module": "string",
    },
    snippet_name="string",
    zone_id="string")

const snippetsResource = new cloudflare.Snippets("snippetsResource", {
    files: ["string"],
    metadata: {
        mainModule: "string",
    },
    snippetName: "string",
    zoneId: "string",
});

type: cloudflare:Snippets
properties:
    files:
        - string
    metadata:
        mainModule: string
    snippetName: string
    zoneId: string

Snippets Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Snippets resource accepts the following input properties:

Files List<string>: The list of files belonging to the snippet.
Metadata SnippetsMetadata: Metadata about the snippet.
SnippetName string: The identifying name of the snippet.
ZoneId string: The unique ID of the zone.

Files []string: The list of files belonging to the snippet.
Metadata SnippetsMetadataArgs: Metadata about the snippet.
SnippetName string: The identifying name of the snippet.
ZoneId string: The unique ID of the zone.

files List<String>: The list of files belonging to the snippet.
metadata SnippetsMetadata: Metadata about the snippet.
snippetName String: The identifying name of the snippet.
zoneId String: The unique ID of the zone.

files string[]: The list of files belonging to the snippet.
metadata SnippetsMetadata: Metadata about the snippet.
snippetName string: The identifying name of the snippet.
zoneId string: The unique ID of the zone.

files Sequence[str]: The list of files belonging to the snippet.
metadata SnippetsMetadataArgs: Metadata about the snippet.
snippet_name str: The identifying name of the snippet.
zone_id str: The unique ID of the zone.

files List<String>: The list of files belonging to the snippet.
metadata Property Map: Metadata about the snippet.
snippetName String: The identifying name of the snippet.
zoneId String: The unique ID of the zone.

Outputs

All input properties are implicitly available as output properties. Additionally, the Snippets resource produces the following output properties:

CreatedOn string: The timestamp of when the snippet was created.
Id string: The provider-assigned unique ID for this managed resource.
ModifiedOn string: The timestamp of when the snippet was last modified.

CreatedOn string: The timestamp of when the snippet was created.
Id string: The provider-assigned unique ID for this managed resource.
ModifiedOn string: The timestamp of when the snippet was last modified.

createdOn String: The timestamp of when the snippet was created.
id String: The provider-assigned unique ID for this managed resource.
modifiedOn String: The timestamp of when the snippet was last modified.

createdOn string: The timestamp of when the snippet was created.
id string: The provider-assigned unique ID for this managed resource.
modifiedOn string: The timestamp of when the snippet was last modified.

created_on str: The timestamp of when the snippet was created.
id str: The provider-assigned unique ID for this managed resource.
modified_on str: The timestamp of when the snippet was last modified.

createdOn String: The timestamp of when the snippet was created.
id String: The provider-assigned unique ID for this managed resource.
modifiedOn String: The timestamp of when the snippet was last modified.

Look up Existing Snippets Resource

Get an existing Snippets resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SnippetsState, opts?: CustomResourceOptions): Snippets

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_on: Optional[str] = None,
        files: Optional[Sequence[str]] = None,
        metadata: Optional[SnippetsMetadataArgs] = None,
        modified_on: Optional[str] = None,
        snippet_name: Optional[str] = None,
        zone_id: Optional[str] = None) -> Snippets

func GetSnippets(ctx *Context, name string, id IDInput, state *SnippetsState, opts ...ResourceOption) (*Snippets, error)

public static Snippets Get(string name, Input<string> id, SnippetsState? state, CustomResourceOptions? opts = null)

public static Snippets get(String name, Output<String> id, SnippetsState state, CustomResourceOptions options)

resources:  _:    type: cloudflare:Snippets    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreatedOn string: The timestamp of when the snippet was created.
Files List<string>: The list of files belonging to the snippet.
Metadata SnippetsMetadata: Metadata about the snippet.
ModifiedOn string: The timestamp of when the snippet was last modified.
SnippetName string: The identifying name of the snippet.
ZoneId string: The unique ID of the zone.

CreatedOn string: The timestamp of when the snippet was created.
Files []string: The list of files belonging to the snippet.
Metadata SnippetsMetadataArgs: Metadata about the snippet.
ModifiedOn string: The timestamp of when the snippet was last modified.
SnippetName string: The identifying name of the snippet.
ZoneId string: The unique ID of the zone.

createdOn String: The timestamp of when the snippet was created.
files List<String>: The list of files belonging to the snippet.
metadata SnippetsMetadata: Metadata about the snippet.
modifiedOn String: The timestamp of when the snippet was last modified.
snippetName String: The identifying name of the snippet.
zoneId String: The unique ID of the zone.

createdOn string: The timestamp of when the snippet was created.
files string[]: The list of files belonging to the snippet.
metadata SnippetsMetadata: Metadata about the snippet.
modifiedOn string: The timestamp of when the snippet was last modified.
snippetName string: The identifying name of the snippet.
zoneId string: The unique ID of the zone.

created_on str: The timestamp of when the snippet was created.
files Sequence[str]: The list of files belonging to the snippet.
metadata SnippetsMetadataArgs: Metadata about the snippet.
modified_on str: The timestamp of when the snippet was last modified.
snippet_name str: The identifying name of the snippet.
zone_id str: The unique ID of the zone.

createdOn String: The timestamp of when the snippet was created.
files List<String>: The list of files belonging to the snippet.
metadata Property Map: Metadata about the snippet.
modifiedOn String: The timestamp of when the snippet was last modified.
snippetName String: The identifying name of the snippet.
zoneId String: The unique ID of the zone.

Supporting Types

SnippetsMetadata, SnippetsMetadataArgs

MainModule string: Name of the file that contains the main module of the snippet.

MainModule string: Name of the file that contains the main module of the snippet.

mainModule String: Name of the file that contains the main module of the snippet.

mainModule string: Name of the file that contains the main module of the snippet.

main_module str: Name of the file that contains the main module of the snippet.

mainModule String: Name of the file that contains the main module of the snippet.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.6.0 published on Wednesday, Aug 20, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.Snippets

On this page

On this page

Example Usage

Create Snippets Resource

Constructor syntax

Parameters

Constructor example

Snippets Resource Properties

Inputs

Outputs

Look up Existing Snippets Resource

Supporting Types

SnippetsMetadata, SnippetsMetadataArgs

Package Details

On this page

On this page