@pulumi/confluentcloud 2.6.0-alpha.1729195304 → 2.6.0

package/types/output.d.ts

@@ -381,6 +381,12 @@ export interface EnvironmentStreamGovernance {
      */
     package: string;
 }
+export interface FlinkArtifactEnvironment {
+    /**
+     * The ID of the Environment that the Flink Artifact Pool belongs to, for example, `env-abc123`.
+     */
+    id: string;
+}
 export interface FlinkComputePoolEnvironment {
     /**
      * The ID of the Environment that the Flink Compute Pool belongs to, for example, `env-abc123`.
@@ -615,6 +621,12 @@ export interface GetEnvironmentStreamGovernance {
      */
     package: string;
 }
+export interface GetFlinkArtifactEnvironment {
+    /**
+     * The ID of the Environment that the Flink Artifact belongs to, for example, `env-xyz456`.
+     */
+    id: string;
+}
 export interface GetFlinkComputePoolEnvironment {
     /**
      * The ID of the Environment that the Flink Compute Pool belongs to, for example, `env-xyz456`.
@@ -1306,33 +1318,37 @@ export interface GetSchemaRuleset {
 }
 export interface GetSchemaRulesetDomainRule {
     /**
-     * (Optional String) An optional description.
+     * (Optional Boolean) The boolean flag to control whether the rule should be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * (Optional String) An optional description of the rule.
      */
-    doc: string;
+    doc?: string;
     /**
-     * (Optional String) The body of the rule, which is optional.
+     * (Optional String) The rule body. Data quality and transformation rules use `CEL` language expressions, data migration rules use `JSONata` expressions. Defaults to "".
      */
-    expr: string;
+    expr?: string;
     /**
-     * (Optional String) Either `CONDITION` or `TRANSFORM`.
+     * (Required String) The kind of the rule. Accepted values are `CONDITION` and `TRANSFORM`. `CONDITION` - validate the value of a field, `TRANSFORM` - transform the value of a field. Data quality rules use `CONDITION` kind, data transformation, encryption and migration rules use `TRANSFORM` kind.
      */
     kind: string;
     /**
-     * (Optional String) The mode of the rule.
+     * (Required String) The mode of the rule. Accepted values are `UPGRADE`, `DOWNGRADE`, `UPDOWN`, `WRITE`, `READ`, and `WRITEREAD`.
      */
     mode: string;
     /**
-     * (Optional String) A user-defined name that can be used to reference the rule.
+     * (Required String) A user-defined name that can be used to reference the rule.
      */
     name: string;
     /**
-     * (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
+     * (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type `ERROR` is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, as mentioned above.
      */
-    onFailure: string;
+    onFailure?: string;
     /**
-     * (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
+     * (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type `NONE` is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, such as "NONE,ERROR" for a `WRITEREAD` rule. In this case `NONE` applies to `WRITE` and `ERROR` applies to `READ`.
      */
-    onSuccess: string;
+    onSuccess?: string;
     /**
      * (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
      */
@@ -1344,39 +1360,43 @@ export interface GetSchemaRulesetDomainRule {
      */
     tags: string[];
     /**
-     * (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
+     * (Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (`CEL`) is used for data quality and transformation rules, Confluent `ENCRYPT` is used for data encryption rules, and `JSONata` is used for migration rules.
      */
     type: string;
 }
 export interface GetSchemaRulesetMigrationRule {
     /**
-     * (Optional String) An optional description.
+     * (Optional Boolean) The boolean flag to control whether the rule should be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * (Optional String) An optional description of the rule.
      */
-    doc: string;
+    doc?: string;
     /**
-     * (Optional String) The body of the rule, which is optional.
+     * (Optional String) The rule body. Data quality and transformation rules use `CEL` language expressions, data migration rules use `JSONata` expressions. Defaults to "".
      */
-    expr: string;
+    expr?: string;
     /**
-     * (Optional String) Either `CONDITION` or `TRANSFORM`.
+     * (Required String) The kind of the rule. Accepted values are `CONDITION` and `TRANSFORM`. `CONDITION` - validate the value of a field, `TRANSFORM` - transform the value of a field. Data quality rules use `CONDITION` kind, data transformation, encryption and migration rules use `TRANSFORM` kind.
      */
     kind: string;
     /**
-     * (Optional String) The mode of the rule.
+     * (Required String) The mode of the rule. Accepted values are `UPGRADE`, `DOWNGRADE`, `UPDOWN`, `WRITE`, `READ`, and `WRITEREAD`.
      */
     mode: string;
     /**
-     * (Optional String) A user-defined name that can be used to reference the rule.
+     * (Required String) A user-defined name that can be used to reference the rule.
      */
     name: string;
     /**
-     * (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
+     * (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type `ERROR` is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, as mentioned above.
      */
-    onFailure: string;
+    onFailure?: string;
     /**
-     * (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
+     * (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type `NONE` is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, such as "NONE,ERROR" for a `WRITEREAD` rule. In this case `NONE` applies to `WRITE` and `ERROR` applies to `READ`.
      */
-    onSuccess: string;
+    onSuccess?: string;
     /**
      * (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
      */
@@ -1388,13 +1408,13 @@ export interface GetSchemaRulesetMigrationRule {
      */
     tags: string[];
     /**
-     * (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
+     * (Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (`CEL`) is used for data quality and transformation rules, Confluent `ENCRYPT` is used for data encryption rules, and `JSONata` is used for migration rules.
      */
     type: string;
 }
 export interface GetSchemaSchemaReference {
     /**
-     * (Optional String) A user-defined name that can be used to reference the rule.
+     * (Required String) A user-defined name that can be used to reference the rule.
      */
     name: string;
     /**
@@ -2226,15 +2246,19 @@ export interface SchemaRuleset {
 }
 export interface SchemaRulesetDomainRule {
     /**
-     * An optional description of the rule.
+     * The boolean flag to control whether the rule should be disabled. Defaults to `false`.
+     */
+    disabled?: boolean;
+    /**
+     * An optional description of the rule. Defaults to "".
      */
-    doc: string;
+    doc?: string;
     /**
-     * The body of the rule, which is optional.
+     * The rule body. Data quality and transformation rules use `CEL` language expressions, data migration rules use `JSONata` expressions. Defaults to "".
      */
-    expr: string;
+    expr?: string;
     /**
-     * The kind of the rule. Accepted values are `CONDITION` and `TRANSFORM`.
+     * The kind of the rule. Accepted values are `CONDITION` and `TRANSFORM`. `CONDITION` - validate the value of a field, `TRANSFORM` - transform the value of a field. Data quality rules use `CONDITION` kind, data transformation, encryption and migration rules use `TRANSFORM` kind.
      */
     kind: string;
     /**
@@ -2246,20 +2270,17 @@ export interface SchemaRulesetDomainRule {
      */
     name: string;
     /**
-     * An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, as mentioned above.
+     * An optional action to execute if the rule fails, otherwise the built-in action type `ERROR` is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, as mentioned above. Defaults to `ERROR,ERROR`.
      */
-    onFailure: string;
+    onFailure?: string;
     /**
-     * An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, such as "NONE,ERROR" for a `WRITEREAD` rule. In this case `NONE` applies to `WRITE` and `ERROR` applies to `READ`.
+     * An optional action to execute if the rule succeeds, otherwise the built-in action type `NONE` is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, such as "NONE,ERROR" for a `WRITEREAD` rule. In this case `NONE` applies to `WRITE` and `ERROR` applies to `READ`. Defaults to `NONE,NONE`.
      */
-    onSuccess: string;
+    onSuccess?: string;
     /**
      * A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
      *
      * > **Note:** Schema rules (`ruleset`) are only available with the [Stream Governance Advanced package](https://docs.confluent.io/cloud/current/stream-governance/packages.html#packages).
-     *
-     * > **Note:** `ruleset` and `metadata` attributes are available in **Preview** for early adopters. Preview features are introduced to gather customer feedback. This feature should be used only for evaluation and non-production testing purposes or to provide feedback to Confluent, particularly as it becomes more widely available in follow-on editions.
-     * **Preview** features are intended for evaluation use in development and testing environments only, and not for production use. The warranty, SLA, and Support Services provisions of your agreement with Confluent do not apply to Preview features. Preview features are considered to be a Proof of Concept as defined in the Confluent Cloud Terms of Service. Confluent may discontinue providing preview releases of the Preview features at any time in Confluent’s sole discretion.
      */
     params: {
         [key: string]: string;
@@ -2269,21 +2290,25 @@ export interface SchemaRulesetDomainRule {
      */
     tags: string[];
     /**
-     * The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
+     * The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (`CEL`) is used for data quality and transformation rules, Confluent `ENCRYPT` is used for data encryption rules, and `JSONata` is used for migration rules.
      */
     type: string;
 }
 export interface SchemaRulesetMigrationRule {
     /**
-     * An optional description of the rule.
+     * The boolean flag to control whether the rule should be disabled. Defaults to `false`.
+     */
+    disabled?: boolean;
+    /**
+     * An optional description of the rule. Defaults to "".
      */
-    doc: string;
+    doc?: string;
     /**
-     * The body of the rule, which is optional.
+     * The rule body. Data quality and transformation rules use `CEL` language expressions, data migration rules use `JSONata` expressions. Defaults to "".
      */
-    expr: string;
+    expr?: string;
     /**
-     * The kind of the rule. Accepted values are `CONDITION` and `TRANSFORM`.
+     * The kind of the rule. Accepted values are `CONDITION` and `TRANSFORM`. `CONDITION` - validate the value of a field, `TRANSFORM` - transform the value of a field. Data quality rules use `CONDITION` kind, data transformation, encryption and migration rules use `TRANSFORM` kind.
      */
     kind: string;
     /**
@@ -2292,20 +2317,17 @@ export interface SchemaRulesetMigrationRule {
     mode: string;
     name: string;
     /**
-     * An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, as mentioned above.
+     * An optional action to execute if the rule fails, otherwise the built-in action type `ERROR` is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, as mentioned above. Defaults to `ERROR,ERROR`.
      */
-    onFailure: string;
+    onFailure?: string;
     /**
-     * An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, such as "NONE,ERROR" for a `WRITEREAD` rule. In this case `NONE` applies to `WRITE` and `ERROR` applies to `READ`.
+     * An optional action to execute if the rule succeeds, otherwise the built-in action type `NONE` is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, such as "NONE,ERROR" for a `WRITEREAD` rule. In this case `NONE` applies to `WRITE` and `ERROR` applies to `READ`. Defaults to `NONE,NONE`.
      */
-    onSuccess: string;
+    onSuccess?: string;
     /**
      * A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
      *
      * > **Note:** Schema rules (`ruleset`) are only available with the [Stream Governance Advanced package](https://docs.confluent.io/cloud/current/stream-governance/packages.html#packages).
-     *
-     * > **Note:** `ruleset` and `metadata` attributes are available in **Preview** for early adopters. Preview features are introduced to gather customer feedback. This feature should be used only for evaluation and non-production testing purposes or to provide feedback to Confluent, particularly as it becomes more widely available in follow-on editions.
-     * **Preview** features are intended for evaluation use in development and testing environments only, and not for production use. The warranty, SLA, and Support Services provisions of your agreement with Confluent do not apply to Preview features. Preview features are considered to be a Proof of Concept as defined in the Confluent Cloud Terms of Service. Confluent may discontinue providing preview releases of the Preview features at any time in Confluent’s sole discretion.
      */
     params: {
         [key: string]: string;
@@ -2315,7 +2337,7 @@ export interface SchemaRulesetMigrationRule {
      */
     tags: string[];
     /**
-     * The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
+     * The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (`CEL`) is used for data quality and transformation rules, Confluent `ENCRYPT` is used for data encryption rules, and `JSONata` is used for migration rules.
      */
     type: string;
 }