1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. WafDedicatedDataMaskingRuleV1
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.WafDedicatedDataMaskingRuleV1

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for WAF dedicated Data Masking rule you can get at documentation portal.

    Manages a WAF Dedicated Data Masking Rule resource within OpenTelekomCloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const policy1 = new opentelekomcloud.WafDedicatedPolicyV1("policy1", {});
    const rule1 = new opentelekomcloud.WafDedicatedDataMaskingRuleV1("rule1", {
        policyId: policy1.wafDedicatedPolicyV1Id,
        url: "/login",
        category: "params",
        description: "description",
    });
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    policy1 = opentelekomcloud.WafDedicatedPolicyV1("policy1")
    rule1 = opentelekomcloud.WafDedicatedDataMaskingRuleV1("rule1",
        policy_id=policy1.waf_dedicated_policy_v1_id,
        url="/login",
        category="params",
        description="description")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		policy1, err := opentelekomcloud.NewWafDedicatedPolicyV1(ctx, "policy1", nil)
    		if err != nil {
    			return err
    		}
    		_, err = opentelekomcloud.NewWafDedicatedDataMaskingRuleV1(ctx, "rule1", &opentelekomcloud.WafDedicatedDataMaskingRuleV1Args{
    			PolicyId:    policy1.WafDedicatedPolicyV1Id,
    			Url:         pulumi.String("/login"),
    			Category:    pulumi.String("params"),
    			Description: pulumi.String("description"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var policy1 = new Opentelekomcloud.WafDedicatedPolicyV1("policy1");
    
        var rule1 = new Opentelekomcloud.WafDedicatedDataMaskingRuleV1("rule1", new()
        {
            PolicyId = policy1.WafDedicatedPolicyV1Id,
            Url = "/login",
            Category = "params",
            Description = "description",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.WafDedicatedPolicyV1;
    import com.pulumi.opentelekomcloud.WafDedicatedDataMaskingRuleV1;
    import com.pulumi.opentelekomcloud.WafDedicatedDataMaskingRuleV1Args;
    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) {
            var policy1 = new WafDedicatedPolicyV1("policy1");
    
            var rule1 = new WafDedicatedDataMaskingRuleV1("rule1", WafDedicatedDataMaskingRuleV1Args.builder()
                .policyId(policy1.wafDedicatedPolicyV1Id())
                .url("/login")
                .category("params")
                .description("description")
                .build());
    
        }
    }
    
    resources:
      policy1:
        type: opentelekomcloud:WafDedicatedPolicyV1
      rule1:
        type: opentelekomcloud:WafDedicatedDataMaskingRuleV1
        properties:
          policyId: ${policy1.wafDedicatedPolicyV1Id}
          url: /login
          category: params
          description: description
    

    Create WafDedicatedDataMaskingRuleV1 Resource

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

    Constructor syntax

    new WafDedicatedDataMaskingRuleV1(name: string, args: WafDedicatedDataMaskingRuleV1Args, opts?: CustomResourceOptions);
    @overload
    def WafDedicatedDataMaskingRuleV1(resource_name: str,
                                      args: WafDedicatedDataMaskingRuleV1Args,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def WafDedicatedDataMaskingRuleV1(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      category: Optional[str] = None,
                                      policy_id: Optional[str] = None,
                                      url: Optional[str] = None,
                                      description: Optional[str] = None,
                                      name: Optional[str] = None,
                                      timeouts: Optional[WafDedicatedDataMaskingRuleV1TimeoutsArgs] = None,
                                      waf_dedicated_data_masking_rule_v1_id: Optional[str] = None)
    func NewWafDedicatedDataMaskingRuleV1(ctx *Context, name string, args WafDedicatedDataMaskingRuleV1Args, opts ...ResourceOption) (*WafDedicatedDataMaskingRuleV1, error)
    public WafDedicatedDataMaskingRuleV1(string name, WafDedicatedDataMaskingRuleV1Args args, CustomResourceOptions? opts = null)
    public WafDedicatedDataMaskingRuleV1(String name, WafDedicatedDataMaskingRuleV1Args args)
    public WafDedicatedDataMaskingRuleV1(String name, WafDedicatedDataMaskingRuleV1Args args, CustomResourceOptions options)
    
    type: opentelekomcloud:WafDedicatedDataMaskingRuleV1
    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 WafDedicatedDataMaskingRuleV1Args
    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 WafDedicatedDataMaskingRuleV1Args
    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 WafDedicatedDataMaskingRuleV1Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WafDedicatedDataMaskingRuleV1Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WafDedicatedDataMaskingRuleV1Args
    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 wafDedicatedDataMaskingRuleV1Resource = new Opentelekomcloud.WafDedicatedDataMaskingRuleV1("wafDedicatedDataMaskingRuleV1Resource", new()
    {
        Category = "string",
        PolicyId = "string",
        Url = "string",
        Description = "string",
        Name = "string",
        Timeouts = new Opentelekomcloud.Inputs.WafDedicatedDataMaskingRuleV1TimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
        WafDedicatedDataMaskingRuleV1Id = "string",
    });
    
    example, err := opentelekomcloud.NewWafDedicatedDataMaskingRuleV1(ctx, "wafDedicatedDataMaskingRuleV1Resource", &opentelekomcloud.WafDedicatedDataMaskingRuleV1Args{
    	Category:    pulumi.String("string"),
    	PolicyId:    pulumi.String("string"),
    	Url:         pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Timeouts: &opentelekomcloud.WafDedicatedDataMaskingRuleV1TimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	WafDedicatedDataMaskingRuleV1Id: pulumi.String("string"),
    })
    
    var wafDedicatedDataMaskingRuleV1Resource = new WafDedicatedDataMaskingRuleV1("wafDedicatedDataMaskingRuleV1Resource", WafDedicatedDataMaskingRuleV1Args.builder()
        .category("string")
        .policyId("string")
        .url("string")
        .description("string")
        .name("string")
        .timeouts(WafDedicatedDataMaskingRuleV1TimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .wafDedicatedDataMaskingRuleV1Id("string")
        .build());
    
    waf_dedicated_data_masking_rule_v1_resource = opentelekomcloud.WafDedicatedDataMaskingRuleV1("wafDedicatedDataMaskingRuleV1Resource",
        category="string",
        policy_id="string",
        url="string",
        description="string",
        name="string",
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        },
        waf_dedicated_data_masking_rule_v1_id="string")
    
    const wafDedicatedDataMaskingRuleV1Resource = new opentelekomcloud.WafDedicatedDataMaskingRuleV1("wafDedicatedDataMaskingRuleV1Resource", {
        category: "string",
        policyId: "string",
        url: "string",
        description: "string",
        name: "string",
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
        wafDedicatedDataMaskingRuleV1Id: "string",
    });
    
    type: opentelekomcloud:WafDedicatedDataMaskingRuleV1
    properties:
        category: string
        description: string
        name: string
        policyId: string
        timeouts:
            create: string
            delete: string
            update: string
        url: string
        wafDedicatedDataMaskingRuleV1Id: string
    

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

    Category string
    Masked field. Values:
    PolicyId string
    The WAF policy ID. Changing this creates a new rule.
    Url string
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    Description string
    Rule description.
    Name string
    Name of the masked field.
    Timeouts WafDedicatedDataMaskingRuleV1Timeouts
    WafDedicatedDataMaskingRuleV1Id string
    ID of the rule.
    Category string
    Masked field. Values:
    PolicyId string
    The WAF policy ID. Changing this creates a new rule.
    Url string
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    Description string
    Rule description.
    Name string
    Name of the masked field.
    Timeouts WafDedicatedDataMaskingRuleV1TimeoutsArgs
    WafDedicatedDataMaskingRuleV1Id string
    ID of the rule.
    category String
    Masked field. Values:
    policyId String
    The WAF policy ID. Changing this creates a new rule.
    url String
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    description String
    Rule description.
    name String
    Name of the masked field.
    timeouts WafDedicatedDataMaskingRuleV1Timeouts
    wafDedicatedDataMaskingRuleV1Id String
    ID of the rule.
    category string
    Masked field. Values:
    policyId string
    The WAF policy ID. Changing this creates a new rule.
    url string
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    description string
    Rule description.
    name string
    Name of the masked field.
    timeouts WafDedicatedDataMaskingRuleV1Timeouts
    wafDedicatedDataMaskingRuleV1Id string
    ID of the rule.
    category str
    Masked field. Values:
    policy_id str
    The WAF policy ID. Changing this creates a new rule.
    url str
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    description str
    Rule description.
    name str
    Name of the masked field.
    timeouts WafDedicatedDataMaskingRuleV1TimeoutsArgs
    waf_dedicated_data_masking_rule_v1_id str
    ID of the rule.
    category String
    Masked field. Values:
    policyId String
    The WAF policy ID. Changing this creates a new rule.
    url String
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    description String
    Rule description.
    name String
    Name of the masked field.
    timeouts Property Map
    wafDedicatedDataMaskingRuleV1Id String
    ID of the rule.

    Outputs

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

    CreatedAt double
    Timestamp the rule is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status double
    Rule status. The value can be 0 or 1.
    CreatedAt float64
    Timestamp the rule is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status float64
    Rule status. The value can be 0 or 1.
    createdAt Double
    Timestamp the rule is created.
    id String
    The provider-assigned unique ID for this managed resource.
    status Double
    Rule status. The value can be 0 or 1.
    createdAt number
    Timestamp the rule is created.
    id string
    The provider-assigned unique ID for this managed resource.
    status number
    Rule status. The value can be 0 or 1.
    created_at float
    Timestamp the rule is created.
    id str
    The provider-assigned unique ID for this managed resource.
    status float
    Rule status. The value can be 0 or 1.
    createdAt Number
    Timestamp the rule is created.
    id String
    The provider-assigned unique ID for this managed resource.
    status Number
    Rule status. The value can be 0 or 1.

    Look up Existing WafDedicatedDataMaskingRuleV1 Resource

    Get an existing WafDedicatedDataMaskingRuleV1 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?: WafDedicatedDataMaskingRuleV1State, opts?: CustomResourceOptions): WafDedicatedDataMaskingRuleV1
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            category: Optional[str] = None,
            created_at: Optional[float] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            policy_id: Optional[str] = None,
            status: Optional[float] = None,
            timeouts: Optional[WafDedicatedDataMaskingRuleV1TimeoutsArgs] = None,
            url: Optional[str] = None,
            waf_dedicated_data_masking_rule_v1_id: Optional[str] = None) -> WafDedicatedDataMaskingRuleV1
    func GetWafDedicatedDataMaskingRuleV1(ctx *Context, name string, id IDInput, state *WafDedicatedDataMaskingRuleV1State, opts ...ResourceOption) (*WafDedicatedDataMaskingRuleV1, error)
    public static WafDedicatedDataMaskingRuleV1 Get(string name, Input<string> id, WafDedicatedDataMaskingRuleV1State? state, CustomResourceOptions? opts = null)
    public static WafDedicatedDataMaskingRuleV1 get(String name, Output<String> id, WafDedicatedDataMaskingRuleV1State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:WafDedicatedDataMaskingRuleV1    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:
    Category string
    Masked field. Values:
    CreatedAt double
    Timestamp the rule is created.
    Description string
    Rule description.
    Name string
    Name of the masked field.
    PolicyId string
    The WAF policy ID. Changing this creates a new rule.
    Status double
    Rule status. The value can be 0 or 1.
    Timeouts WafDedicatedDataMaskingRuleV1Timeouts
    Url string
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    WafDedicatedDataMaskingRuleV1Id string
    ID of the rule.
    Category string
    Masked field. Values:
    CreatedAt float64
    Timestamp the rule is created.
    Description string
    Rule description.
    Name string
    Name of the masked field.
    PolicyId string
    The WAF policy ID. Changing this creates a new rule.
    Status float64
    Rule status. The value can be 0 or 1.
    Timeouts WafDedicatedDataMaskingRuleV1TimeoutsArgs
    Url string
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    WafDedicatedDataMaskingRuleV1Id string
    ID of the rule.
    category String
    Masked field. Values:
    createdAt Double
    Timestamp the rule is created.
    description String
    Rule description.
    name String
    Name of the masked field.
    policyId String
    The WAF policy ID. Changing this creates a new rule.
    status Double
    Rule status. The value can be 0 or 1.
    timeouts WafDedicatedDataMaskingRuleV1Timeouts
    url String
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    wafDedicatedDataMaskingRuleV1Id String
    ID of the rule.
    category string
    Masked field. Values:
    createdAt number
    Timestamp the rule is created.
    description string
    Rule description.
    name string
    Name of the masked field.
    policyId string
    The WAF policy ID. Changing this creates a new rule.
    status number
    Rule status. The value can be 0 or 1.
    timeouts WafDedicatedDataMaskingRuleV1Timeouts
    url string
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    wafDedicatedDataMaskingRuleV1Id string
    ID of the rule.
    category str
    Masked field. Values:
    created_at float
    Timestamp the rule is created.
    description str
    Rule description.
    name str
    Name of the masked field.
    policy_id str
    The WAF policy ID. Changing this creates a new rule.
    status float
    Rule status. The value can be 0 or 1.
    timeouts WafDedicatedDataMaskingRuleV1TimeoutsArgs
    url str
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    waf_dedicated_data_masking_rule_v1_id str
    ID of the rule.
    category String
    Masked field. Values:
    createdAt Number
    Timestamp the rule is created.
    description String
    Rule description.
    name String
    Name of the masked field.
    policyId String
    The WAF policy ID. Changing this creates a new rule.
    status Number
    Rule status. The value can be 0 or 1.
    timeouts Property Map
    url String
    URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin.
    wafDedicatedDataMaskingRuleV1Id String
    ID of the rule.

    Supporting Types

    WafDedicatedDataMaskingRuleV1Timeouts, WafDedicatedDataMaskingRuleV1TimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    Dedicated WAF Data Masking Rules can be imported using policy_id/id, e.g.

    $ pulumi import opentelekomcloud:index/wafDedicatedDataMaskingRuleV1:WafDedicatedDataMaskingRuleV1 rule_1 ff95e71c8ae74eba9887193ab22c5757/b39f3a5a1b4f447a8030f0b0703f47f5
    

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

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud