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

fortios.dlp.Exactdatamatch

Explore with Pulumi AI

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

    Configure exact-data-match template used by DLP scan. Applies to FortiOS Version >= 7.4.2.

    Create Exactdatamatch Resource

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

    Constructor syntax

    new Exactdatamatch(name: string, args?: ExactdatamatchArgs, opts?: CustomResourceOptions);
    @overload
    def Exactdatamatch(resource_name: str,
                       args: Optional[ExactdatamatchArgs] = None,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def Exactdatamatch(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       columns: Optional[Sequence[ExactdatamatchColumnArgs]] = None,
                       data: Optional[str] = None,
                       dynamic_sort_subtable: Optional[str] = None,
                       get_all_tables: Optional[str] = None,
                       name: Optional[str] = None,
                       optional: Optional[int] = None,
                       vdomparam: Optional[str] = None)
    func NewExactdatamatch(ctx *Context, name string, args *ExactdatamatchArgs, opts ...ResourceOption) (*Exactdatamatch, error)
    public Exactdatamatch(string name, ExactdatamatchArgs? args = null, CustomResourceOptions? opts = null)
    public Exactdatamatch(String name, ExactdatamatchArgs args)
    public Exactdatamatch(String name, ExactdatamatchArgs args, CustomResourceOptions options)
    
    type: fortios:dlp:Exactdatamatch
    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 ExactdatamatchArgs
    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 ExactdatamatchArgs
    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 ExactdatamatchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExactdatamatchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExactdatamatchArgs
    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 exactdatamatchResource = new Fortios.Dlp.Exactdatamatch("exactdatamatchResource", new()
    {
        Columns = new[]
        {
            new Fortios.Dlp.Inputs.ExactdatamatchColumnArgs
            {
                Index = 0,
                Optional = "string",
                Type = "string",
            },
        },
        Data = "string",
        DynamicSortSubtable = "string",
        GetAllTables = "string",
        Name = "string",
        Optional = 0,
        Vdomparam = "string",
    });
    
    example, err := dlp.NewExactdatamatch(ctx, "exactdatamatchResource", &dlp.ExactdatamatchArgs{
    	Columns: dlp.ExactdatamatchColumnArray{
    		&dlp.ExactdatamatchColumnArgs{
    			Index:    pulumi.Int(0),
    			Optional: pulumi.String("string"),
    			Type:     pulumi.String("string"),
    		},
    	},
    	Data:                pulumi.String("string"),
    	DynamicSortSubtable: pulumi.String("string"),
    	GetAllTables:        pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	Optional:            pulumi.Int(0),
    	Vdomparam:           pulumi.String("string"),
    })
    
    var exactdatamatchResource = new Exactdatamatch("exactdatamatchResource", ExactdatamatchArgs.builder()
        .columns(ExactdatamatchColumnArgs.builder()
            .index(0)
            .optional("string")
            .type("string")
            .build())
        .data("string")
        .dynamicSortSubtable("string")
        .getAllTables("string")
        .name("string")
        .optional(0)
        .vdomparam("string")
        .build());
    
    exactdatamatch_resource = fortios.dlp.Exactdatamatch("exactdatamatchResource",
        columns=[fortios.dlp.ExactdatamatchColumnArgs(
            index=0,
            optional="string",
            type="string",
        )],
        data="string",
        dynamic_sort_subtable="string",
        get_all_tables="string",
        name="string",
        optional=0,
        vdomparam="string")
    
    const exactdatamatchResource = new fortios.dlp.Exactdatamatch("exactdatamatchResource", {
        columns: [{
            index: 0,
            optional: "string",
            type: "string",
        }],
        data: "string",
        dynamicSortSubtable: "string",
        getAllTables: "string",
        name: "string",
        optional: 0,
        vdomparam: "string",
    });
    
    type: fortios:dlp:Exactdatamatch
    properties:
        columns:
            - index: 0
              optional: string
              type: string
        data: string
        dynamicSortSubtable: string
        getAllTables: string
        name: string
        optional: 0
        vdomparam: string
    

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

    Columns List<Pulumiverse.Fortios.Dlp.Inputs.ExactdatamatchColumn>
    DLP exact-data-match column types. The structure of columns block is documented below.
    Data string
    External resource for exact data match.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Name of table containing the exact-data-match template.
    Optional int
    Number of optional columns need to match.
    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.
    Columns []ExactdatamatchColumnArgs
    DLP exact-data-match column types. The structure of columns block is documented below.
    Data string
    External resource for exact data match.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Name of table containing the exact-data-match template.
    Optional int
    Number of optional columns need to match.
    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.
    columns List<ExactdatamatchColumn>
    DLP exact-data-match column types. The structure of columns block is documented below.
    data String
    External resource for exact data match.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Name of table containing the exact-data-match template.
    optional Integer
    Number of optional columns need to match.
    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.
    columns ExactdatamatchColumn[]
    DLP exact-data-match column types. The structure of columns block is documented below.
    data string
    External resource for exact data match.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Name of table containing the exact-data-match template.
    optional number
    Number of optional columns need to match.
    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.
    columns Sequence[ExactdatamatchColumnArgs]
    DLP exact-data-match column types. The structure of columns block is documented below.
    data str
    External resource for exact data match.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Name of table containing the exact-data-match template.
    optional int
    Number of optional columns need to match.
    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.
    columns List<Property Map>
    DLP exact-data-match column types. The structure of columns block is documented below.
    data String
    External resource for exact data match.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Name of table containing the exact-data-match template.
    optional Number
    Number of optional columns need to match.
    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.

    Outputs

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

    Get an existing Exactdatamatch 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?: ExactdatamatchState, opts?: CustomResourceOptions): Exactdatamatch
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            columns: Optional[Sequence[ExactdatamatchColumnArgs]] = None,
            data: Optional[str] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            name: Optional[str] = None,
            optional: Optional[int] = None,
            vdomparam: Optional[str] = None) -> Exactdatamatch
    func GetExactdatamatch(ctx *Context, name string, id IDInput, state *ExactdatamatchState, opts ...ResourceOption) (*Exactdatamatch, error)
    public static Exactdatamatch Get(string name, Input<string> id, ExactdatamatchState? state, CustomResourceOptions? opts = null)
    public static Exactdatamatch get(String name, Output<String> id, ExactdatamatchState 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:
    Columns List<Pulumiverse.Fortios.Dlp.Inputs.ExactdatamatchColumn>
    DLP exact-data-match column types. The structure of columns block is documented below.
    Data string
    External resource for exact data match.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Name of table containing the exact-data-match template.
    Optional int
    Number of optional columns need to match.
    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.
    Columns []ExactdatamatchColumnArgs
    DLP exact-data-match column types. The structure of columns block is documented below.
    Data string
    External resource for exact data match.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Name of table containing the exact-data-match template.
    Optional int
    Number of optional columns need to match.
    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.
    columns List<ExactdatamatchColumn>
    DLP exact-data-match column types. The structure of columns block is documented below.
    data String
    External resource for exact data match.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Name of table containing the exact-data-match template.
    optional Integer
    Number of optional columns need to match.
    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.
    columns ExactdatamatchColumn[]
    DLP exact-data-match column types. The structure of columns block is documented below.
    data string
    External resource for exact data match.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Name of table containing the exact-data-match template.
    optional number
    Number of optional columns need to match.
    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.
    columns Sequence[ExactdatamatchColumnArgs]
    DLP exact-data-match column types. The structure of columns block is documented below.
    data str
    External resource for exact data match.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Name of table containing the exact-data-match template.
    optional int
    Number of optional columns need to match.
    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.
    columns List<Property Map>
    DLP exact-data-match column types. The structure of columns block is documented below.
    data String
    External resource for exact data match.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Name of table containing the exact-data-match template.
    optional Number
    Number of optional columns need to match.
    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.

    Supporting Types

    ExactdatamatchColumn, ExactdatamatchColumnArgs

    Index int
    Column index.
    Optional string
    Enable/disable optional match. Valid values: enable, disable.
    Type string
    Data-type for this column.
    Index int
    Column index.
    Optional string
    Enable/disable optional match. Valid values: enable, disable.
    Type string
    Data-type for this column.
    index Integer
    Column index.
    optional String
    Enable/disable optional match. Valid values: enable, disable.
    type String
    Data-type for this column.
    index number
    Column index.
    optional string
    Enable/disable optional match. Valid values: enable, disable.
    type string
    Data-type for this column.
    index int
    Column index.
    optional str
    Enable/disable optional match. Valid values: enable, disable.
    type str
    Data-type for this column.
    index Number
    Column index.
    optional String
    Enable/disable optional match. Valid values: enable, disable.
    type String
    Data-type for this column.

    Import

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

    $ pulumi import fortios:dlp/exactdatamatch:Exactdatamatch labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:dlp/exactdatamatch:Exactdatamatch 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