Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectFmgVariable
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectFmgVariable

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    ObjectFmg Variable

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

    • dynamic_mapping: fortimanager.ObjectFmgVariableDynamicMapping

    Example Usage

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

const trname = new fortimanager.ObjectFmgVariable("trname", {
    description: "This is a Terraform example",
    value: "value",
});

    import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectFmgVariable("trname",
    description="This is a Terraform example",
    value="value")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewObjectFmgVariable(ctx, "trname", &fortimanager.ObjectFmgVariableArgs{
			Description: pulumi.String("This is a Terraform example"),
			Value:       pulumi.String("value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.ObjectFmgVariable("trname", new()
    {
        Description = "This is a Terraform example",
        Value = "value",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectFmgVariable;
import com.pulumi.fortimanager.ObjectFmgVariableArgs;
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 trname = new ObjectFmgVariable("trname", ObjectFmgVariableArgs.builder()
            .description("This is a Terraform example")
            .value("value")
            .build());

    }
}

    resources:
  trname:
    type: fortimanager:ObjectFmgVariable
    properties:
      description: This is a Terraform example
      value: value

    Create ObjectFmgVariable Resource

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

    Constructor syntax

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

@overload
def ObjectFmgVariable(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      adom: Optional[str] = None,
                      description: Optional[str] = None,
                      dynamic_mappings: Optional[Sequence[ObjectFmgVariableDynamicMappingArgs]] = None,
                      dynamic_sort_subtable: Optional[str] = None,
                      name: Optional[str] = None,
                      object_fmg_variable_id: Optional[str] = None,
                      scopetype: Optional[str] = None,
                      value: Optional[str] = None)
    func NewObjectFmgVariable(ctx *Context, name string, args *ObjectFmgVariableArgs, opts ...ResourceOption) (*ObjectFmgVariable, error)
    public ObjectFmgVariable(string name, ObjectFmgVariableArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectFmgVariable(String name, ObjectFmgVariableArgs args)
public ObjectFmgVariable(String name, ObjectFmgVariableArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectFmgVariable
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 ObjectFmgVariableArgs
    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 ObjectFmgVariableArgs
    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 ObjectFmgVariableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectFmgVariableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectFmgVariableArgs
    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 objectFmgVariableResource = new Fortimanager.ObjectFmgVariable("objectFmgVariableResource", new()
{
    Adom = "string",
    Description = "string",
    DynamicMappings = new[]
    {
        new Fortimanager.Inputs.ObjectFmgVariableDynamicMappingArgs
        {
            _scopes = new[]
            {
                new Fortimanager.Inputs.ObjectFmgVariableDynamicMapping_ScopeArgs
                {
                    Name = "string",
                    Vdom = "string",
                },
            },
            Value = "string",
        },
    },
    DynamicSortSubtable = "string",
    Name = "string",
    ObjectFmgVariableId = "string",
    Scopetype = "string",
    Value = "string",
});

    example, err := fortimanager.NewObjectFmgVariable(ctx, "objectFmgVariableResource", &fortimanager.ObjectFmgVariableArgs{
Adom: pulumi.String("string"),
Description: pulumi.String("string"),
DynamicMappings: .ObjectFmgVariableDynamicMappingTypeArray{
&.ObjectFmgVariableDynamicMappingTypeArgs{
_scopes: .ObjectFmgVariableDynamicMapping_ScopeArray{
&.ObjectFmgVariableDynamicMapping_ScopeArgs{
Name: pulumi.String("string"),
Vdom: pulumi.String("string"),
},
},
Value: pulumi.String("string"),
},
},
DynamicSortSubtable: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectFmgVariableId: pulumi.String("string"),
Scopetype: pulumi.String("string"),
Value: pulumi.String("string"),
})

    var objectFmgVariableResource = new ObjectFmgVariable("objectFmgVariableResource", ObjectFmgVariableArgs.builder()
    .adom("string")
    .description("string")
    .dynamicMappings(ObjectFmgVariableDynamicMappingArgs.builder()
        ._scopes(ObjectFmgVariableDynamicMapping_ScopeArgs.builder()
            .name("string")
            .vdom("string")
            .build())
        .value("string")
        .build())
    .dynamicSortSubtable("string")
    .name("string")
    .objectFmgVariableId("string")
    .scopetype("string")
    .value("string")
    .build());

    object_fmg_variable_resource = fortimanager.ObjectFmgVariable("objectFmgVariableResource",
    adom="string",
    description="string",
    dynamic_mappings=[{
        "_scopes": [{
            "name": "string",
            "vdom": "string",
        }],
        "value": "string",
    }],
    dynamic_sort_subtable="string",
    name="string",
    object_fmg_variable_id="string",
    scopetype="string",
    value="string")

    const objectFmgVariableResource = new fortimanager.ObjectFmgVariable("objectFmgVariableResource", {
    adom: "string",
    description: "string",
    dynamicMappings: [{
        _scopes: [{
            name: "string",
            vdom: "string",
        }],
        value: "string",
    }],
    dynamicSortSubtable: "string",
    name: "string",
    objectFmgVariableId: "string",
    scopetype: "string",
    value: "string",
});

    type: fortimanager:ObjectFmgVariable
properties:
    adom: string
    description: string
    dynamicMappings:
        - _scopes:
            - name: string
              vdom: string
          value: string
    dynamicSortSubtable: string
    name: string
    objectFmgVariableId: string
    scopetype: string
    value: string

    ObjectFmgVariable 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 ObjectFmgVariable 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.
    Description string
    Description.
    DynamicMappings List<ObjectFmgVariableDynamicMapping>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    Name string
    Name.
    ObjectFmgVariableId 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.
    Value string
    Value.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Description string
    Description.
    DynamicMappings []ObjectFmgVariableDynamicMappingTypeArgs
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    Name string
    Name.
    ObjectFmgVariableId 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.
    Value string
    Value.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description String
    Description.
    dynamicMappings List<ObjectFmgVariableDynamicMapping>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    name String
    Name.
    objectFmgVariableId 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.
    value String
    Value.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description string
    Description.
    dynamicMappings ObjectFmgVariableDynamicMapping[]
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    name string
    Name.
    objectFmgVariableId 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.
    value string
    Value.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description str
    Description.
    dynamic_mappings Sequence[ObjectFmgVariableDynamicMappingArgs]
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    name str
    Name.
    object_fmg_variable_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.
    value str
    Value.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description String
    Description.
    dynamicMappings List<Property Map>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    name String
    Name.
    objectFmgVariableId 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.
    value String
    Value.

    Outputs

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

    Get an existing ObjectFmgVariable 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?: ObjectFmgVariableState, opts?: CustomResourceOptions): ObjectFmgVariable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        description: Optional[str] = None,
        dynamic_mappings: Optional[Sequence[ObjectFmgVariableDynamicMappingArgs]] = None,
        dynamic_sort_subtable: Optional[str] = None,
        name: Optional[str] = None,
        object_fmg_variable_id: Optional[str] = None,
        scopetype: Optional[str] = None,
        value: Optional[str] = None) -> ObjectFmgVariable
    func GetObjectFmgVariable(ctx *Context, name string, id IDInput, state *ObjectFmgVariableState, opts ...ResourceOption) (*ObjectFmgVariable, error)
    public static ObjectFmgVariable Get(string name, Input<string> id, ObjectFmgVariableState? state, CustomResourceOptions? opts = null)
    public static ObjectFmgVariable get(String name, Output<String> id, ObjectFmgVariableState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectFmgVariable    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.
    Description string
    Description.
    DynamicMappings List<ObjectFmgVariableDynamicMapping>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    Name string
    Name.
    ObjectFmgVariableId 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.
    Value string
    Value.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Description string
    Description.
    DynamicMappings []ObjectFmgVariableDynamicMappingTypeArgs
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    Name string
    Name.
    ObjectFmgVariableId 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.
    Value string
    Value.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description String
    Description.
    dynamicMappings List<ObjectFmgVariableDynamicMapping>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    name String
    Name.
    objectFmgVariableId 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.
    value String
    Value.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description string
    Description.
    dynamicMappings ObjectFmgVariableDynamicMapping[]
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    name string
    Name.
    objectFmgVariableId 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.
    value string
    Value.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description str
    Description.
    dynamic_mappings Sequence[ObjectFmgVariableDynamicMappingArgs]
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    name str
    Name.
    object_fmg_variable_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.
    value str
    Value.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description String
    Description.
    dynamicMappings List<Property Map>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    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.
    name String
    Name.
    objectFmgVariableId 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.
    value String
    Value.

    Supporting Types

    ObjectFmgVariableDynamicMapping, ObjectFmgVariableDynamicMappingArgs

    Value string
    Value.
    _scopes List<ObjectFmgVariableDynamicMapping_Scope>
    _Scope. The structure of _scope block is documented below.
    Value string
    Value.
    _scopes []ObjectFmgVariableDynamicMapping_Scope
    _Scope. The structure of _scope block is documented below.
    _scopes List<ObjectFmgVariableDynamicMapping_Scope>
    _Scope. The structure of _scope block is documented below.
    value String
    Value.
    _scopes ObjectFmgVariableDynamicMapping_Scope[]
    _Scope. The structure of _scope block is documented below.
    value string
    Value.
    _scopes Sequence[ObjectFmgVariableDynamicMapping_Scope]
    _Scope. The structure of _scope block is documented below.
    value str
    Value.
    _scopes List<Property Map>
    _Scope. The structure of _scope block is documented below.
    value String
    Value.

    ObjectFmgVariableDynamicMapping_Scope, ObjectFmgVariableDynamicMapping_ScopeArgs

    Name string
    Name.
    Vdom string
    Vdom.
    Name string
    Name.
    Vdom string
    Vdom.
    name String
    Name.
    vdom String
    Vdom.
    name string
    Name.
    vdom string
    Vdom.
    name str
    Name.
    vdom str
    Vdom.
    name String
    Name.
    vdom String
    Vdom.

    Import

    ObjectFmg Variable can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectFmgVariable:ObjectFmgVariable 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.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager