1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectDlpLabel
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
Schema (JSON)
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectDlpLabel

fortimanager logo
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
Schema (JSON)
fortinetdev/terraform-provider-fortimanager

    Configure labels used by DLP blocking.

    The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

    • entries: fortimanager.ObjectDlpLabelEntries

    Create ObjectDlpLabel Resource

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

    Constructor syntax

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

@overload
def ObjectDlpLabel(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   adom: Optional[str] = None,
                   comment: Optional[str] = None,
                   connectors: Optional[Sequence[str]] = None,
                   dynamic_sort_subtable: Optional[str] = None,
                   entries: Optional[Sequence[ObjectDlpLabelEntryArgs]] = None,
                   mpip_type: Optional[str] = None,
                   name: Optional[str] = None,
                   object_dlp_label_id: Optional[str] = None,
                   scopetype: Optional[str] = None,
                   type: Optional[str] = None)
    func NewObjectDlpLabel(ctx *Context, name string, args *ObjectDlpLabelArgs, opts ...ResourceOption) (*ObjectDlpLabel, error)
    public ObjectDlpLabel(string name, ObjectDlpLabelArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectDlpLabel(String name, ObjectDlpLabelArgs args)
public ObjectDlpLabel(String name, ObjectDlpLabelArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectDlpLabel
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 ObjectDlpLabelArgs
    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 ObjectDlpLabelArgs
    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 ObjectDlpLabelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectDlpLabelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectDlpLabelArgs
    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 objectDlpLabelResource = new Fortimanager.ObjectDlpLabel("objectDlpLabelResource", new()
{
    Adom = "string",
    Comment = "string",
    Connectors = new[]
    {
        "string",
    },
    DynamicSortSubtable = "string",
    Entries = new[]
    {
        new Fortimanager.Inputs.ObjectDlpLabelEntryArgs
        {
            FortidataLabelName = "string",
            Guid = "string",
            Id = 0,
            MpipLabelName = "string",
        },
    },
    MpipType = "string",
    Name = "string",
    ObjectDlpLabelId = "string",
    Scopetype = "string",
    Type = "string",
});

    example, err := fortimanager.NewObjectDlpLabel(ctx, "objectDlpLabelResource", &fortimanager.ObjectDlpLabelArgs{
	Adom:    pulumi.String("string"),
	Comment: pulumi.String("string"),
	Connectors: pulumi.StringArray{
		pulumi.String("string"),
	},
	DynamicSortSubtable: pulumi.String("string"),
	Entries: fortimanager.ObjectDlpLabelEntryArray{
		&fortimanager.ObjectDlpLabelEntryArgs{
			FortidataLabelName: pulumi.String("string"),
			Guid:               pulumi.String("string"),
			Id:                 pulumi.Float64(0),
			MpipLabelName:      pulumi.String("string"),
		},
	},
	MpipType:         pulumi.String("string"),
	Name:             pulumi.String("string"),
	ObjectDlpLabelId: pulumi.String("string"),
	Scopetype:        pulumi.String("string"),
	Type:             pulumi.String("string"),
})

    var objectDlpLabelResource = new ObjectDlpLabel("objectDlpLabelResource", ObjectDlpLabelArgs.builder()
    .adom("string")
    .comment("string")
    .connectors("string")
    .dynamicSortSubtable("string")
    .entries(ObjectDlpLabelEntryArgs.builder()
        .fortidataLabelName("string")
        .guid("string")
        .id(0.0)
        .mpipLabelName("string")
        .build())
    .mpipType("string")
    .name("string")
    .objectDlpLabelId("string")
    .scopetype("string")
    .type("string")
    .build());

    object_dlp_label_resource = fortimanager.ObjectDlpLabel("objectDlpLabelResource",
    adom="string",
    comment="string",
    connectors=["string"],
    dynamic_sort_subtable="string",
    entries=[{
        "fortidata_label_name": "string",
        "guid": "string",
        "id": 0,
        "mpip_label_name": "string",
    }],
    mpip_type="string",
    name="string",
    object_dlp_label_id="string",
    scopetype="string",
    type="string")

    const objectDlpLabelResource = new fortimanager.ObjectDlpLabel("objectDlpLabelResource", {
    adom: "string",
    comment: "string",
    connectors: ["string"],
    dynamicSortSubtable: "string",
    entries: [{
        fortidataLabelName: "string",
        guid: "string",
        id: 0,
        mpipLabelName: "string",
    }],
    mpipType: "string",
    name: "string",
    objectDlpLabelId: "string",
    scopetype: "string",
    type: "string",
});

    type: fortimanager:ObjectDlpLabel
properties:
    adom: string
    comment: string
    connectors:
        - string
    dynamicSortSubtable: string
    entries:
        - fortidataLabelName: string
          guid: string
          id: 0
          mpipLabelName: string
    mpipType: string
    name: string
    objectDlpLabelId: string
    scopetype: string
    type: string

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

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comment string
    Optional comments.
    Connectors List<string>
    Name of SDN connector.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Entries List<ObjectDlpLabelEntry>
    Entries. The structure of entries block is documented below.
    MpipType string
    MPIP label type. Valid values: local, remote.
    Name string
    Name of table containing the label.
    ObjectDlpLabelId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Label type. Valid values: mpip.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comment string
    Optional comments.
    Connectors []string
    Name of SDN connector.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Entries []ObjectDlpLabelEntryArgs
    Entries. The structure of entries block is documented below.
    MpipType string
    MPIP label type. Valid values: local, remote.
    Name string
    Name of table containing the label.
    ObjectDlpLabelId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Label type. Valid values: mpip.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment String
    Optional comments.
    connectors List<String>
    Name of SDN connector.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    entries List<ObjectDlpLabelEntry>
    Entries. The structure of entries block is documented below.
    mpipType String
    MPIP label type. Valid values: local, remote.
    name String
    Name of table containing the label.
    objectDlpLabelId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Label type. Valid values: mpip.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment string
    Optional comments.
    connectors string[]
    Name of SDN connector.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    entries ObjectDlpLabelEntry[]
    Entries. The structure of entries block is documented below.
    mpipType string
    MPIP label type. Valid values: local, remote.
    name string
    Name of table containing the label.
    objectDlpLabelId string
    an identifier for the resource with format {{name}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type string
    Label type. Valid values: mpip.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment str
    Optional comments.
    connectors Sequence[str]
    Name of SDN connector.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    entries Sequence[ObjectDlpLabelEntryArgs]
    Entries. The structure of entries block is documented below.
    mpip_type str
    MPIP label type. Valid values: local, remote.
    name str
    Name of table containing the label.
    object_dlp_label_id str
    an identifier for the resource with format {{name}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type str
    Label type. Valid values: mpip.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment String
    Optional comments.
    connectors List<String>
    Name of SDN connector.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    entries List<Property Map>
    Entries. The structure of entries block is documented below.
    mpipType String
    MPIP label type. Valid values: local, remote.
    name String
    Name of table containing the label.
    objectDlpLabelId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Label type. Valid values: mpip.

    Outputs

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

    Get an existing ObjectDlpLabel 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?: ObjectDlpLabelState, opts?: CustomResourceOptions): ObjectDlpLabel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        comment: Optional[str] = None,
        connectors: Optional[Sequence[str]] = None,
        dynamic_sort_subtable: Optional[str] = None,
        entries: Optional[Sequence[ObjectDlpLabelEntryArgs]] = None,
        mpip_type: Optional[str] = None,
        name: Optional[str] = None,
        object_dlp_label_id: Optional[str] = None,
        scopetype: Optional[str] = None,
        type: Optional[str] = None) -> ObjectDlpLabel
    func GetObjectDlpLabel(ctx *Context, name string, id IDInput, state *ObjectDlpLabelState, opts ...ResourceOption) (*ObjectDlpLabel, error)
    public static ObjectDlpLabel Get(string name, Input<string> id, ObjectDlpLabelState? state, CustomResourceOptions? opts = null)
    public static ObjectDlpLabel get(String name, Output<String> id, ObjectDlpLabelState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectDlpLabel    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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comment string
    Optional comments.
    Connectors List<string>
    Name of SDN connector.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Entries List<ObjectDlpLabelEntry>
    Entries. The structure of entries block is documented below.
    MpipType string
    MPIP label type. Valid values: local, remote.
    Name string
    Name of table containing the label.
    ObjectDlpLabelId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Label type. Valid values: mpip.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comment string
    Optional comments.
    Connectors []string
    Name of SDN connector.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Entries []ObjectDlpLabelEntryArgs
    Entries. The structure of entries block is documented below.
    MpipType string
    MPIP label type. Valid values: local, remote.
    Name string
    Name of table containing the label.
    ObjectDlpLabelId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Label type. Valid values: mpip.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment String
    Optional comments.
    connectors List<String>
    Name of SDN connector.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    entries List<ObjectDlpLabelEntry>
    Entries. The structure of entries block is documented below.
    mpipType String
    MPIP label type. Valid values: local, remote.
    name String
    Name of table containing the label.
    objectDlpLabelId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Label type. Valid values: mpip.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment string
    Optional comments.
    connectors string[]
    Name of SDN connector.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    entries ObjectDlpLabelEntry[]
    Entries. The structure of entries block is documented below.
    mpipType string
    MPIP label type. Valid values: local, remote.
    name string
    Name of table containing the label.
    objectDlpLabelId string
    an identifier for the resource with format {{name}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type string
    Label type. Valid values: mpip.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment str
    Optional comments.
    connectors Sequence[str]
    Name of SDN connector.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    entries Sequence[ObjectDlpLabelEntryArgs]
    Entries. The structure of entries block is documented below.
    mpip_type str
    MPIP label type. Valid values: local, remote.
    name str
    Name of table containing the label.
    object_dlp_label_id str
    an identifier for the resource with format {{name}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type str
    Label type. Valid values: mpip.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment String
    Optional comments.
    connectors List<String>
    Name of SDN connector.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    entries List<Property Map>
    Entries. The structure of entries block is documented below.
    mpipType String
    MPIP label type. Valid values: local, remote.
    name String
    Name of table containing the label.
    objectDlpLabelId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Label type. Valid values: mpip.

    Supporting Types

    ObjectDlpLabelEntry, ObjectDlpLabelEntryArgs

    FortidataLabelName string
    Name of FortiData label
    Guid string
    MPIP label guid.
    Id double
    ID.
    MpipLabelName string
    Name of MPIP label.
    FortidataLabelName string
    Name of FortiData label
    Guid string
    MPIP label guid.
    Id float64
    ID.
    MpipLabelName string
    Name of MPIP label.
    fortidataLabelName String
    Name of FortiData label
    guid String
    MPIP label guid.
    id Double
    ID.
    mpipLabelName String
    Name of MPIP label.
    fortidataLabelName string
    Name of FortiData label
    guid string
    MPIP label guid.
    id number
    ID.
    mpipLabelName string
    Name of MPIP label.
    fortidata_label_name str
    Name of FortiData label
    guid str
    MPIP label guid.
    id float
    ID.
    mpip_label_name str
    Name of MPIP label.
    fortidataLabelName String
    Name of FortiData label
    guid String
    MPIP label guid.
    id Number
    ID.
    mpipLabelName String
    Name of MPIP label.

    Import

    ObjectDlp Label can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectDlpLabel:ObjectDlpLabel labelname {{name}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
    Schema (JSON)
    fortinetdev/terraform-provider-fortimanager
      Meet Neo: Your AI Platform Teammate