Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. LeakedCredentialCheckRule
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.LeakedCredentialCheckRule

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Provides a Cloudflare Leaked Credential Check Rule resource for managing user-defined Leaked Credential detection patterns within a specific zone.

    Example Usage

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

// Enable the Leaked Credentials Check detection before trying
// to add detections.
const example = new cloudflare.LeakedCredentialCheck("example", {
    zoneId: "399c6f4950c01a5a141b99ff7fbcbd8b",
    enabled: true,
});
const exampleLeakedCredentialCheckRule = new cloudflare.LeakedCredentialCheckRule("example", {
    zoneId: example.zoneId,
    username: "lookup_json_string(http.request.body.raw, \"user\")",
    password: "lookup_json_string(http.request.body.raw, \"pass\")",
});

    import pulumi
import pulumi_cloudflare as cloudflare

# Enable the Leaked Credentials Check detection before trying
# to add detections.
example = cloudflare.LeakedCredentialCheck("example",
    zone_id="399c6f4950c01a5a141b99ff7fbcbd8b",
    enabled=True)
example_leaked_credential_check_rule = cloudflare.LeakedCredentialCheckRule("example",
    zone_id=example.zone_id,
    username="lookup_json_string(http.request.body.raw, \"user\")",
    password="lookup_json_string(http.request.body.raw, \"pass\")")

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Enable the Leaked Credentials Check detection before trying
		// to add detections.
		example, err := cloudflare.NewLeakedCredentialCheck(ctx, "example", &cloudflare.LeakedCredentialCheckArgs{
			ZoneId:  pulumi.String("399c6f4950c01a5a141b99ff7fbcbd8b"),
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = cloudflare.NewLeakedCredentialCheckRule(ctx, "example", &cloudflare.LeakedCredentialCheckRuleArgs{
			ZoneId:   example.ZoneId,
			Username: pulumi.String("lookup_json_string(http.request.body.raw, \"user\")"),
			Password: pulumi.String("lookup_json_string(http.request.body.raw, \"pass\")"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    // Enable the Leaked Credentials Check detection before trying
    // to add detections.
    var example = new Cloudflare.LeakedCredentialCheck("example", new()
    {
        ZoneId = "399c6f4950c01a5a141b99ff7fbcbd8b",
        Enabled = true,
    });

    var exampleLeakedCredentialCheckRule = new Cloudflare.LeakedCredentialCheckRule("example", new()
    {
        ZoneId = example.ZoneId,
        Username = "lookup_json_string(http.request.body.raw, \"user\")",
        Password = "lookup_json_string(http.request.body.raw, \"pass\")",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.LeakedCredentialCheck;
import com.pulumi.cloudflare.LeakedCredentialCheckArgs;
import com.pulumi.cloudflare.LeakedCredentialCheckRule;
import com.pulumi.cloudflare.LeakedCredentialCheckRuleArgs;
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) {
        // Enable the Leaked Credentials Check detection before trying
        // to add detections.
        var example = new LeakedCredentialCheck("example", LeakedCredentialCheckArgs.builder()
            .zoneId("399c6f4950c01a5a141b99ff7fbcbd8b")
            .enabled(true)
            .build());

        var exampleLeakedCredentialCheckRule = new LeakedCredentialCheckRule("exampleLeakedCredentialCheckRule", LeakedCredentialCheckRuleArgs.builder()
            .zoneId(example.zoneId())
            .username("lookup_json_string(http.request.body.raw, \"user\")")
            .password("lookup_json_string(http.request.body.raw, \"pass\")")
            .build());

    }
}

    resources:
  # Enable the Leaked Credentials Check detection before trying
  # to add detections.
  example:
    type: cloudflare:LeakedCredentialCheck
    properties:
      zoneId: 399c6f4950c01a5a141b99ff7fbcbd8b
      enabled: true
  exampleLeakedCredentialCheckRule:
    type: cloudflare:LeakedCredentialCheckRule
    name: example
    properties:
      zoneId: ${example.zoneId}
      username: lookup_json_string(http.request.body.raw, "user")
      password: lookup_json_string(http.request.body.raw, "pass")

    Create LeakedCredentialCheckRule Resource

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

    Constructor syntax

    new LeakedCredentialCheckRule(name: string, args: LeakedCredentialCheckRuleArgs, opts?: CustomResourceOptions);
    @overload
def LeakedCredentialCheckRule(resource_name: str,
                              args: LeakedCredentialCheckRuleArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def LeakedCredentialCheckRule(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              password: Optional[str] = None,
                              username: Optional[str] = None,
                              zone_id: Optional[str] = None)
    func NewLeakedCredentialCheckRule(ctx *Context, name string, args LeakedCredentialCheckRuleArgs, opts ...ResourceOption) (*LeakedCredentialCheckRule, error)
    public LeakedCredentialCheckRule(string name, LeakedCredentialCheckRuleArgs args, CustomResourceOptions? opts = null)
    public LeakedCredentialCheckRule(String name, LeakedCredentialCheckRuleArgs args)
public LeakedCredentialCheckRule(String name, LeakedCredentialCheckRuleArgs args, CustomResourceOptions options)

    type: cloudflare:LeakedCredentialCheckRule
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 LeakedCredentialCheckRuleArgs
    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 LeakedCredentialCheckRuleArgs
    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 LeakedCredentialCheckRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LeakedCredentialCheckRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LeakedCredentialCheckRuleArgs
    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 leakedCredentialCheckRuleResource = new Cloudflare.LeakedCredentialCheckRule("leakedCredentialCheckRuleResource", new()
{
    Password = "string",
    Username = "string",
    ZoneId = "string",
});

    example, err := cloudflare.NewLeakedCredentialCheckRule(ctx, "leakedCredentialCheckRuleResource", &cloudflare.LeakedCredentialCheckRuleArgs{
	Password: pulumi.String("string"),
	Username: pulumi.String("string"),
	ZoneId:   pulumi.String("string"),
})

    var leakedCredentialCheckRuleResource = new LeakedCredentialCheckRule("leakedCredentialCheckRuleResource", LeakedCredentialCheckRuleArgs.builder()
    .password("string")
    .username("string")
    .zoneId("string")
    .build());

    leaked_credential_check_rule_resource = cloudflare.LeakedCredentialCheckRule("leakedCredentialCheckRuleResource",
    password="string",
    username="string",
    zone_id="string")

    const leakedCredentialCheckRuleResource = new cloudflare.LeakedCredentialCheckRule("leakedCredentialCheckRuleResource", {
    password: "string",
    username: "string",
    zoneId: "string",
});

    type: cloudflare:LeakedCredentialCheckRule
properties:
    password: string
    username: string
    zoneId: string

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

    Password string
    The ruleset expression to use in matching the password in a request
    Username string
    The ruleset expression to use in matching the username in a request.
    ZoneId string
    The zone identifier to target for the resource.
    Password string
    The ruleset expression to use in matching the password in a request
    Username string
    The ruleset expression to use in matching the username in a request.
    ZoneId string
    The zone identifier to target for the resource.
    password String
    The ruleset expression to use in matching the password in a request
    username String
    The ruleset expression to use in matching the username in a request.
    zoneId String
    The zone identifier to target for the resource.
    password string
    The ruleset expression to use in matching the password in a request
    username string
    The ruleset expression to use in matching the username in a request.
    zoneId string
    The zone identifier to target for the resource.
    password str
    The ruleset expression to use in matching the password in a request
    username str
    The ruleset expression to use in matching the username in a request.
    zone_id str
    The zone identifier to target for the resource.
    password String
    The ruleset expression to use in matching the password in a request
    username String
    The ruleset expression to use in matching the username in a request.
    zoneId String
    The zone identifier to target for the resource.

    Outputs

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

    Get an existing LeakedCredentialCheckRule 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?: LeakedCredentialCheckRuleState, opts?: CustomResourceOptions): LeakedCredentialCheckRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        password: Optional[str] = None,
        username: Optional[str] = None,
        zone_id: Optional[str] = None) -> LeakedCredentialCheckRule
    func GetLeakedCredentialCheckRule(ctx *Context, name string, id IDInput, state *LeakedCredentialCheckRuleState, opts ...ResourceOption) (*LeakedCredentialCheckRule, error)
    public static LeakedCredentialCheckRule Get(string name, Input<string> id, LeakedCredentialCheckRuleState? state, CustomResourceOptions? opts = null)
    public static LeakedCredentialCheckRule get(String name, Output<String> id, LeakedCredentialCheckRuleState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:LeakedCredentialCheckRule    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:
    Password string
    The ruleset expression to use in matching the password in a request
    Username string
    The ruleset expression to use in matching the username in a request.
    ZoneId string
    The zone identifier to target for the resource.
    Password string
    The ruleset expression to use in matching the password in a request
    Username string
    The ruleset expression to use in matching the username in a request.
    ZoneId string
    The zone identifier to target for the resource.
    password String
    The ruleset expression to use in matching the password in a request
    username String
    The ruleset expression to use in matching the username in a request.
    zoneId String
    The zone identifier to target for the resource.
    password string
    The ruleset expression to use in matching the password in a request
    username string
    The ruleset expression to use in matching the username in a request.
    zoneId string
    The zone identifier to target for the resource.
    password str
    The ruleset expression to use in matching the password in a request
    username str
    The ruleset expression to use in matching the username in a request.
    zone_id str
    The zone identifier to target for the resource.
    password String
    The ruleset expression to use in matching the password in a request
    username String
    The ruleset expression to use in matching the username in a request.
    zoneId String
    The zone identifier to target for the resource.

    Import

    $ pulumi import cloudflare:index/leakedCredentialCheckRule:LeakedCredentialCheckRule example <zone_id>/<resource_id>

    To learn more about importing existing cloud resources, see Importing resources.

    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 v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
    pulumi/pulumi-cloudflare