1. Packages
  2. Fortios
  3. API Docs
  4. ips
  5. Viewmap
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.ips.Viewmap

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

    configure ips view-map Applies to FortiOS Version >= 6.2.4.

    Create Viewmap Resource

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

    Constructor syntax

    new Viewmap(name: string, args?: ViewmapArgs, opts?: CustomResourceOptions);
    @overload
    def Viewmap(resource_name: str,
                args: Optional[ViewmapArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Viewmap(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                fosid: Optional[int] = None,
                id_policy_id: Optional[int] = None,
                policy_id: Optional[int] = None,
                vdom_id: Optional[int] = None,
                vdomparam: Optional[str] = None,
                which: Optional[str] = None)
    func NewViewmap(ctx *Context, name string, args *ViewmapArgs, opts ...ResourceOption) (*Viewmap, error)
    public Viewmap(string name, ViewmapArgs? args = null, CustomResourceOptions? opts = null)
    public Viewmap(String name, ViewmapArgs args)
    public Viewmap(String name, ViewmapArgs args, CustomResourceOptions options)
    
    type: fortios:ips:Viewmap
    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 ViewmapArgs
    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 ViewmapArgs
    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 ViewmapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ViewmapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ViewmapArgs
    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 viewmapResource = new Fortios.Ips.Viewmap("viewmapResource", new()
    {
        Fosid = 0,
        IdPolicyId = 0,
        PolicyId = 0,
        VdomId = 0,
        Vdomparam = "string",
        Which = "string",
    });
    
    example, err := ips.NewViewmap(ctx, "viewmapResource", &ips.ViewmapArgs{
    	Fosid:      pulumi.Int(0),
    	IdPolicyId: pulumi.Int(0),
    	PolicyId:   pulumi.Int(0),
    	VdomId:     pulumi.Int(0),
    	Vdomparam:  pulumi.String("string"),
    	Which:      pulumi.String("string"),
    })
    
    var viewmapResource = new Viewmap("viewmapResource", ViewmapArgs.builder()
        .fosid(0)
        .idPolicyId(0)
        .policyId(0)
        .vdomId(0)
        .vdomparam("string")
        .which("string")
        .build());
    
    viewmap_resource = fortios.ips.Viewmap("viewmapResource",
        fosid=0,
        id_policy_id=0,
        policy_id=0,
        vdom_id=0,
        vdomparam="string",
        which="string")
    
    const viewmapResource = new fortios.ips.Viewmap("viewmapResource", {
        fosid: 0,
        idPolicyId: 0,
        policyId: 0,
        vdomId: 0,
        vdomparam: "string",
        which: "string",
    });
    
    type: fortios:ips:Viewmap
    properties:
        fosid: 0
        idPolicyId: 0
        policyId: 0
        vdomId: 0
        vdomparam: string
        which: string
    

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

    Fosid int
    View ID.
    IdPolicyId int
    ID-based policy ID.
    PolicyId int
    Policy ID.
    VdomId int
    VDOM ID.
    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.
    Which string
    Policy.
    Fosid int
    View ID.
    IdPolicyId int
    ID-based policy ID.
    PolicyId int
    Policy ID.
    VdomId int
    VDOM ID.
    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.
    Which string
    Policy.
    fosid Integer
    View ID.
    idPolicyId Integer
    ID-based policy ID.
    policyId Integer
    Policy ID.
    vdomId Integer
    VDOM ID.
    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.
    which String
    Policy.
    fosid number
    View ID.
    idPolicyId number
    ID-based policy ID.
    policyId number
    Policy ID.
    vdomId number
    VDOM ID.
    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.
    which string
    Policy.
    fosid int
    View ID.
    id_policy_id int
    ID-based policy ID.
    policy_id int
    Policy ID.
    vdom_id int
    VDOM ID.
    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.
    which str
    Policy.
    fosid Number
    View ID.
    idPolicyId Number
    ID-based policy ID.
    policyId Number
    Policy ID.
    vdomId Number
    VDOM ID.
    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.
    which String
    Policy.

    Outputs

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

    Get an existing Viewmap 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?: ViewmapState, opts?: CustomResourceOptions): Viewmap
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            fosid: Optional[int] = None,
            id_policy_id: Optional[int] = None,
            policy_id: Optional[int] = None,
            vdom_id: Optional[int] = None,
            vdomparam: Optional[str] = None,
            which: Optional[str] = None) -> Viewmap
    func GetViewmap(ctx *Context, name string, id IDInput, state *ViewmapState, opts ...ResourceOption) (*Viewmap, error)
    public static Viewmap Get(string name, Input<string> id, ViewmapState? state, CustomResourceOptions? opts = null)
    public static Viewmap get(String name, Output<String> id, ViewmapState 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:
    Fosid int
    View ID.
    IdPolicyId int
    ID-based policy ID.
    PolicyId int
    Policy ID.
    VdomId int
    VDOM ID.
    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.
    Which string
    Policy.
    Fosid int
    View ID.
    IdPolicyId int
    ID-based policy ID.
    PolicyId int
    Policy ID.
    VdomId int
    VDOM ID.
    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.
    Which string
    Policy.
    fosid Integer
    View ID.
    idPolicyId Integer
    ID-based policy ID.
    policyId Integer
    Policy ID.
    vdomId Integer
    VDOM ID.
    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.
    which String
    Policy.
    fosid number
    View ID.
    idPolicyId number
    ID-based policy ID.
    policyId number
    Policy ID.
    vdomId number
    VDOM ID.
    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.
    which string
    Policy.
    fosid int
    View ID.
    id_policy_id int
    ID-based policy ID.
    policy_id int
    Policy ID.
    vdom_id int
    VDOM ID.
    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.
    which str
    Policy.
    fosid Number
    View ID.
    idPolicyId Number
    ID-based policy ID.
    policyId Number
    Policy ID.
    vdomId Number
    VDOM ID.
    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.
    which String
    Policy.

    Import

    Ips ViewMap can be imported using any of these accepted formats:

    $ pulumi import fortios:ips/viewmap:Viewmap labelname {{fosid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:ips/viewmap:Viewmap labelname {{fosid}}
    

    $ 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.6 published on Tuesday, Jul 9, 2024 by pulumiverse