@pulumi/scm 0.4.2-alpha.1760375664 → 0.4.3

package/decryptionRule.d.ts

@@ -2,7 +2,7 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "./types/input";
 import * as outputs from "./types/output";
 /**
- * Retrieves a config item.
+ * DecryptionRule resource
  *
  * ## Example Usage
  *
@@ -10,7 +10,113 @@ import * as outputs from "./types/output";
  * import * as pulumi from "@pulumi/pulumi";
  * import * as scm from "@pulumi/scm";
  *
- * const example = new scm.DecryptionRule("example", {});
+ * // --- 1. TAG Resource ---
+ * const decryptionPositionTag = new scm.Tag("decryption_position_tag", {
+ *     name: "decryption-position-tag",
+ *     folder: "All",
+ *     color: "Purple",
+ * });
+ * // --- 2. ANCHOR DECRYPTION RULE (Used for relative positioning) ---
+ * const anchorDecryptionRule = new scm.DecryptionRule("anchor_decryption_rule", {
+ *     name: "anchor-decryption-rule",
+ *     description: "Base rule for testing 'before' and 'after' positioning.",
+ *     folder: "All",
+ *     position: "pre",
+ *     action: "decrypt",
+ *     froms: ["trust"],
+ *     tos: ["untrust"],
+ *     sources: ["any"],
+ *     destinations: ["any"],
+ *     services: ["service-https"],
+ *     categories: ["high-risk"],
+ *     sourceUsers: ["any"],
+ *     type: {
+ *         sslForwardProxy: {},
+ *     },
+ *     destinationHips: ["any"],
+ *     tags: [decryptionPositionTag.name],
+ *     logSuccess: true,
+ *     logFail: true,
+ *     disabled: false,
+ *     negateSource: false,
+ *     negateDestination: false,
+ * });
+ * // --- 3. ABSOLUTE POSITIONING Examples ("top" and "bottom") ---
+ * const ruleTopDecryptionRule = new scm.DecryptionRule("rule_top_decryption_rule", {
+ *     name: "top-absolute-decryption-rule",
+ *     description: "Placed at the very TOP of the Decryption rulebase.",
+ *     folder: "All",
+ *     position: "pre",
+ *     action: "no-decrypt",
+ *     relativePosition: "top",
+ *     froms: ["any"],
+ *     tos: ["any"],
+ *     sources: ["any"],
+ *     destinations: ["any"],
+ *     services: ["service-https"],
+ *     categories: ["high-risk"],
+ *     sourceUsers: ["any"],
+ *     type: {
+ *         sslForwardProxy: {},
+ *     },
+ * });
+ * const ruleBottomDecryptionRule = new scm.DecryptionRule("rule_bottom_decryption_rule", {
+ *     name: "bottom-absolute-decryption-rule",
+ *     description: "Placed at the very BOTTOM of the Decryption rulebase.",
+ *     folder: "All",
+ *     position: "pre",
+ *     action: "decrypt",
+ *     relativePosition: "bottom",
+ *     froms: ["any"],
+ *     tos: ["any"],
+ *     sources: ["any"],
+ *     destinations: ["any"],
+ *     services: ["service-https"],
+ *     categories: ["high-risk"],
+ *     sourceUsers: ["any"],
+ *     type: {
+ *         sslForwardProxy: {},
+ *     },
+ * });
+ * // --- 4. RELATIVE POSITIONING Examples ("before" and "after") ---
+ * const ruleBeforeAnchorDecryption = new scm.DecryptionRule("rule_before_anchor_decryption", {
+ *     name: "before-anchor-decryption-rule",
+ *     description: "Positioned immediately BEFORE the anchor-decryption-rule. Updating",
+ *     folder: "All",
+ *     position: "pre",
+ *     action: "decrypt",
+ *     relativePosition: "before",
+ *     targetRule: anchorDecryptionRule.id,
+ *     froms: ["trust"],
+ *     tos: ["untrust"],
+ *     sources: ["10.1.1.0/24"],
+ *     destinations: ["any"],
+ *     services: ["service-https"],
+ *     categories: ["high-risk"],
+ *     sourceUsers: ["any"],
+ *     type: {
+ *         sslForwardProxy: {},
+ *     },
+ * });
+ * const ruleAfterAnchorDecryption = new scm.DecryptionRule("rule_after_anchor_decryption", {
+ *     name: "after-anchor-decryption-rule_123",
+ *     description: "Positioned immediately AFTER the anchor-decryption-rule.",
+ *     folder: "All",
+ *     position: "pre",
+ *     action: "decrypt",
+ *     relativePosition: "after",
+ *     targetRule: anchorDecryptionRule.id,
+ *     froms: ["any"],
+ *     tos: ["untrust"],
+ *     sources: ["any"],
+ *     destinations: ["192.168.1.10"],
+ *     services: ["service-https"],
+ *     categories: ["any"],
+ *     sourceUsers: ["any"],
+ *     type: {
+ *         sslForwardProxy: {},
+ *     },
+ * });
  * ```
  */
 export declare class DecryptionRule extends pulumi.CustomResource {
@@ -30,104 +136,112 @@ export declare class DecryptionRule extends pulumi.CustomResource {
      */
     static isInstance(obj: any): obj is DecryptionRule;
     /**
-     * The Action param. String must be one of these: `"decrypt"`, `"no-decrypt"`.
+     * The action to be taken
      */
     readonly action: pulumi.Output<string>;
     /**
-     * The Categories param.
+     * The destination URL category
      */
     readonly categories: pulumi.Output<string[]>;
     /**
-     * The Description param.
+     * The description of the decryption rule
      */
     readonly description: pulumi.Output<string | undefined>;
     /**
-     * The DestinationHips param.
+     * The Host Integrity Profile of the destination host
      */
     readonly destinationHips: pulumi.Output<string[] | undefined>;
     /**
-     * The Destinations param.
+     * The destination addresses
      */
     readonly destinations: pulumi.Output<string[]>;
     /**
-     * The Device param.
+     * The device in which the resource is defined
      */
     readonly device: pulumi.Output<string | undefined>;
     /**
-     * The Disabled param.
+     * Is the rule disabled?
      */
     readonly disabled: pulumi.Output<boolean | undefined>;
     /**
-     * The Folder param.
+     * The folder in which the resource is defined
      */
     readonly folder: pulumi.Output<string | undefined>;
     /**
-     * The Froms param.
+     * The source security zone
      */
     readonly froms: pulumi.Output<string[]>;
     /**
-     * The LogFail param.
+     * Log failed decryption events?
      */
     readonly logFail: pulumi.Output<boolean | undefined>;
     /**
-     * The LogSetting param.
+     * The log settings of the decryption rule
      */
     readonly logSetting: pulumi.Output<string | undefined>;
     /**
-     * The LogSuccess param.
+     * Log successful decryption events?
      */
     readonly logSuccess: pulumi.Output<boolean | undefined>;
     /**
-     * The Name param.
+     * The name of the decryption rule
      */
     readonly name: pulumi.Output<string>;
     /**
-     * The NegateDestination param.
+     * Negate the destination addresses?
      */
     readonly negateDestination: pulumi.Output<boolean | undefined>;
     /**
-     * The NegateSource param.
+     * Negate the source addresses?
      */
     readonly negateSource: pulumi.Output<boolean | undefined>;
     /**
-     * The Position param. String must be one of these: `"pre"`, `"post"`. Default: `"pre"`.
+     * The position of a security rule
      */
     readonly position: pulumi.Output<string>;
     /**
-     * The Profile param.
+     * The decryption profile associated with the decryption rule
      */
     readonly profile: pulumi.Output<string | undefined>;
     /**
-     * The Services param.
+     * 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>;
+    /**
+     * The destination services and/or service groups
      */
     readonly services: pulumi.Output<string[]>;
     /**
-     * The Snippet param.
+     * The snippet in which the resource is defined
      */
     readonly snippet: pulumi.Output<string | undefined>;
     /**
-     * The SourceHips param.
+     * Source hip
      */
     readonly sourceHips: pulumi.Output<string[] | undefined>;
     /**
-     * The SourceUsers param.
+     * List of source users and/or groups.  Reserved words include `any`, `pre-login`, `known-user`, and `unknown`.
      */
     readonly sourceUsers: pulumi.Output<string[]>;
     /**
-     * The Sources param.
+     * The source addresses
      */
     readonly sources: pulumi.Output<string[]>;
     /**
-     * The Tags param.
+     * The tags associated with the decryption rule
      */
     readonly tags: 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>;
     /**
-     * The Tos param.
+     * The destination security zone
      */
     readonly tos: pulumi.Output<string[]>;
     /**
-     * The Type param.
+     * The type of decryption
      */
     readonly type: pulumi.Output<outputs.DecryptionRuleType | undefined>;
     /**
@@ -144,104 +258,112 @@ export declare class DecryptionRule extends pulumi.CustomResource {
  */
 export interface DecryptionRuleState {
     /**
-     * The Action param. String must be one of these: `"decrypt"`, `"no-decrypt"`.
+     * The action to be taken
      */
     action?: pulumi.Input<string>;
     /**
-     * The Categories param.
+     * The destination URL category
      */
     categories?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Description param.
+     * The description of the decryption rule
      */
     description?: pulumi.Input<string>;
     /**
-     * The DestinationHips param.
+     * The Host Integrity Profile of the destination host
      */
     destinationHips?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Destinations param.
+     * The destination addresses
      */
     destinations?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Device param.
+     * The device in which the resource is defined
      */
     device?: pulumi.Input<string>;
     /**
-     * The Disabled param.
+     * Is the rule disabled?
      */
     disabled?: pulumi.Input<boolean>;
     /**
-     * The Folder param.
+     * The folder in which the resource is defined
      */
     folder?: pulumi.Input<string>;
     /**
-     * The Froms param.
+     * The source security zone
      */
     froms?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The LogFail param.
+     * Log failed decryption events?
      */
     logFail?: pulumi.Input<boolean>;
     /**
-     * The LogSetting param.
+     * The log settings of the decryption rule
      */
     logSetting?: pulumi.Input<string>;
     /**
-     * The LogSuccess param.
+     * Log successful decryption events?
      */
     logSuccess?: pulumi.Input<boolean>;
     /**
-     * The Name param.
+     * The name of the decryption rule
      */
     name?: pulumi.Input<string>;
     /**
-     * The NegateDestination param.
+     * Negate the destination addresses?
      */
     negateDestination?: pulumi.Input<boolean>;
     /**
-     * The NegateSource param.
+     * Negate the source addresses?
      */
     negateSource?: pulumi.Input<boolean>;
     /**
-     * The Position param. String must be one of these: `"pre"`, `"post"`. Default: `"pre"`.
+     * The position of a security rule
      */
     position?: pulumi.Input<string>;
     /**
-     * The Profile param.
+     * The decryption profile associated with the decryption rule
      */
     profile?: pulumi.Input<string>;
     /**
-     * The Services param.
+     * 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>;
+    /**
+     * The destination services and/or service groups
      */
     services?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Snippet param.
+     * The snippet in which the resource is defined
      */
     snippet?: pulumi.Input<string>;
     /**
-     * The SourceHips param.
+     * Source hip
      */
     sourceHips?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The SourceUsers param.
+     * List of source users and/or groups.  Reserved words include `any`, `pre-login`, `known-user`, and `unknown`.
      */
     sourceUsers?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Sources param.
+     * The source addresses
      */
     sources?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Tags param.
+     * The tags associated with the decryption rule
      */
     tags?: pulumi.Input<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 Tos param.
+     * The destination security zone
      */
     tos?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Type param.
+     * The type of decryption
      */
     type?: pulumi.Input<inputs.DecryptionRuleType>;
 }
@@ -250,103 +372,111 @@ export interface DecryptionRuleState {
  */
 export interface DecryptionRuleArgs {
     /**
-     * The Action param. String must be one of these: `"decrypt"`, `"no-decrypt"`.
+     * The action to be taken
      */
     action: pulumi.Input<string>;
     /**
-     * The Categories param.
+     * The destination URL category
      */
     categories: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Description param.
+     * The description of the decryption rule
      */
     description?: pulumi.Input<string>;
     /**
-     * The DestinationHips param.
+     * The Host Integrity Profile of the destination host
      */
     destinationHips?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Destinations param.
+     * The destination addresses
      */
     destinations: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Device param.
+     * The device in which the resource is defined
      */
     device?: pulumi.Input<string>;
     /**
-     * The Disabled param.
+     * Is the rule disabled?
      */
     disabled?: pulumi.Input<boolean>;
     /**
-     * The Folder param.
+     * The folder in which the resource is defined
      */
     folder?: pulumi.Input<string>;
     /**
-     * The Froms param.
+     * The source security zone
      */
     froms: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The LogFail param.
+     * Log failed decryption events?
      */
     logFail?: pulumi.Input<boolean>;
     /**
-     * The LogSetting param.
+     * The log settings of the decryption rule
      */
     logSetting?: pulumi.Input<string>;
     /**
-     * The LogSuccess param.
+     * Log successful decryption events?
      */
     logSuccess?: pulumi.Input<boolean>;
     /**
-     * The Name param.
+     * The name of the decryption rule
      */
     name?: pulumi.Input<string>;
     /**
-     * The NegateDestination param.
+     * Negate the destination addresses?
      */
     negateDestination?: pulumi.Input<boolean>;
     /**
-     * The NegateSource param.
+     * Negate the source addresses?
      */
     negateSource?: pulumi.Input<boolean>;
     /**
-     * The Position param. String must be one of these: `"pre"`, `"post"`. Default: `"pre"`.
+     * The position of a security rule
      */
     position?: pulumi.Input<string>;
     /**
-     * The Profile param.
+     * The decryption profile associated with the decryption rule
      */
     profile?: pulumi.Input<string>;
     /**
-     * The Services param.
+     * 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>;
+    /**
+     * The destination services and/or service groups
      */
     services: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Snippet param.
+     * The snippet in which the resource is defined
      */
     snippet?: pulumi.Input<string>;
     /**
-     * The SourceHips param.
+     * Source hip
      */
     sourceHips?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The SourceUsers param.
+     * List of source users and/or groups.  Reserved words include `any`, `pre-login`, `known-user`, and `unknown`.
      */
     sourceUsers: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Sources param.
+     * The source addresses
      */
     sources: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Tags param.
+     * The tags associated with the decryption rule
      */
     tags?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Tos param.
+     * The name or UUID of the rule to position this rule relative to. Required when `relativePosition` is `"before"` or `"after"`.
+     */
+    targetRule?: pulumi.Input<string>;
+    /**
+     * The destination security zone
      */
     tos: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The Type param.
+     * The type of decryption
      */
     type?: pulumi.Input<inputs.DecryptionRuleType>;
 }