Cloudflare v5.49.1, Feb 18 25

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi

cloudflare.Snippet

Explore with Pulumi AI

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi

Create Snippet Resource

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

Constructor syntax

new Snippet(name: string, args: SnippetArgs, opts?: CustomResourceOptions);

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

@overload
def Snippet(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            main_module: Optional[str] = None,
            name: Optional[str] = None,
            zone_id: Optional[str] = None,
            files: Optional[Sequence[SnippetFileArgs]] = None)

func NewSnippet(ctx *Context, name string, args SnippetArgs, opts ...ResourceOption) (*Snippet, error)

public Snippet(string name, SnippetArgs args, CustomResourceOptions? opts = null)

public Snippet(String name, SnippetArgs args)
public Snippet(String name, SnippetArgs args, CustomResourceOptions options)

type: cloudflare:Snippet
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 SnippetArgs: 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 SnippetArgs: 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 SnippetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args SnippetArgs: 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 snippetResource = new Cloudflare.Snippet("snippetResource", new()
{
    MainModule = "string",
    Name = "string",
    ZoneId = "string",
    Files = new[]
    {
        new Cloudflare.Inputs.SnippetFileArgs
        {
            Name = "string",
            Content = "string",
        },
    },
});

example, err := cloudflare.NewSnippet(ctx, "snippetResource", &cloudflare.SnippetArgs{
	MainModule: pulumi.String("string"),
	Name:       pulumi.String("string"),
	ZoneId:     pulumi.String("string"),
	Files: cloudflare.SnippetFileArray{
		&cloudflare.SnippetFileArgs{
			Name:    pulumi.String("string"),
			Content: pulumi.String("string"),
		},
	},
})

var snippetResource = new Snippet("snippetResource", SnippetArgs.builder()
    .mainModule("string")
    .name("string")
    .zoneId("string")
    .files(SnippetFileArgs.builder()
        .name("string")
        .content("string")
        .build())
    .build());

snippet_resource = cloudflare.Snippet("snippetResource",
    main_module="string",
    name="string",
    zone_id="string",
    files=[{
        "name": "string",
        "content": "string",
    }])

const snippetResource = new cloudflare.Snippet("snippetResource", {
    mainModule: "string",
    name: "string",
    zoneId: "string",
    files: [{
        name: "string",
        content: "string",
    }],
});

type: cloudflare:Snippet
properties:
    files:
        - content: string
          name: string
    mainModule: string
    name: string
    zoneId: string

Snippet 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 Snippet resource accepts the following input properties:

MainModule string: Main module file name of the snippet.
Name string: Name of the snippet.
ZoneId string: The zone identifier to target for the resource.
Files List<SnippetFile>: List of Snippet Files

MainModule string: Main module file name of the snippet.
Name string: Name of the snippet.
ZoneId string: The zone identifier to target for the resource.
Files []SnippetFileArgs: List of Snippet Files

mainModule String: Main module file name of the snippet.
name String: Name of the snippet.
zoneId String: The zone identifier to target for the resource.
files List<SnippetFile>: List of Snippet Files

mainModule string: Main module file name of the snippet.
name string: Name of the snippet.
zoneId string: The zone identifier to target for the resource.
files SnippetFile[]: List of Snippet Files

main_module str: Main module file name of the snippet.
name str: Name of the snippet.
zone_id str: The zone identifier to target for the resource.
files Sequence[SnippetFileArgs]: List of Snippet Files

mainModule String: Main module file name of the snippet.
name String: Name of the snippet.
zoneId String: The zone identifier to target for the resource.
files List<Property Map>: List of Snippet Files

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Snippet Resource

Get an existing Snippet 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?: SnippetState, opts?: CustomResourceOptions): Snippet

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        files: Optional[Sequence[SnippetFileArgs]] = None,
        main_module: Optional[str] = None,
        name: Optional[str] = None,
        zone_id: Optional[str] = None) -> Snippet

func GetSnippet(ctx *Context, name string, id IDInput, state *SnippetState, opts ...ResourceOption) (*Snippet, error)

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

public static Snippet get(String name, Output<String> id, SnippetState state, CustomResourceOptions options)

resources:  _:    type: cloudflare:Snippet    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:

Files List<SnippetFile>: List of Snippet Files
MainModule string: Main module file name of the snippet.
Name string: Name of the snippet.
ZoneId string: The zone identifier to target for the resource.

Files []SnippetFileArgs: List of Snippet Files
MainModule string: Main module file name of the snippet.
Name string: Name of the snippet.
ZoneId string: The zone identifier to target for the resource.

files List<SnippetFile>: List of Snippet Files
mainModule String: Main module file name of the snippet.
name String: Name of the snippet.
zoneId String: The zone identifier to target for the resource.

files SnippetFile[]: List of Snippet Files
mainModule string: Main module file name of the snippet.
name string: Name of the snippet.
zoneId string: The zone identifier to target for the resource.

files Sequence[SnippetFileArgs]: List of Snippet Files
main_module str: Main module file name of the snippet.
name str: Name of the snippet.
zone_id str: The zone identifier to target for the resource.

files List<Property Map>: List of Snippet Files
mainModule String: Main module file name of the snippet.
name String: Name of the snippet.
zoneId String: The zone identifier to target for the resource.

Supporting Types

SnippetFile, SnippetFileArgs

Name string: Name of the snippet file.
Content string: Content of the snippet file.

Name string: Name of the snippet file.
Content string: Content of the snippet file.

name String: Name of the snippet file.
content String: Content of the snippet file.

name string: Name of the snippet file.
content string: Content of the snippet file.

name str: Name of the snippet file.
content str: Content of the snippet file.

name String: Name of the snippet file.
content String: Content of the snippet file.

Package Details

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

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.Snippet

On this page

On this page

Create Snippet Resource

Constructor syntax

Parameters

Constructor example

Snippet Resource Properties

Inputs

Outputs

Look up Existing Snippet Resource

Supporting Types

SnippetFile, SnippetFileArgs

Package Details

On this page

On this page