Class NodeActions


  • public class NodeActions
    extends com.pulumi.resources.CustomResource
    This resource allows you to invoke actions on a specific node. Only available for dedicated subscription plans. ## Example Usage <details> <summary> <b> <i>Already know the node identifier (e.g. from state file)</i> </b> </summary> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.cloudamqp.NodeActions; import com.pulumi.cloudamqp.NodeActionsArgs; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var nodeAction = new NodeActions("nodeAction", NodeActionsArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .nodeName("<node name>") .action("restart") .build()); } } ``` </details> Using data source `cloudamqp.getNodes` to restart RabbitMQ on all nodes.</br> ***Note: RabbitMQ restart on multiple nodes need to be chained, so one node restart at the time.*** <details> <summary> <b> <i>Multi node RabbitMQ restart</i> </b> </summary> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.cloudamqp.CloudamqpFunctions; import com.pulumi.cloudamqp.inputs.GetNodesArgs; import com.pulumi.cloudamqp.NodeActions; import com.pulumi.cloudamqp.NodeActionsArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { final var listNodes = CloudamqpFunctions.getNodes(GetNodesArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .build()); var restart01 = new NodeActions("restart01", NodeActionsArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .action("restart") .nodeName(listNodes.applyValue(getNodesResult -> getNodesResult.nodes()[0].name())) .build()); var restart02 = new NodeActions("restart02", NodeActionsArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .action("restart") .nodeName(listNodes.applyValue(getNodesResult -> getNodesResult.nodes()[1].name())) .build(), CustomResourceOptions.builder() .dependsOn(restart01) .build()); var restart03 = new NodeActions("restart03", NodeActionsArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .action("restart") .nodeName(listNodes.applyValue(getNodesResult -> getNodesResult.nodes()[2].name())) .build(), CustomResourceOptions.builder() .dependsOn( restart01, restart02) .build()); } } ``` </details> <details> <summary> <b> <i>Combine log level configuration change with multi node RabbitMQ restart</i> </b> </summary> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.cloudamqp.CloudamqpFunctions; import com.pulumi.cloudamqp.inputs.GetNodesArgs; import com.pulumi.cloudamqp.RabbitConfiguration; import com.pulumi.cloudamqp.RabbitConfigurationArgs; import com.pulumi.cloudamqp.NodeActions; import com.pulumi.cloudamqp.NodeActionsArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { final var listNodes = CloudamqpFunctions.getNodes(GetNodesArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .build()); var rabbitmqConfig = new RabbitConfiguration("rabbitmqConfig", RabbitConfigurationArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .logExchangeLevel("info") .build()); var restart01 = new NodeActions("restart01", NodeActionsArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .action("restart") .nodeName(listNodes.applyValue(getNodesResult -> getNodesResult.nodes()[0].name())) .build(), CustomResourceOptions.builder() .dependsOn(rabbitmqConfig) .build()); var restart02 = new NodeActions("restart02", NodeActionsArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .action("restart") .nodeName(listNodes.applyValue(getNodesResult -> getNodesResult.nodes()[1].name())) .build(), CustomResourceOptions.builder() .dependsOn( rabbitmqConfig, restart01) .build()); var restart03 = new NodeActions("restart03", NodeActionsArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .action("restart") .nodeName(listNodes.applyValue(getNodesResult -> getNodesResult.nodes()[2].name())) .build(), CustomResourceOptions.builder() .dependsOn( rabbitmqConfig, restart01, restart02) .build()); } } ``` </details> ## Action reference Valid options for action. | Action | Info | |--------------|------------------------------------| | start | Start RabbitMQ | | stop | Stop RabbitMQ | | restart | Restart RabbitMQ | | reboot | Reboot the node | | mgmt.restart | Restart the RabbitMQ mgmt interace | ## Dependency This resource depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id` and node name. ## Import This resource cannot be imported.
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> action()  
      static NodeActions get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, NodeActionsState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.Integer> instanceId()  
      com.pulumi.core.Output<java.lang.String> nodeName()  
      com.pulumi.core.Output<java.lang.Boolean> running()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • NodeActions

        public NodeActions​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • NodeActions

        public NodeActions​(java.lang.String name,
                           NodeActionsArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • NodeActions

        public NodeActions​(java.lang.String name,
                           NodeActionsArgs args,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • action

        public com.pulumi.core.Output<java.lang.String> action()
        Returns:
        The action to invoke on the node.
      • instanceId

        public com.pulumi.core.Output<java.lang.Integer> instanceId()
        Returns:
        The CloudAMQP instance ID.
      • nodeName

        public com.pulumi.core.Output<java.lang.String> nodeName()
        Returns:
        The node name, e.g `green-guinea-pig-01`.
      • running

        public com.pulumi.core.Output<java.lang.Boolean> running()
        Returns:
        If the node is running.
      • get

        public static NodeActions get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      NodeActionsState state,
                                      @Nullable
                                      com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.