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

cloudflare.LeakedCredentialCheck

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 resource to be used for managing the status of the Cloudflare Leaked Credential detection within a specific zone.

    Example Usage

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

// Enable the Leaked Credentials Check detection
const example = new cloudflare.LeakedCredentialCheck("example", {
    zoneId: "399c6f4950c01a5a141b99ff7fbcbd8b",
    enabled: true,
});

    import pulumi
import pulumi_cloudflare as cloudflare

# Enable the Leaked Credentials Check detection
example = cloudflare.LeakedCredentialCheck("example",
    zone_id="399c6f4950c01a5a141b99ff7fbcbd8b",
    enabled=True)

    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
		_, err := cloudflare.NewLeakedCredentialCheck(ctx, "example", &cloudflare.LeakedCredentialCheckArgs{
			ZoneId:  pulumi.String("399c6f4950c01a5a141b99ff7fbcbd8b"),
			Enabled: pulumi.Bool(true),
		})
		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
    var example = new Cloudflare.LeakedCredentialCheck("example", new()
    {
        ZoneId = "399c6f4950c01a5a141b99ff7fbcbd8b",
        Enabled = true,
    });

});

    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 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
        var example = new LeakedCredentialCheck("example", LeakedCredentialCheckArgs.builder()
            .zoneId("399c6f4950c01a5a141b99ff7fbcbd8b")
            .enabled(true)
            .build());

    }
}

    resources:
  # Enable the Leaked Credentials Check detection
  example:
    type: cloudflare:LeakedCredentialCheck
    properties:
      zoneId: 399c6f4950c01a5a141b99ff7fbcbd8b
      enabled: true

    Create LeakedCredentialCheck Resource

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

    Constructor syntax

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

@overload
def LeakedCredentialCheck(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          enabled: Optional[bool] = None,
                          zone_id: Optional[str] = None)
    func NewLeakedCredentialCheck(ctx *Context, name string, args LeakedCredentialCheckArgs, opts ...ResourceOption) (*LeakedCredentialCheck, error)
    public LeakedCredentialCheck(string name, LeakedCredentialCheckArgs args, CustomResourceOptions? opts = null)
    public LeakedCredentialCheck(String name, LeakedCredentialCheckArgs args)
public LeakedCredentialCheck(String name, LeakedCredentialCheckArgs args, CustomResourceOptions options)

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

    example, err := cloudflare.NewLeakedCredentialCheck(ctx, "leakedCredentialCheckResource", &cloudflare.LeakedCredentialCheckArgs{
	Enabled: pulumi.Bool(false),
	ZoneId:  pulumi.String("string"),
})

    var leakedCredentialCheckResource = new LeakedCredentialCheck("leakedCredentialCheckResource", LeakedCredentialCheckArgs.builder()
    .enabled(false)
    .zoneId("string")
    .build());

    leaked_credential_check_resource = cloudflare.LeakedCredentialCheck("leakedCredentialCheckResource",
    enabled=False,
    zone_id="string")

    const leakedCredentialCheckResource = new cloudflare.LeakedCredentialCheck("leakedCredentialCheckResource", {
    enabled: false,
    zoneId: "string",
});

    type: cloudflare:LeakedCredentialCheck
properties:
    enabled: false
    zoneId: string

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

    Enabled bool
    State of the Leaked Credential Check detection
    ZoneId string
    The zone identifier to target for the resource.
    Enabled bool
    State of the Leaked Credential Check detection
    ZoneId string
    The zone identifier to target for the resource.
    enabled Boolean
    State of the Leaked Credential Check detection
    zoneId String
    The zone identifier to target for the resource.
    enabled boolean
    State of the Leaked Credential Check detection
    zoneId string
    The zone identifier to target for the resource.
    enabled bool
    State of the Leaked Credential Check detection
    zone_id str
    The zone identifier to target for the resource.
    enabled Boolean
    State of the Leaked Credential Check detection
    zoneId String
    The zone identifier to target for the resource.

    Outputs

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

    Get an existing LeakedCredentialCheck 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?: LeakedCredentialCheckState, opts?: CustomResourceOptions): LeakedCredentialCheck
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        zone_id: Optional[str] = None) -> LeakedCredentialCheck
    func GetLeakedCredentialCheck(ctx *Context, name string, id IDInput, state *LeakedCredentialCheckState, opts ...ResourceOption) (*LeakedCredentialCheck, error)
    public static LeakedCredentialCheck Get(string name, Input<string> id, LeakedCredentialCheckState? state, CustomResourceOptions? opts = null)
    public static LeakedCredentialCheck get(String name, Output<String> id, LeakedCredentialCheckState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:LeakedCredentialCheck    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:
    Enabled bool
    State of the Leaked Credential Check detection
    ZoneId string
    The zone identifier to target for the resource.
    Enabled bool
    State of the Leaked Credential Check detection
    ZoneId string
    The zone identifier to target for the resource.
    enabled Boolean
    State of the Leaked Credential Check detection
    zoneId String
    The zone identifier to target for the resource.
    enabled boolean
    State of the Leaked Credential Check detection
    zoneId string
    The zone identifier to target for the resource.
    enabled bool
    State of the Leaked Credential Check detection
    zone_id str
    The zone identifier to target for the resource.
    enabled Boolean
    State of the Leaked Credential Check detection
    zoneId String
    The zone identifier to target for the resource.

    Import

    $ pulumi import cloudflare:index/leakedCredentialCheck:LeakedCredentialCheck example <zone_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