1. Packages
  2. Fortios
  3. API Docs
  4. dlp
  5. Datatype
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.dlp.Datatype

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Configure predefined data type used by DLP blocking. Applies to FortiOS Version >= 7.2.0.

    Create Datatype Resource

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

    Constructor syntax

    new Datatype(name: string, args?: DatatypeArgs, opts?: CustomResourceOptions);
    @overload
    def Datatype(resource_name: str,
                 args: Optional[DatatypeArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Datatype(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 comment: Optional[str] = None,
                 look_ahead: Optional[int] = None,
                 look_back: Optional[int] = None,
                 match_ahead: Optional[int] = None,
                 match_around: Optional[str] = None,
                 match_back: Optional[int] = None,
                 name: Optional[str] = None,
                 pattern: Optional[str] = None,
                 transform: Optional[str] = None,
                 vdomparam: Optional[str] = None,
                 verify: Optional[str] = None,
                 verify2: Optional[str] = None,
                 verify_transformed_pattern: Optional[str] = None)
    func NewDatatype(ctx *Context, name string, args *DatatypeArgs, opts ...ResourceOption) (*Datatype, error)
    public Datatype(string name, DatatypeArgs? args = null, CustomResourceOptions? opts = null)
    public Datatype(String name, DatatypeArgs args)
    public Datatype(String name, DatatypeArgs args, CustomResourceOptions options)
    
    type: fortios:dlp:Datatype
    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 DatatypeArgs
    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 DatatypeArgs
    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 DatatypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatatypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatatypeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var datatypeResource = new Fortios.Dlp.Datatype("datatypeResource", new()
    {
        Comment = "string",
        LookAhead = 0,
        LookBack = 0,
        MatchAhead = 0,
        MatchAround = "string",
        MatchBack = 0,
        Name = "string",
        Pattern = "string",
        Transform = "string",
        Vdomparam = "string",
        Verify = "string",
        Verify2 = "string",
        VerifyTransformedPattern = "string",
    });
    
    example, err := dlp.NewDatatype(ctx, "datatypeResource", &dlp.DatatypeArgs{
    	Comment:                  pulumi.String("string"),
    	LookAhead:                pulumi.Int(0),
    	LookBack:                 pulumi.Int(0),
    	MatchAhead:               pulumi.Int(0),
    	MatchAround:              pulumi.String("string"),
    	MatchBack:                pulumi.Int(0),
    	Name:                     pulumi.String("string"),
    	Pattern:                  pulumi.String("string"),
    	Transform:                pulumi.String("string"),
    	Vdomparam:                pulumi.String("string"),
    	Verify:                   pulumi.String("string"),
    	Verify2:                  pulumi.String("string"),
    	VerifyTransformedPattern: pulumi.String("string"),
    })
    
    var datatypeResource = new Datatype("datatypeResource", DatatypeArgs.builder()        
        .comment("string")
        .lookAhead(0)
        .lookBack(0)
        .matchAhead(0)
        .matchAround("string")
        .matchBack(0)
        .name("string")
        .pattern("string")
        .transform("string")
        .vdomparam("string")
        .verify("string")
        .verify2("string")
        .verifyTransformedPattern("string")
        .build());
    
    datatype_resource = fortios.dlp.Datatype("datatypeResource",
        comment="string",
        look_ahead=0,
        look_back=0,
        match_ahead=0,
        match_around="string",
        match_back=0,
        name="string",
        pattern="string",
        transform="string",
        vdomparam="string",
        verify="string",
        verify2="string",
        verify_transformed_pattern="string")
    
    const datatypeResource = new fortios.dlp.Datatype("datatypeResource", {
        comment: "string",
        lookAhead: 0,
        lookBack: 0,
        matchAhead: 0,
        matchAround: "string",
        matchBack: 0,
        name: "string",
        pattern: "string",
        transform: "string",
        vdomparam: "string",
        verify: "string",
        verify2: "string",
        verifyTransformedPattern: "string",
    });
    
    type: fortios:dlp:Datatype
    properties:
        comment: string
        lookAhead: 0
        lookBack: 0
        matchAhead: 0
        matchAround: string
        matchBack: 0
        name: string
        pattern: string
        transform: string
        vdomparam: string
        verify: string
        verify2: string
        verifyTransformedPattern: string
    

    Datatype Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Datatype resource accepts the following input properties:

    Comment string
    Optional comments.
    LookAhead int
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    LookBack int
    Number of characters required to save for verification (1 - 255, default = 1).
    MatchAhead int
    Number of characters behind for match-around (1 - 4096, default = 1).
    MatchAround string
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    MatchBack int
    Number of characters in front for match-around (1 - 4096, default = 1).
    Name string
    Name of table containing the data type.
    Pattern string
    Regular expression pattern string without look around.
    Transform string
    Template to transform user input to a pattern using capture group from 'pattern'.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Verify string
    Regular expression pattern string used to verify the data type.
    Verify2 string
    Extra regular expression pattern string used to verify the data type.
    VerifyTransformedPattern string
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    Comment string
    Optional comments.
    LookAhead int
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    LookBack int
    Number of characters required to save for verification (1 - 255, default = 1).
    MatchAhead int
    Number of characters behind for match-around (1 - 4096, default = 1).
    MatchAround string
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    MatchBack int
    Number of characters in front for match-around (1 - 4096, default = 1).
    Name string
    Name of table containing the data type.
    Pattern string
    Regular expression pattern string without look around.
    Transform string
    Template to transform user input to a pattern using capture group from 'pattern'.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Verify string
    Regular expression pattern string used to verify the data type.
    Verify2 string
    Extra regular expression pattern string used to verify the data type.
    VerifyTransformedPattern string
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    comment String
    Optional comments.
    lookAhead Integer
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    lookBack Integer
    Number of characters required to save for verification (1 - 255, default = 1).
    matchAhead Integer
    Number of characters behind for match-around (1 - 4096, default = 1).
    matchAround String
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    matchBack Integer
    Number of characters in front for match-around (1 - 4096, default = 1).
    name String
    Name of table containing the data type.
    pattern String
    Regular expression pattern string without look around.
    transform String
    Template to transform user input to a pattern using capture group from 'pattern'.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    verify String
    Regular expression pattern string used to verify the data type.
    verify2 String
    Extra regular expression pattern string used to verify the data type.
    verifyTransformedPattern String
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    comment string
    Optional comments.
    lookAhead number
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    lookBack number
    Number of characters required to save for verification (1 - 255, default = 1).
    matchAhead number
    Number of characters behind for match-around (1 - 4096, default = 1).
    matchAround string
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    matchBack number
    Number of characters in front for match-around (1 - 4096, default = 1).
    name string
    Name of table containing the data type.
    pattern string
    Regular expression pattern string without look around.
    transform string
    Template to transform user input to a pattern using capture group from 'pattern'.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    verify string
    Regular expression pattern string used to verify the data type.
    verify2 string
    Extra regular expression pattern string used to verify the data type.
    verifyTransformedPattern string
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    comment str
    Optional comments.
    look_ahead int
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    look_back int
    Number of characters required to save for verification (1 - 255, default = 1).
    match_ahead int
    Number of characters behind for match-around (1 - 4096, default = 1).
    match_around str
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    match_back int
    Number of characters in front for match-around (1 - 4096, default = 1).
    name str
    Name of table containing the data type.
    pattern str
    Regular expression pattern string without look around.
    transform str
    Template to transform user input to a pattern using capture group from 'pattern'.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    verify str
    Regular expression pattern string used to verify the data type.
    verify2 str
    Extra regular expression pattern string used to verify the data type.
    verify_transformed_pattern str
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    comment String
    Optional comments.
    lookAhead Number
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    lookBack Number
    Number of characters required to save for verification (1 - 255, default = 1).
    matchAhead Number
    Number of characters behind for match-around (1 - 4096, default = 1).
    matchAround String
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    matchBack Number
    Number of characters in front for match-around (1 - 4096, default = 1).
    name String
    Name of table containing the data type.
    pattern String
    Regular expression pattern string without look around.
    transform String
    Template to transform user input to a pattern using capture group from 'pattern'.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    verify String
    Regular expression pattern string used to verify the data type.
    verify2 String
    Extra regular expression pattern string used to verify the data type.
    verifyTransformedPattern String
    Enable/disable verification for transformed pattern. Valid values: enable, disable.

    Outputs

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

    Get an existing Datatype 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?: DatatypeState, opts?: CustomResourceOptions): Datatype
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            look_ahead: Optional[int] = None,
            look_back: Optional[int] = None,
            match_ahead: Optional[int] = None,
            match_around: Optional[str] = None,
            match_back: Optional[int] = None,
            name: Optional[str] = None,
            pattern: Optional[str] = None,
            transform: Optional[str] = None,
            vdomparam: Optional[str] = None,
            verify: Optional[str] = None,
            verify2: Optional[str] = None,
            verify_transformed_pattern: Optional[str] = None) -> Datatype
    func GetDatatype(ctx *Context, name string, id IDInput, state *DatatypeState, opts ...ResourceOption) (*Datatype, error)
    public static Datatype Get(string name, Input<string> id, DatatypeState? state, CustomResourceOptions? opts = null)
    public static Datatype get(String name, Output<String> id, DatatypeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Comment string
    Optional comments.
    LookAhead int
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    LookBack int
    Number of characters required to save for verification (1 - 255, default = 1).
    MatchAhead int
    Number of characters behind for match-around (1 - 4096, default = 1).
    MatchAround string
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    MatchBack int
    Number of characters in front for match-around (1 - 4096, default = 1).
    Name string
    Name of table containing the data type.
    Pattern string
    Regular expression pattern string without look around.
    Transform string
    Template to transform user input to a pattern using capture group from 'pattern'.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Verify string
    Regular expression pattern string used to verify the data type.
    Verify2 string
    Extra regular expression pattern string used to verify the data type.
    VerifyTransformedPattern string
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    Comment string
    Optional comments.
    LookAhead int
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    LookBack int
    Number of characters required to save for verification (1 - 255, default = 1).
    MatchAhead int
    Number of characters behind for match-around (1 - 4096, default = 1).
    MatchAround string
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    MatchBack int
    Number of characters in front for match-around (1 - 4096, default = 1).
    Name string
    Name of table containing the data type.
    Pattern string
    Regular expression pattern string without look around.
    Transform string
    Template to transform user input to a pattern using capture group from 'pattern'.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Verify string
    Regular expression pattern string used to verify the data type.
    Verify2 string
    Extra regular expression pattern string used to verify the data type.
    VerifyTransformedPattern string
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    comment String
    Optional comments.
    lookAhead Integer
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    lookBack Integer
    Number of characters required to save for verification (1 - 255, default = 1).
    matchAhead Integer
    Number of characters behind for match-around (1 - 4096, default = 1).
    matchAround String
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    matchBack Integer
    Number of characters in front for match-around (1 - 4096, default = 1).
    name String
    Name of table containing the data type.
    pattern String
    Regular expression pattern string without look around.
    transform String
    Template to transform user input to a pattern using capture group from 'pattern'.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    verify String
    Regular expression pattern string used to verify the data type.
    verify2 String
    Extra regular expression pattern string used to verify the data type.
    verifyTransformedPattern String
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    comment string
    Optional comments.
    lookAhead number
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    lookBack number
    Number of characters required to save for verification (1 - 255, default = 1).
    matchAhead number
    Number of characters behind for match-around (1 - 4096, default = 1).
    matchAround string
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    matchBack number
    Number of characters in front for match-around (1 - 4096, default = 1).
    name string
    Name of table containing the data type.
    pattern string
    Regular expression pattern string without look around.
    transform string
    Template to transform user input to a pattern using capture group from 'pattern'.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    verify string
    Regular expression pattern string used to verify the data type.
    verify2 string
    Extra regular expression pattern string used to verify the data type.
    verifyTransformedPattern string
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    comment str
    Optional comments.
    look_ahead int
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    look_back int
    Number of characters required to save for verification (1 - 255, default = 1).
    match_ahead int
    Number of characters behind for match-around (1 - 4096, default = 1).
    match_around str
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    match_back int
    Number of characters in front for match-around (1 - 4096, default = 1).
    name str
    Name of table containing the data type.
    pattern str
    Regular expression pattern string without look around.
    transform str
    Template to transform user input to a pattern using capture group from 'pattern'.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    verify str
    Regular expression pattern string used to verify the data type.
    verify2 str
    Extra regular expression pattern string used to verify the data type.
    verify_transformed_pattern str
    Enable/disable verification for transformed pattern. Valid values: enable, disable.
    comment String
    Optional comments.
    lookAhead Number
    Number of characters to obtain in advance for verification (1 - 255, default = 1).
    lookBack Number
    Number of characters required to save for verification (1 - 255, default = 1).
    matchAhead Number
    Number of characters behind for match-around (1 - 4096, default = 1).
    matchAround String
    Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported).
    matchBack Number
    Number of characters in front for match-around (1 - 4096, default = 1).
    name String
    Name of table containing the data type.
    pattern String
    Regular expression pattern string without look around.
    transform String
    Template to transform user input to a pattern using capture group from 'pattern'.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    verify String
    Regular expression pattern string used to verify the data type.
    verify2 String
    Extra regular expression pattern string used to verify the data type.
    verifyTransformedPattern String
    Enable/disable verification for transformed pattern. Valid values: enable, disable.

    Import

    Dlp DataType can be imported using any of these accepted formats:

    $ pulumi import fortios:dlp/datatype:Datatype labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:dlp/datatype:Datatype labelname {{name}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse