@pulumi/scm

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * QosPolicyRule resource * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scm from "@pulumi/scm"; * * // --- 2. ANCHOR QOS POLICY RULE (Used for relative positioning) --- * const anchorQosRule = new scm.QosPolicyRule("anchor_qos_rule", { * name: "anchor-qos-rule", * description: "Base rule for testing 'before' and 'after' positioning.", * folder: "All", * position: "pre", * action: { * "class": "2", * }, * schedule: "non-work-hours", * dscpTos: { * codepoints: [{ * name: "Set-EF", * type: { * ef: {}, * }, * }], * }, * }); * // --- 3. ABSOLUTE POSITIONING Examples ("top" and "bottom") --- * const ruleTopQosRule = new scm.QosPolicyRule("rule_top_qos_rule", { * name: "top-absolute-qos-rule", * description: "Placed at the very TOP of the QoS rulebase (Highest Priority).", * folder: "All", * position: "pre", * relativePosition: "top", * action: { * "class": "2", * }, * }); * const ruleBottomQosRule = new scm.QosPolicyRule("rule_bottom_qos_rule", { * name: "bottom-absolute-qos-rule", * description: "Placed at the very BOTTOM of the QoS rulebase (Lowest Priority)", * folder: "All", * position: "pre", * relativePosition: "bottom", * action: { * "class": "3", * }, * }); * // --- 4. RELATIVE POSITIONING Examples ("before" and "after") --- * const ruleBeforeAnchorQos = new scm.QosPolicyRule("rule_before_anchor_qos", { * name: "before-anchor-qos-rule", * description: "Positioned immediately BEFORE the anchor-qos-rule.", * folder: "All", * position: "pre", * relativePosition: "before", * targetRule: anchorQosRule.id, * action: { * "class": "5", * }, * }); * const ruleAfterAnchorQos = new scm.QosPolicyRule("rule_after_anchor_qos", { * name: "after-anchor-qos-rule", * description: "Positioned immediately AFTER the anchor-qos-rule.", * folder: "All", * position: "pre", * relativePosition: "after", * targetRule: anchorQosRule.id, * action: { * "class": "4", * }, * }); * ``` */ export declare class QosPolicyRule extends pulumi.CustomResource { /** * Get an existing QosPolicyRule 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?: QosPolicyRuleState, opts?: pulumi.CustomResourceOptions): QosPolicyRule; /** * Returns true if the given object is an instance of QosPolicyRule. 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 QosPolicyRule; /** * Action */ readonly action: pulumi.Output<outputs.QosPolicyRuleAction>; /** * Description */ readonly description: pulumi.Output<string | undefined>; /** * The device in which the resource is defined */ readonly device: pulumi.Output<string | undefined>; /** * Dscp tos */ readonly dscpTos: pulumi.Output<outputs.QosPolicyRuleDscpTos | undefined>; /** * The folder in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ readonly folder: pulumi.Output<string | undefined>; /** * Name */ readonly name: pulumi.Output<string>; /** * The relative position of the rule */ readonly position: pulumi.Output<string>; /** * Relative positioning rule. String must be one of these: `"before"`, `"after"`, `"top"`, `"bottom"`. If not specified, rule is created at the bottom of the ruleset. */ readonly relativePosition: pulumi.Output<string | undefined>; /** * Schedule */ readonly schedule: pulumi.Output<string | undefined>; /** * The snippet in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ readonly snippet: pulumi.Output<string | undefined>; /** * The name or UUID of the rule to position this rule relative to. Required when `relativePosition` is `"before"` or `"after"`. */ readonly targetRule: pulumi.Output<string | undefined>; readonly tfid: pulumi.Output<string>; /** * Create a QosPolicyRule 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: QosPolicyRuleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering QosPolicyRule resources. */ export interface QosPolicyRuleState { /** * Action */ action?: pulumi.Input<inputs.QosPolicyRuleAction>; /** * Description */ description?: pulumi.Input<string>; /** * The device in which the resource is defined */ device?: pulumi.Input<string>; /** * Dscp tos */ dscpTos?: pulumi.Input<inputs.QosPolicyRuleDscpTos>; /** * The folder in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ folder?: pulumi.Input<string>; /** * Name */ name?: pulumi.Input<string>; /** * The relative position of the rule */ position?: pulumi.Input<string>; /** * Relative positioning rule. String must be one of these: `"before"`, `"after"`, `"top"`, `"bottom"`. If not specified, rule is created at the bottom of the ruleset. */ relativePosition?: pulumi.Input<string>; /** * Schedule */ schedule?: pulumi.Input<string>; /** * The snippet in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ snippet?: pulumi.Input<string>; /** * The name or UUID of the rule to position this rule relative to. Required when `relativePosition` is `"before"` or `"after"`. */ targetRule?: pulumi.Input<string>; tfid?: pulumi.Input<string>; } /** * The set of arguments for constructing a QosPolicyRule resource. */ export interface QosPolicyRuleArgs { /** * Action */ action: pulumi.Input<inputs.QosPolicyRuleAction>; /** * Description */ description?: pulumi.Input<string>; /** * The device in which the resource is defined */ device?: pulumi.Input<string>; /** * Dscp tos */ dscpTos?: pulumi.Input<inputs.QosPolicyRuleDscpTos>; /** * The folder in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ folder?: pulumi.Input<string>; /** * Name */ name?: pulumi.Input<string>; /** * The relative position of the rule */ position?: pulumi.Input<string>; /** * Relative positioning rule. String must be one of these: `"before"`, `"after"`, `"top"`, `"bottom"`. If not specified, rule is created at the bottom of the ruleset. */ relativePosition?: pulumi.Input<string>; /** * Schedule */ schedule?: pulumi.Input<string>; /** * The snippet in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ snippet?: pulumi.Input<string>; /** * The name or UUID of the rule to position this rule relative to. Required when `relativePosition` is `"before"` or `"after"`. */ targetRule?: pulumi.Input<string>; }