@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
175 lines (174 loc) • 8.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure shaping profiles.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.firewall.Shapingprofile("trname", {
* defaultClassId: 2,
* profileName: "shapingprofiles1",
* shapingEntries: [{
* classId: 2,
* guaranteedBandwidthPercentage: 33,
* id: 1,
* maximumBandwidthPercentage: 88,
* priority: "high",
* }],
* });
* ```
*
* ## Import
*
* Firewall ShapingProfile can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:firewall/shapingprofile:Shapingprofile labelname {{profile_name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:firewall/shapingprofile:Shapingprofile labelname {{profile_name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Shapingprofile extends pulumi.CustomResource {
/**
* Get an existing Shapingprofile resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ShapingprofileState, opts?: pulumi.CustomResourceOptions): Shapingprofile;
/**
* Returns true if the given object is an instance of Shapingprofile. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Shapingprofile;
/**
* Comment.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* Default class ID to handle unclassified packets (including all local traffic).
*/
readonly defaultClassId: pulumi.Output<number>;
/**
* Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* Shaping profile name.
*/
readonly profileName: pulumi.Output<string>;
/**
* Define shaping entries of this shaping profile. The structure of `shapingEntries` block is documented below.
*/
readonly shapingEntries: pulumi.Output<outputs.firewall.ShapingprofileShapingEntry[] | undefined>;
/**
* Select shaping profile type: policing / queuing. Valid values: `policing`, `queuing`.
*/
readonly type: pulumi.Output<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.
*/
readonly vdomparam: pulumi.Output<string>;
/**
* Create a Shapingprofile resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ShapingprofileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Shapingprofile resources.
*/
export interface ShapingprofileState {
/**
* Comment.
*/
comment?: pulumi.Input<string>;
/**
* Default class ID to handle unclassified packets (including all local traffic).
*/
defaultClassId?: pulumi.Input<number>;
/**
* Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
getAllTables?: pulumi.Input<string>;
/**
* Shaping profile name.
*/
profileName?: pulumi.Input<string>;
/**
* Define shaping entries of this shaping profile. The structure of `shapingEntries` block is documented below.
*/
shapingEntries?: pulumi.Input<pulumi.Input<inputs.firewall.ShapingprofileShapingEntry>[]>;
/**
* Select shaping profile type: policing / queuing. Valid values: `policing`, `queuing`.
*/
type?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Shapingprofile resource.
*/
export interface ShapingprofileArgs {
/**
* Comment.
*/
comment?: pulumi.Input<string>;
/**
* Default class ID to handle unclassified packets (including all local traffic).
*/
defaultClassId: pulumi.Input<number>;
/**
* Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
getAllTables?: pulumi.Input<string>;
/**
* Shaping profile name.
*/
profileName: pulumi.Input<string>;
/**
* Define shaping entries of this shaping profile. The structure of `shapingEntries` block is documented below.
*/
shapingEntries?: pulumi.Input<pulumi.Input<inputs.firewall.ShapingprofileShapingEntry>[]>;
/**
* Select shaping profile type: policing / queuing. Valid values: `policing`, `queuing`.
*/
type?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
}