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

fortios.firewall.Trafficclass

Explore with Pulumi AI

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

    Configure names for shaping classes. Applies to FortiOS Version >= 6.2.4.

    Create Trafficclass Resource

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

    Constructor syntax

    new Trafficclass(name: string, args: TrafficclassArgs, opts?: CustomResourceOptions);
    @overload
    def Trafficclass(resource_name: str,
                     args: TrafficclassArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def Trafficclass(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     class_id: Optional[int] = None,
                     class_name: Optional[str] = None,
                     vdomparam: Optional[str] = None)
    func NewTrafficclass(ctx *Context, name string, args TrafficclassArgs, opts ...ResourceOption) (*Trafficclass, error)
    public Trafficclass(string name, TrafficclassArgs args, CustomResourceOptions? opts = null)
    public Trafficclass(String name, TrafficclassArgs args)
    public Trafficclass(String name, TrafficclassArgs args, CustomResourceOptions options)
    
    type: fortios:firewall:Trafficclass
    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 TrafficclassArgs
    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 TrafficclassArgs
    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 TrafficclassArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficclassArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficclassArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var trafficclassResource = new Fortios.Firewall.Trafficclass("trafficclassResource", new()
    {
        ClassId = 0,
        ClassName = "string",
        Vdomparam = "string",
    });
    
    example, err := firewall.NewTrafficclass(ctx, "trafficclassResource", &firewall.TrafficclassArgs{
    	ClassId:   pulumi.Int(0),
    	ClassName: pulumi.String("string"),
    	Vdomparam: pulumi.String("string"),
    })
    
    var trafficclassResource = new Trafficclass("trafficclassResource", TrafficclassArgs.builder()
        .classId(0)
        .className("string")
        .vdomparam("string")
        .build());
    
    trafficclass_resource = fortios.firewall.Trafficclass("trafficclassResource",
        class_id=0,
        class_name="string",
        vdomparam="string")
    
    const trafficclassResource = new fortios.firewall.Trafficclass("trafficclassResource", {
        classId: 0,
        className: "string",
        vdomparam: "string",
    });
    
    type: fortios:firewall:Trafficclass
    properties:
        classId: 0
        className: string
        vdomparam: string
    

    Trafficclass Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Trafficclass resource accepts the following input properties:

    ClassId int
    Class ID to be named.
    ClassName string
    Define the name for this class-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.
    ClassId int
    Class ID to be named.
    ClassName string
    Define the name for this class-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.
    classId Integer
    Class ID to be named.
    className String
    Define the name for this class-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.
    classId number
    Class ID to be named.
    className string
    Define the name for this class-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.
    class_id int
    Class ID to be named.
    class_name str
    Define the name for this class-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.
    classId Number
    Class ID to be named.
    className String
    Define the name for this class-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.

    Outputs

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

    Get an existing Trafficclass 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?: TrafficclassState, opts?: CustomResourceOptions): Trafficclass
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            class_id: Optional[int] = None,
            class_name: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Trafficclass
    func GetTrafficclass(ctx *Context, name string, id IDInput, state *TrafficclassState, opts ...ResourceOption) (*Trafficclass, error)
    public static Trafficclass Get(string name, Input<string> id, TrafficclassState? state, CustomResourceOptions? opts = null)
    public static Trafficclass get(String name, Output<String> id, TrafficclassState 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:
    ClassId int
    Class ID to be named.
    ClassName string
    Define the name for this class-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.
    ClassId int
    Class ID to be named.
    ClassName string
    Define the name for this class-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.
    classId Integer
    Class ID to be named.
    className String
    Define the name for this class-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.
    classId number
    Class ID to be named.
    className string
    Define the name for this class-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.
    class_id int
    Class ID to be named.
    class_name str
    Define the name for this class-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.
    classId Number
    Class ID to be named.
    className String
    Define the name for this class-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.

    Import

    Firewall TrafficClass can be imported using any of these accepted formats:

    $ pulumi import fortios:firewall/trafficclass:Trafficclass labelname {{class_id}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:firewall/trafficclass:Trafficclass labelname {{class_id}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse