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

fortimanager.ObjectFirewallShaperTrafficshaper

Explore with Pulumi AI

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

    Configure shared traffic shaper.

    Example Usage

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

const trname = new fortimanager.ObjectFirewallShaperTrafficshaper("trname", {
    bandwidthUnit: "mbps",
    diffserv: "disable",
    perPolicy: "disable",
    priority: "medium",
});

    import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectFirewallShaperTrafficshaper("trname",
    bandwidth_unit="mbps",
    diffserv="disable",
    per_policy="disable",
    priority="medium")

    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.NewObjectFirewallShaperTrafficshaper(ctx, "trname", &fortimanager.ObjectFirewallShaperTrafficshaperArgs{
			BandwidthUnit: pulumi.String("mbps"),
			Diffserv:      pulumi.String("disable"),
			PerPolicy:     pulumi.String("disable"),
			Priority:      pulumi.String("medium"),
		})
		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.ObjectFirewallShaperTrafficshaper("trname", new()
    {
        BandwidthUnit = "mbps",
        Diffserv = "disable",
        PerPolicy = "disable",
        Priority = "medium",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectFirewallShaperTrafficshaper;
import com.pulumi.fortimanager.ObjectFirewallShaperTrafficshaperArgs;
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 ObjectFirewallShaperTrafficshaper("trname", ObjectFirewallShaperTrafficshaperArgs.builder()
            .bandwidthUnit("mbps")
            .diffserv("disable")
            .perPolicy("disable")
            .priority("medium")
            .build());

    }
}

    resources:
  trname:
    type: fortimanager:ObjectFirewallShaperTrafficshaper
    properties:
      bandwidthUnit: mbps
      diffserv: disable
      perPolicy: disable
      priority: medium

    Create ObjectFirewallShaperTrafficshaper Resource

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

    Constructor syntax

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

@overload
def ObjectFirewallShaperTrafficshaper(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      adom: Optional[str] = None,
                                      bandwidth_unit: Optional[str] = None,
                                      cos: Optional[str] = None,
                                      cos_marking: Optional[str] = None,
                                      cos_marking_method: Optional[str] = None,
                                      diffserv: Optional[str] = None,
                                      diffservcode: Optional[str] = None,
                                      dscp_marking_method: Optional[str] = None,
                                      exceed_bandwidth: Optional[float] = None,
                                      exceed_class_id: Optional[str] = None,
                                      exceed_cos: Optional[str] = None,
                                      exceed_dscp: Optional[str] = None,
                                      guaranteed_bandwidth: Optional[float] = None,
                                      maximum_bandwidth: Optional[float] = None,
                                      maximum_cos: Optional[str] = None,
                                      maximum_dscp: Optional[str] = None,
                                      name: Optional[str] = None,
                                      object_firewall_shaper_trafficshaper_id: Optional[str] = None,
                                      overhead: Optional[float] = None,
                                      per_policy: Optional[str] = None,
                                      priority: Optional[str] = None,
                                      scopetype: Optional[str] = None)
    func NewObjectFirewallShaperTrafficshaper(ctx *Context, name string, args *ObjectFirewallShaperTrafficshaperArgs, opts ...ResourceOption) (*ObjectFirewallShaperTrafficshaper, error)
    public ObjectFirewallShaperTrafficshaper(string name, ObjectFirewallShaperTrafficshaperArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectFirewallShaperTrafficshaper(String name, ObjectFirewallShaperTrafficshaperArgs args)
public ObjectFirewallShaperTrafficshaper(String name, ObjectFirewallShaperTrafficshaperArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectFirewallShaperTrafficshaper
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 ObjectFirewallShaperTrafficshaperArgs
    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 ObjectFirewallShaperTrafficshaperArgs
    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 ObjectFirewallShaperTrafficshaperArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectFirewallShaperTrafficshaperArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectFirewallShaperTrafficshaperArgs
    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 objectFirewallShaperTrafficshaperResource = new Fortimanager.ObjectFirewallShaperTrafficshaper("objectFirewallShaperTrafficshaperResource", new()
{
    Adom = "string",
    BandwidthUnit = "string",
    Cos = "string",
    CosMarking = "string",
    CosMarkingMethod = "string",
    Diffserv = "string",
    Diffservcode = "string",
    DscpMarkingMethod = "string",
    ExceedBandwidth = 0,
    ExceedClassId = "string",
    ExceedCos = "string",
    ExceedDscp = "string",
    GuaranteedBandwidth = 0,
    MaximumBandwidth = 0,
    MaximumCos = "string",
    MaximumDscp = "string",
    Name = "string",
    ObjectFirewallShaperTrafficshaperId = "string",
    Overhead = 0,
    PerPolicy = "string",
    Priority = "string",
    Scopetype = "string",
});

    example, err := fortimanager.NewObjectFirewallShaperTrafficshaper(ctx, "objectFirewallShaperTrafficshaperResource", &fortimanager.ObjectFirewallShaperTrafficshaperArgs{
Adom: pulumi.String("string"),
BandwidthUnit: pulumi.String("string"),
Cos: pulumi.String("string"),
CosMarking: pulumi.String("string"),
CosMarkingMethod: pulumi.String("string"),
Diffserv: pulumi.String("string"),
Diffservcode: pulumi.String("string"),
DscpMarkingMethod: pulumi.String("string"),
ExceedBandwidth: pulumi.Float64(0),
ExceedClassId: pulumi.String("string"),
ExceedCos: pulumi.String("string"),
ExceedDscp: pulumi.String("string"),
GuaranteedBandwidth: pulumi.Float64(0),
MaximumBandwidth: pulumi.Float64(0),
MaximumCos: pulumi.String("string"),
MaximumDscp: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectFirewallShaperTrafficshaperId: pulumi.String("string"),
Overhead: pulumi.Float64(0),
PerPolicy: pulumi.String("string"),
Priority: pulumi.String("string"),
Scopetype: pulumi.String("string"),
})

    var objectFirewallShaperTrafficshaperResource = new ObjectFirewallShaperTrafficshaper("objectFirewallShaperTrafficshaperResource", ObjectFirewallShaperTrafficshaperArgs.builder()
    .adom("string")
    .bandwidthUnit("string")
    .cos("string")
    .cosMarking("string")
    .cosMarkingMethod("string")
    .diffserv("string")
    .diffservcode("string")
    .dscpMarkingMethod("string")
    .exceedBandwidth(0)
    .exceedClassId("string")
    .exceedCos("string")
    .exceedDscp("string")
    .guaranteedBandwidth(0)
    .maximumBandwidth(0)
    .maximumCos("string")
    .maximumDscp("string")
    .name("string")
    .objectFirewallShaperTrafficshaperId("string")
    .overhead(0)
    .perPolicy("string")
    .priority("string")
    .scopetype("string")
    .build());

    object_firewall_shaper_trafficshaper_resource = fortimanager.ObjectFirewallShaperTrafficshaper("objectFirewallShaperTrafficshaperResource",
    adom="string",
    bandwidth_unit="string",
    cos="string",
    cos_marking="string",
    cos_marking_method="string",
    diffserv="string",
    diffservcode="string",
    dscp_marking_method="string",
    exceed_bandwidth=0,
    exceed_class_id="string",
    exceed_cos="string",
    exceed_dscp="string",
    guaranteed_bandwidth=0,
    maximum_bandwidth=0,
    maximum_cos="string",
    maximum_dscp="string",
    name="string",
    object_firewall_shaper_trafficshaper_id="string",
    overhead=0,
    per_policy="string",
    priority="string",
    scopetype="string")

    const objectFirewallShaperTrafficshaperResource = new fortimanager.ObjectFirewallShaperTrafficshaper("objectFirewallShaperTrafficshaperResource", {
    adom: "string",
    bandwidthUnit: "string",
    cos: "string",
    cosMarking: "string",
    cosMarkingMethod: "string",
    diffserv: "string",
    diffservcode: "string",
    dscpMarkingMethod: "string",
    exceedBandwidth: 0,
    exceedClassId: "string",
    exceedCos: "string",
    exceedDscp: "string",
    guaranteedBandwidth: 0,
    maximumBandwidth: 0,
    maximumCos: "string",
    maximumDscp: "string",
    name: "string",
    objectFirewallShaperTrafficshaperId: "string",
    overhead: 0,
    perPolicy: "string",
    priority: "string",
    scopetype: "string",
});

    type: fortimanager:ObjectFirewallShaperTrafficshaper
properties:
    adom: string
    bandwidthUnit: string
    cos: string
    cosMarking: string
    cosMarkingMethod: string
    diffserv: string
    diffservcode: string
    dscpMarkingMethod: string
    exceedBandwidth: 0
    exceedClassId: string
    exceedCos: string
    exceedDscp: string
    guaranteedBandwidth: 0
    maximumBandwidth: 0
    maximumCos: string
    maximumDscp: string
    name: string
    objectFirewallShaperTrafficshaperId: string
    overhead: 0
    perPolicy: string
    priority: string
    scopetype: string

    ObjectFirewallShaperTrafficshaper 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 ObjectFirewallShaperTrafficshaper 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.
    BandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    Cos string
    VLAN CoS mark.
    CosMarking string
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    CosMarkingMethod string
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    Diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    Diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    DscpMarkingMethod string
    Select DSCP marking method. Valid values: multi-stage, static.
    ExceedBandwidth double
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    ExceedClassId string
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    ExceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    ExceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    GuaranteedBandwidth double
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    MaximumBandwidth double
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    MaximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    MaximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    Name string
    Traffic shaper name.
    ObjectFirewallShaperTrafficshaperId string
    an identifier for the resource with format {{name}}.
    Overhead double
    Per-packet size overhead used in rate computations.
    PerPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    Priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    BandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    Cos string
    VLAN CoS mark.
    CosMarking string
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    CosMarkingMethod string
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    Diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    Diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    DscpMarkingMethod string
    Select DSCP marking method. Valid values: multi-stage, static.
    ExceedBandwidth float64
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    ExceedClassId string
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    ExceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    ExceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    GuaranteedBandwidth float64
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    MaximumBandwidth float64
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    MaximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    MaximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    Name string
    Traffic shaper name.
    ObjectFirewallShaperTrafficshaperId string
    an identifier for the resource with format {{name}}.
    Overhead float64
    Per-packet size overhead used in rate computations.
    PerPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    Priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    bandwidthUnit String
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    cos String
    VLAN CoS mark.
    cosMarking String
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    cosMarkingMethod String
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    diffserv String
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    diffservcode String
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod String
    Select DSCP marking method. Valid values: multi-stage, static.
    exceedBandwidth Double
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId String
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos String
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp String
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth Double
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    maximumBandwidth Double
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos String
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp String
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name String
    Traffic shaper name.
    objectFirewallShaperTrafficshaperId String
    an identifier for the resource with format {{name}}.
    overhead Double
    Per-packet size overhead used in rate computations.
    perPolicy String
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    priority String
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    bandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    cos string
    VLAN CoS mark.
    cosMarking string
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    cosMarkingMethod string
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod string
    Select DSCP marking method. Valid values: multi-stage, static.
    exceedBandwidth number
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId string
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth number
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    maximumBandwidth number
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name string
    Traffic shaper name.
    objectFirewallShaperTrafficshaperId string
    an identifier for the resource with format {{name}}.
    overhead number
    Per-packet size overhead used in rate computations.
    perPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    bandwidth_unit str
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    cos str
    VLAN CoS mark.
    cos_marking str
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    cos_marking_method str
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    diffserv str
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    diffservcode str
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscp_marking_method str
    Select DSCP marking method. Valid values: multi-stage, static.
    exceed_bandwidth float
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceed_class_id str
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceed_cos str
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceed_dscp str
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteed_bandwidth float
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    maximum_bandwidth float
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximum_cos str
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximum_dscp str
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name str
    Traffic shaper name.
    object_firewall_shaper_trafficshaper_id str
    an identifier for the resource with format {{name}}.
    overhead float
    Per-packet size overhead used in rate computations.
    per_policy str
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    priority str
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    bandwidthUnit String
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    cos String
    VLAN CoS mark.
    cosMarking String
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    cosMarkingMethod String
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    diffserv String
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    diffservcode String
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod String
    Select DSCP marking method. Valid values: multi-stage, static.
    exceedBandwidth Number
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId String
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos String
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp String
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth Number
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    maximumBandwidth Number
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos String
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp String
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name String
    Traffic shaper name.
    objectFirewallShaperTrafficshaperId String
    an identifier for the resource with format {{name}}.
    overhead Number
    Per-packet size overhead used in rate computations.
    perPolicy String
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    priority String
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.

    Outputs

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

    Get an existing ObjectFirewallShaperTrafficshaper 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?: ObjectFirewallShaperTrafficshaperState, opts?: CustomResourceOptions): ObjectFirewallShaperTrafficshaper
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        bandwidth_unit: Optional[str] = None,
        cos: Optional[str] = None,
        cos_marking: Optional[str] = None,
        cos_marking_method: Optional[str] = None,
        diffserv: Optional[str] = None,
        diffservcode: Optional[str] = None,
        dscp_marking_method: Optional[str] = None,
        exceed_bandwidth: Optional[float] = None,
        exceed_class_id: Optional[str] = None,
        exceed_cos: Optional[str] = None,
        exceed_dscp: Optional[str] = None,
        guaranteed_bandwidth: Optional[float] = None,
        maximum_bandwidth: Optional[float] = None,
        maximum_cos: Optional[str] = None,
        maximum_dscp: Optional[str] = None,
        name: Optional[str] = None,
        object_firewall_shaper_trafficshaper_id: Optional[str] = None,
        overhead: Optional[float] = None,
        per_policy: Optional[str] = None,
        priority: Optional[str] = None,
        scopetype: Optional[str] = None) -> ObjectFirewallShaperTrafficshaper
    func GetObjectFirewallShaperTrafficshaper(ctx *Context, name string, id IDInput, state *ObjectFirewallShaperTrafficshaperState, opts ...ResourceOption) (*ObjectFirewallShaperTrafficshaper, error)
    public static ObjectFirewallShaperTrafficshaper Get(string name, Input<string> id, ObjectFirewallShaperTrafficshaperState? state, CustomResourceOptions? opts = null)
    public static ObjectFirewallShaperTrafficshaper get(String name, Output<String> id, ObjectFirewallShaperTrafficshaperState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectFirewallShaperTrafficshaper    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.
    BandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    Cos string
    VLAN CoS mark.
    CosMarking string
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    CosMarkingMethod string
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    Diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    Diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    DscpMarkingMethod string
    Select DSCP marking method. Valid values: multi-stage, static.
    ExceedBandwidth double
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    ExceedClassId string
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    ExceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    ExceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    GuaranteedBandwidth double
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    MaximumBandwidth double
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    MaximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    MaximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    Name string
    Traffic shaper name.
    ObjectFirewallShaperTrafficshaperId string
    an identifier for the resource with format {{name}}.
    Overhead double
    Per-packet size overhead used in rate computations.
    PerPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    Priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    BandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    Cos string
    VLAN CoS mark.
    CosMarking string
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    CosMarkingMethod string
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    Diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    Diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    DscpMarkingMethod string
    Select DSCP marking method. Valid values: multi-stage, static.
    ExceedBandwidth float64
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    ExceedClassId string
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    ExceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    ExceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    GuaranteedBandwidth float64
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    MaximumBandwidth float64
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    MaximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    MaximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    Name string
    Traffic shaper name.
    ObjectFirewallShaperTrafficshaperId string
    an identifier for the resource with format {{name}}.
    Overhead float64
    Per-packet size overhead used in rate computations.
    PerPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    Priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    bandwidthUnit String
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    cos String
    VLAN CoS mark.
    cosMarking String
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    cosMarkingMethod String
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    diffserv String
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    diffservcode String
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod String
    Select DSCP marking method. Valid values: multi-stage, static.
    exceedBandwidth Double
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId String
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos String
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp String
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth Double
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    maximumBandwidth Double
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos String
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp String
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name String
    Traffic shaper name.
    objectFirewallShaperTrafficshaperId String
    an identifier for the resource with format {{name}}.
    overhead Double
    Per-packet size overhead used in rate computations.
    perPolicy String
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    priority String
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    bandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    cos string
    VLAN CoS mark.
    cosMarking string
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    cosMarkingMethod string
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod string
    Select DSCP marking method. Valid values: multi-stage, static.
    exceedBandwidth number
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId string
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth number
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    maximumBandwidth number
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name string
    Traffic shaper name.
    objectFirewallShaperTrafficshaperId string
    an identifier for the resource with format {{name}}.
    overhead number
    Per-packet size overhead used in rate computations.
    perPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    bandwidth_unit str
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    cos str
    VLAN CoS mark.
    cos_marking str
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    cos_marking_method str
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    diffserv str
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    diffservcode str
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscp_marking_method str
    Select DSCP marking method. Valid values: multi-stage, static.
    exceed_bandwidth float
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceed_class_id str
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceed_cos str
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceed_dscp str
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteed_bandwidth float
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    maximum_bandwidth float
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximum_cos str
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximum_dscp str
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name str
    Traffic shaper name.
    object_firewall_shaper_trafficshaper_id str
    an identifier for the resource with format {{name}}.
    overhead float
    Per-packet size overhead used in rate computations.
    per_policy str
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    priority str
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    bandwidthUnit String
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
    cos String
    VLAN CoS mark.
    cosMarking String
    Enable/disable VLAN CoS marking. Valid values: disable, enable.
    cosMarkingMethod String
    Select VLAN CoS marking method. Valid values: multi-stage, static.
    diffserv String
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: disable, enable.
    diffservcode String
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod String
    Select DSCP marking method. Valid values: multi-stage, static.
    exceedBandwidth Number
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId String
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos String
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp String
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth Number
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    maximumBandwidth Number
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos String
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp String
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name String
    Traffic shaper name.
    objectFirewallShaperTrafficshaperId String
    an identifier for the resource with format {{name}}.
    overhead Number
    Per-packet size overhead used in rate computations.
    perPolicy String
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
    priority String
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: high, medium, low.
    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.

    Import

    ObjectFirewall ShaperTrafficShaper can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectFirewallShaperTrafficshaper:ObjectFirewallShaperTrafficshaper 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