@pulumi/cloudamqp 3.25.0-alpha.1766554038 → 3.25.0

package/nodeActions.d.ts

@@ -1,27 +1,29 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * This resource allows you to invoke actions on a specific node.
+ * This resource allows you to invoke actions on specific nodes or the entire cluster. Actions can target individual nodes, multiple nodes, or all nodes in the cluster at once.
  *
  * Only available for dedicated subscription plans.
  *
+ * > **Note:** From version 1.41.0, this resource supports cluster-level actions (`cluster.start`, `cluster.stop`, `cluster.restart`) and the `nodeNames` list attribute for targeting multiple nodes. The `nodeName` attribute is deprecated in favor of `nodeNames`.
+ *
  * ## Example Usage
  *
  * <details>
  *   <summary>
  *     <b>
- *       <i>Already know the node identifier (e.g. from state file)</i>
+ *       <i>Cluster-wide broker restart (recommended for v1.41.0+)</i>
  *     </b>
  *   </summary>
  *
+ * Restart the broker on all nodes of the cluster at once. Making sure the broker is stopped and started in correct order. This is the simplest approach for cluster-wide operations.
+ *
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
  * import * as cloudamqp from "@pulumi/cloudamqp";
  *
- * // New recipient to receieve notifications
- * const nodeAction = new cloudamqp.NodeActions("node_action", {
+ * const clusterRestart = new cloudamqp.NodeActions("cluster_restart", {
  *     instanceId: instance.id,
- *     nodeName: "<node name>",
- *     action: "restart",
+ *     action: "cluster.restart",
  * });
  * ```
  *
@@ -30,42 +32,51 @@ import * as pulumi from "@pulumi/pulumi";
  * <details>
  *   <summary>
  *     <b>
- *       <i>Multi node RabbitMQ restart</i>
+ *       <i>Restart broker on specific nodes using node_names</i>
  *     </b>
  *   </summary>
  *
- * Using data source `cloudamqp.getNodes` to restart RabbitMQ on all nodes.
- *
- * > **Note:** RabbitMQ restart on multiple nodes need to be chained, let one node restart at the time.
+ * Target specific nodes using the `nodeNames` list attribute.
  *
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
  * import * as cloudamqp from "@pulumi/cloudamqp";
  *
- * const listNodes = cloudamqp.getNodes({
+ * const nodes = cloudamqp.getNodes({
  *     instanceId: instance.id,
  * });
- * const restart01 = new cloudamqp.NodeActions("restart_01", {
+ * const restartSubset = new cloudamqp.NodeActions("restart_subset", {
  *     instanceId: instance.id,
  *     action: "restart",
- *     nodeName: listNodes.then(listNodes => listNodes.nodes?.[0]?.name),
+ *     nodeNames: [
+ *         nodes.then(nodes => nodes.nodes?.[0]?.name),
+ *         nodes.then(nodes => nodes.nodes?.[1]?.name),
+ *     ],
  * });
- * const restart02 = new cloudamqp.NodeActions("restart_02", {
+ * ```
+ *
+ * </details>
+ *
+ * <details>
+ *   <summary>
+ *     <b>
+ *       <i>Reboot a single node</i>
+ *     </b>
+ *   </summary>
+ *
+ * Reboot the entire node (VM) rather than just the broker.
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as cloudamqp from "@pulumi/cloudamqp";
+ *
+ * const nodes = cloudamqp.getNodes({
  *     instanceId: instance.id,
- *     action: "restart",
- *     nodeName: listNodes.then(listNodes => listNodes.nodes?.[1]?.name),
- * }, {
- *     dependsOn: [restart01],
  * });
- * const restart03 = new cloudamqp.NodeActions("restart_03", {
+ * const rebootNode = new cloudamqp.NodeActions("reboot_node", {
  *     instanceId: instance.id,
- *     action: "restart",
- *     nodeName: listNodes.then(listNodes => listNodes.nodes?.[2]?.name),
- * }, {
- *     dependsOn: [
- *         restart01,
- *         restart02,
- *     ],
+ *     action: "reboot",
+ *     nodeNames: [nodes.then(nodes => nodes.nodes?.[0]?.name)],
  * });
  * ```
  *
@@ -74,37 +85,99 @@ import * as pulumi from "@pulumi/pulumi";
  * <details>
  *   <summary>
  *     <b>
- *       <i>Combine log level configuration change with multi node RabbitMQ restart</i>
+ *       <i>Restart RabbitMQ management interface</i>
  *     </b>
  *   </summary>
  *
+ * Only restart the management interface without affecting the broker.
+ *
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
  * import * as cloudamqp from "@pulumi/cloudamqp";
  *
- * const listNodes = cloudamqp.getNodes({
+ * const nodes = cloudamqp.getNodes({
+ *     instanceId: instance.id,
+ * });
+ * const mgmtRestart = new cloudamqp.NodeActions("mgmt_restart", {
  *     instanceId: instance.id,
+ *     action: "mgmt.restart",
+ *     nodeNames: [nodes.then(nodes => nodes.nodes?.[0]?.name)],
  * });
+ * ```
+ *
+ * </details>
+ *
+ * <details>
+ *   <summary>
+ *     <b>
+ *       <i>Combine with configuration changes</i>
+ *     </b>
+ *   </summary>
+ *
+ * Apply configuration changes and restart the cluster.
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as cloudamqp from "@pulumi/cloudamqp";
+ *
  * const rabbitmqConfig = new cloudamqp.RabbitConfiguration("rabbitmq_config", {
  *     instanceId: instance.id,
  *     logExchangeLevel: "info",
  * });
+ * const clusterRestart = new cloudamqp.NodeActions("cluster_restart", {
+ *     instanceId: instance.id,
+ *     action: "cluster.restart",
+ * }, {
+ *     dependsOn: [rabbitmqConfig],
+ * });
+ * ```
+ *
+ * </details>
+ *
+ * <details>
+ *   <summary>
+ *     <b>
+ *       <i>Legacy Usage (pre-1.41.0)</i>
+ *     </b>
+ *   </summary>
+ *
+ * These examples show the older approach using `nodeName` (singular) and chained restarts. While still supported, the cluster-level actions above are recommended for new configurations.
+ *
+ * **Single node restart:**
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as cloudamqp from "@pulumi/cloudamqp";
+ *
+ * const nodeAction = new cloudamqp.NodeActions("node_action", {
+ *     instanceId: instance.id,
+ *     nodeName: "<node name>",
+ *     action: "restart",
+ * });
+ * ```
+ *
+ * **Chained multi-node restart:**
+ *
+ * > **Note:** This approach restarts nodes sequentially to minimize cluster disruption. Consider using `cluster.restart` for simpler configuration.
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as cloudamqp from "@pulumi/cloudamqp";
+ *
+ * const listNodes = cloudamqp.getNodes({
+ *     instanceId: instance.id,
+ * });
  * const restart01 = new cloudamqp.NodeActions("restart_01", {
  *     instanceId: instance.id,
  *     action: "restart",
  *     nodeName: listNodes.then(listNodes => listNodes.nodes?.[0]?.name),
- * }, {
- *     dependsOn: [rabbitmqConfig],
  * });
  * const restart02 = new cloudamqp.NodeActions("restart_02", {
  *     instanceId: instance.id,
  *     action: "restart",
  *     nodeName: listNodes.then(listNodes => listNodes.nodes?.[1]?.name),
  * }, {
- *     dependsOn: [
- *         rabbitmqConfig,
- *         restart01,
- *     ],
+ *     dependsOn: [restart01],
  * });
  * const restart03 = new cloudamqp.NodeActions("restart_03", {
  *     instanceId: instance.id,
@@ -112,7 +185,6 @@ import * as pulumi from "@pulumi/pulumi";
  *     nodeName: listNodes.then(listNodes => listNodes.nodes?.[2]?.name),
  * }, {
  *     dependsOn: [
- *         rabbitmqConfig,
  *         restart01,
  *         restart02,
  *     ],
@@ -123,29 +195,49 @@ import * as pulumi from "@pulumi/pulumi";
  *
  * ## Action reference
  *
- * Valid actions for ***LavinMQ***.
+ * Actions are categorized by what they affect:
+ *
+ * ### Broker Actions
+ *
+ * These actions control the message broker software (RabbitMQ or LavinMQ) on the specified nodes.
+ *
+ * | Action  | Info                                      | Applies to        |
+ * |---------|-------------------------------------------|-------------------|
+ * | start   | Start the message broker                  | RabbitMQ, LavinMQ |
+ * | stop    | Stop the message broker                   | RabbitMQ, LavinMQ |
+ * | restart | Restart the message broker                | RabbitMQ, LavinMQ |
+ *
+ * ### Management Interface Actions
+ *
+ * These actions control the management interface without affecting the broker itself.
+ *
+ * | Action       | Info                                      | Applies to |
+ * |--------------|-------------------------------------------|------------|
+ * | mgmt.restart | Restart the RabbitMQ management interface | RabbitMQ   |
+ *
+ * ### Node Actions
  *
- * | Action       | Info                               |
- * |--------------|------------------------------------|
- * | start        | Start LavinMQ                      |
- * | stop         | Stop LavinMQ                       |
- * | restart      | Restart LavinMQ                    |
- * | reboot       | Reboot the node                    |
+ * These actions affect the entire node (VM), not just the broker software.
  *
- * Valid actions for ***RabbitMQ***.
+ * | Action | Info                                          | Applies to        |
+ * |--------|-----------------------------------------------|-------------------|
+ * | reboot | Reboot the entire node (VM)                   | RabbitMQ, LavinMQ |
  *
- * | Action       | Info                               |
- * |--------------|------------------------------------|
- * | start        | Start RabbitMQ                     |
- * | stop         | Stop RabbitMQ                      |
- * | restart      | Restart RabbitMQ                   |
- * | reboot       | Reboot the node                    |
- * | mgmt.restart | Restart the RabbitMQ mgmt interace |
+ * ### Cluster Actions
+ *
+ * > **Available from version 1.41.0**
+ *
+ * These actions operate on all nodes in the cluster simultaneously. The `nodeNames` attribute can be omitted for these actions.
+ *
+ * | Action          | Info                                            | Applies to        |
+ * |-----------------|-------------------------------------------------|-------------------|
+ * | cluster.start   | Start the message broker on all cluster nodes   | RabbitMQ, LavinMQ |
+ * | cluster.stop    | Stop the message broker on all cluster nodes    | RabbitMQ, LavinMQ |
+ * | cluster.restart | Restart the message broker on all cluster nodes | RabbitMQ, LavinMQ |
  *
  * ## Dependency
  *
- * This resource depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id` and node
- * name.
+ * This resource depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`. For non-cluster actions, it also requires either `nodeName` or `nodeNames` to specify which nodes to act upon. Cluster-level actions automatically apply to all nodes in the cluster.
  *
  * ## Import
  *
@@ -168,7 +260,7 @@ export declare class NodeActions extends pulumi.CustomResource {
      */
     static isInstance(obj: any): obj is NodeActions;
     /**
-     * The action to invoke on the node.
+     * The action to invoke. See Action reference below for valid values.
      */
     readonly action: pulumi.Output<string>;
     /**
@@ -176,13 +268,25 @@ export declare class NodeActions extends pulumi.CustomResource {
      */
     readonly instanceId: pulumi.Output<number>;
     /**
-     * The node name, e.g `green-guinea-pig-01`.
+     * The node name, e.g. `green-guinea-pig-01`. Use `nodeNames` instead. This attribute will be removed in a future version.
+     *
+     * @deprecated Use nodeNames instead. This attribute will be removed in a future version.
+     */
+    readonly nodeName: pulumi.Output<string | undefined>;
+    /**
+     * List of node names to perform the action on, e.g. `["green-guinea-pig-01", "green-guinea-pig-02"]`. For cluster-level actions (`cluster.start`, `cluster.stop`, `cluster.restart`), this can be omitted and the action will automatically apply to all nodes.
+     */
+    readonly nodeNames: pulumi.Output<string[] | undefined>;
+    /**
+     * Sleep interval in seconds between polling for node status. Default: `10`.
      */
-    readonly nodeName: pulumi.Output<string>;
+    readonly sleep: pulumi.Output<number>;
     /**
-     * If the node is running.
+     * Timeout in seconds for the action to complete. Default: `1800` (30 minutes).
+     *
+     * > **Note:** Either `nodeName` or `nodeNames` must be specified for non-cluster actions. Cluster actions (`cluster.start`, `cluster.stop`, `cluster.restart`) can omit both and will automatically target all nodes.
      */
-    readonly running: pulumi.Output<boolean>;
+    readonly timeout: pulumi.Output<number>;
     /**
      * Create a NodeActions resource with the given unique name, arguments, and options.
      *
@@ -197,7 +301,7 @@ export declare class NodeActions extends pulumi.CustomResource {
  */
 export interface NodeActionsState {
     /**
-     * The action to invoke on the node.
+     * The action to invoke. See Action reference below for valid values.
      */
     action?: pulumi.Input<string>;
     /**
@@ -205,20 +309,32 @@ export interface NodeActionsState {
      */
     instanceId?: pulumi.Input<number>;
     /**
-     * The node name, e.g `green-guinea-pig-01`.
+     * The node name, e.g. `green-guinea-pig-01`. Use `nodeNames` instead. This attribute will be removed in a future version.
+     *
+     * @deprecated Use nodeNames instead. This attribute will be removed in a future version.
      */
     nodeName?: pulumi.Input<string>;
     /**
-     * If the node is running.
+     * List of node names to perform the action on, e.g. `["green-guinea-pig-01", "green-guinea-pig-02"]`. For cluster-level actions (`cluster.start`, `cluster.stop`, `cluster.restart`), this can be omitted and the action will automatically apply to all nodes.
+     */
+    nodeNames?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Sleep interval in seconds between polling for node status. Default: `10`.
      */
-    running?: pulumi.Input<boolean>;
+    sleep?: pulumi.Input<number>;
+    /**
+     * Timeout in seconds for the action to complete. Default: `1800` (30 minutes).
+     *
+     * > **Note:** Either `nodeName` or `nodeNames` must be specified for non-cluster actions. Cluster actions (`cluster.start`, `cluster.stop`, `cluster.restart`) can omit both and will automatically target all nodes.
+     */
+    timeout?: pulumi.Input<number>;
 }
 /**
  * The set of arguments for constructing a NodeActions resource.
  */
 export interface NodeActionsArgs {
     /**
-     * The action to invoke on the node.
+     * The action to invoke. See Action reference below for valid values.
      */
     action: pulumi.Input<string>;
     /**
@@ -226,7 +342,23 @@ export interface NodeActionsArgs {
      */
     instanceId: pulumi.Input<number>;
     /**
-     * The node name, e.g `green-guinea-pig-01`.
+     * The node name, e.g. `green-guinea-pig-01`. Use `nodeNames` instead. This attribute will be removed in a future version.
+     *
+     * @deprecated Use nodeNames instead. This attribute will be removed in a future version.
+     */
+    nodeName?: pulumi.Input<string>;
+    /**
+     * List of node names to perform the action on, e.g. `["green-guinea-pig-01", "green-guinea-pig-02"]`. For cluster-level actions (`cluster.start`, `cluster.stop`, `cluster.restart`), this can be omitted and the action will automatically apply to all nodes.
+     */
+    nodeNames?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Sleep interval in seconds between polling for node status. Default: `10`.
+     */
+    sleep?: pulumi.Input<number>;
+    /**
+     * Timeout in seconds for the action to complete. Default: `1800` (30 minutes).
+     *
+     * > **Note:** Either `nodeName` or `nodeNames` must be specified for non-cluster actions. Cluster actions (`cluster.start`, `cluster.stop`, `cluster.restart`) can omit both and will automatically target all nodes.
      */
-    nodeName: pulumi.Input<string>;
+    timeout?: pulumi.Input<number>;
 }