Cloudflare v5.49.1, Feb 18 25

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

cloudflare.SnippetRules

Explore with Pulumi AI

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

Create SnippetRules Resource

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

Constructor syntax

new SnippetRules(name: string, args: SnippetRulesArgs, opts?: CustomResourceOptions);

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

@overload
def SnippetRules(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 zone_id: Optional[str] = None,
                 rules: Optional[Sequence[SnippetRulesRuleArgs]] = None)

func NewSnippetRules(ctx *Context, name string, args SnippetRulesArgs, opts ...ResourceOption) (*SnippetRules, error)

public SnippetRules(string name, SnippetRulesArgs args, CustomResourceOptions? opts = null)

public SnippetRules(String name, SnippetRulesArgs args)
public SnippetRules(String name, SnippetRulesArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SnippetRulesArgs: 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 snippetRulesResource = new Cloudflare.SnippetRules("snippetRulesResource", new()
{
    ZoneId = "string",
    Rules = new[]
    {
        new Cloudflare.Inputs.SnippetRulesRuleArgs
        {
            Expression = "string",
            SnippetName = "string",
            Description = "string",
            Enabled = false,
        },
    },
});

example, err := cloudflare.NewSnippetRules(ctx, "snippetRulesResource", &cloudflare.SnippetRulesArgs{
	ZoneId: pulumi.String("string"),
	Rules: cloudflare.SnippetRulesRuleArray{
		&cloudflare.SnippetRulesRuleArgs{
			Expression:  pulumi.String("string"),
			SnippetName: pulumi.String("string"),
			Description: pulumi.String("string"),
			Enabled:     pulumi.Bool(false),
		},
	},
})

var snippetRulesResource = new SnippetRules("snippetRulesResource", SnippetRulesArgs.builder()
    .zoneId("string")
    .rules(SnippetRulesRuleArgs.builder()
        .expression("string")
        .snippetName("string")
        .description("string")
        .enabled(false)
        .build())
    .build());

snippet_rules_resource = cloudflare.SnippetRules("snippetRulesResource",
    zone_id="string",
    rules=[{
        "expression": "string",
        "snippet_name": "string",
        "description": "string",
        "enabled": False,
    }])

const snippetRulesResource = new cloudflare.SnippetRules("snippetRulesResource", {
    zoneId: "string",
    rules: [{
        expression: "string",
        snippetName: "string",
        description: "string",
        enabled: false,
    }],
});

type: cloudflare:SnippetRules
properties:
    rules:
        - description: string
          enabled: false
          expression: string
          snippetName: string
    zoneId: string

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

ZoneId string: The zone identifier to target for the resource.
Rules List<SnippetRulesRule>: List of Snippet Rules

ZoneId string: The zone identifier to target for the resource.
Rules []SnippetRulesRuleArgs: List of Snippet Rules

zoneId String: The zone identifier to target for the resource.
rules List<SnippetRulesRule>: List of Snippet Rules

zoneId string: The zone identifier to target for the resource.
rules SnippetRulesRule[]: List of Snippet Rules

zone_id str: The zone identifier to target for the resource.
rules Sequence[SnippetRulesRuleArgs]: List of Snippet Rules

zoneId String: The zone identifier to target for the resource.
rules List<Property Map>: List of Snippet Rules

Outputs

All input properties are implicitly available as output properties. Additionally, the SnippetRules 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 SnippetRules Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        rules: Optional[Sequence[SnippetRulesRuleArgs]] = None,
        zone_id: Optional[str] = None) -> SnippetRules

func GetSnippetRules(ctx *Context, name string, id IDInput, state *SnippetRulesState, opts ...ResourceOption) (*SnippetRules, error)

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

public static SnippetRules get(String name, Output<String> id, SnippetRulesState state, CustomResourceOptions options)

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

Rules List<SnippetRulesRule>: List of Snippet Rules
ZoneId string: The zone identifier to target for the resource.

Rules []SnippetRulesRuleArgs: List of Snippet Rules
ZoneId string: The zone identifier to target for the resource.

rules List<SnippetRulesRule>: List of Snippet Rules
zoneId String: The zone identifier to target for the resource.

rules SnippetRulesRule[]: List of Snippet Rules
zoneId string: The zone identifier to target for the resource.

rules Sequence[SnippetRulesRuleArgs]: List of Snippet Rules
zone_id str: The zone identifier to target for the resource.

rules List<Property Map>: List of Snippet Rules
zoneId String: The zone identifier to target for the resource.

Supporting Types

SnippetRulesRule, SnippetRulesRuleArgs

Expression string: Criteria for an HTTP request to trigger the snippet rule. Uses the Firewall Rules expression language based on Wireshark display filters.
SnippetName string: Name of the snippet invoked by this rule.
Description string: Brief summary of the snippet rule and its intended use.
Enabled bool: Whether the headers rule is active.

Expression string: Criteria for an HTTP request to trigger the snippet rule. Uses the Firewall Rules expression language based on Wireshark display filters.
SnippetName string: Name of the snippet invoked by this rule.
Description string: Brief summary of the snippet rule and its intended use.
Enabled bool: Whether the headers rule is active.

expression String: Criteria for an HTTP request to trigger the snippet rule. Uses the Firewall Rules expression language based on Wireshark display filters.
snippetName String: Name of the snippet invoked by this rule.
description String: Brief summary of the snippet rule and its intended use.
enabled Boolean: Whether the headers rule is active.

expression string: Criteria for an HTTP request to trigger the snippet rule. Uses the Firewall Rules expression language based on Wireshark display filters.
snippetName string: Name of the snippet invoked by this rule.
description string: Brief summary of the snippet rule and its intended use.
enabled boolean: Whether the headers rule is active.

expression str: Criteria for an HTTP request to trigger the snippet rule. Uses the Firewall Rules expression language based on Wireshark display filters.
snippet_name str: Name of the snippet invoked by this rule.
description str: Brief summary of the snippet rule and its intended use.
enabled bool: Whether the headers rule is active.

expression String: Criteria for an HTTP request to trigger the snippet rule. Uses the Firewall Rules expression language based on Wireshark display filters.
snippetName String: Name of the snippet invoked by this rule.
description String: Brief summary of the snippet rule and its intended use.
enabled Boolean: Whether the headers rule is active.

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.SnippetRules

On this page

On this page

Create SnippetRules Resource

Constructor syntax

Parameters

Constructor example

SnippetRules Resource Properties

Inputs

Outputs

Look up Existing SnippetRules Resource

Supporting Types

SnippetRulesRule, SnippetRulesRuleArgs

Package Details

On this page

On this page