1. Packages
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. BigDataService
  6. BdsInstanceReplaceNodeAction
Viewing docs for Oracle Cloud Infrastructure v4.12.0
published on Thursday, May 21, 2026 by Pulumi
oci logo
Viewing docs for Oracle Cloud Infrastructure v4.12.0
published on Thursday, May 21, 2026 by Pulumi

    Invokes the Big Data Service replace node action for a cluster node.

    Use this action resource to replace a node identified by nodeHostName. You can optionally provide a specific node backup to restore from, a target shape for the replacement node, and either clusterAdminPassword or secretId for authentication.

    When nodeBackupId is omitted, the service uses the latest available node backup. If no suitable backup is available, or the original node is already in a failed or terminated state, the service attempts to recover from the last saved boot volume state.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBdsInstanceReplaceNodeAction = new oci.bigdataservice.BdsInstanceReplaceNodeAction("test_bds_instance_replace_node_action", {
        bdsInstanceId: bdsInstanceId,
        nodeHostName: nodeHostName,
        clusterAdminPassword: "T3JhY2xlVGVhbVVTQSExMjM=",
        nodeBackupId: nodeBackupId,
        shape: shape,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_bds_instance_replace_node_action = oci.bigdataservice.BdsInstanceReplaceNodeAction("test_bds_instance_replace_node_action",
        bds_instance_id=bds_instance_id,
        node_host_name=node_host_name,
        cluster_admin_password="T3JhY2xlVGVhbVVTQSExMjM=",
        node_backup_id=node_backup_id,
        shape=shape)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/bigdataservice"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := bigdataservice.NewBdsInstanceReplaceNodeAction(ctx, "test_bds_instance_replace_node_action", &bigdataservice.BdsInstanceReplaceNodeActionArgs{
    			BdsInstanceId:        pulumi.Any(bdsInstanceId),
    			NodeHostName:         pulumi.Any(nodeHostName),
    			ClusterAdminPassword: pulumi.String("T3JhY2xlVGVhbVVTQSExMjM="),
    			NodeBackupId:         pulumi.Any(nodeBackupId),
    			Shape:                pulumi.Any(shape),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testBdsInstanceReplaceNodeAction = new Oci.BigDataService.BdsInstanceReplaceNodeAction("test_bds_instance_replace_node_action", new()
        {
            BdsInstanceId = bdsInstanceId,
            NodeHostName = nodeHostName,
            ClusterAdminPassword = "T3JhY2xlVGVhbVVTQSExMjM=",
            NodeBackupId = nodeBackupId,
            Shape = shape,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.BigDataService.BdsInstanceReplaceNodeAction;
    import com.pulumi.oci.BigDataService.BdsInstanceReplaceNodeActionArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 testBdsInstanceReplaceNodeAction = new BdsInstanceReplaceNodeAction("testBdsInstanceReplaceNodeAction", BdsInstanceReplaceNodeActionArgs.builder()
                .bdsInstanceId(bdsInstanceId)
                .nodeHostName(nodeHostName)
                .clusterAdminPassword("T3JhY2xlVGVhbVVTQSExMjM=")
                .nodeBackupId(nodeBackupId)
                .shape(shape)
                .build());
    
        }
    }
    
    resources:
      testBdsInstanceReplaceNodeAction:
        type: oci:BigDataService:BdsInstanceReplaceNodeAction
        name: test_bds_instance_replace_node_action
        properties:
          bdsInstanceId: ${bdsInstanceId}
          nodeHostName: ${nodeHostName}
          clusterAdminPassword: T3JhY2xlVGVhbVVTQSExMjM=
          nodeBackupId: ${nodeBackupId}
          shape: ${shape}
    
    Example coming soon!
    

    Create BdsInstanceReplaceNodeAction Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BdsInstanceReplaceNodeAction(name: string, args: BdsInstanceReplaceNodeActionArgs, opts?: CustomResourceOptions);
    @overload
    def BdsInstanceReplaceNodeAction(resource_name: str,
                                     args: BdsInstanceReplaceNodeActionArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def BdsInstanceReplaceNodeAction(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     bds_instance_id: Optional[str] = None,
                                     node_host_name: Optional[str] = None,
                                     cluster_admin_password: Optional[str] = None,
                                     node_backup_id: Optional[str] = None,
                                     secret_id: Optional[str] = None,
                                     shape: Optional[str] = None)
    func NewBdsInstanceReplaceNodeAction(ctx *Context, name string, args BdsInstanceReplaceNodeActionArgs, opts ...ResourceOption) (*BdsInstanceReplaceNodeAction, error)
    public BdsInstanceReplaceNodeAction(string name, BdsInstanceReplaceNodeActionArgs args, CustomResourceOptions? opts = null)
    public BdsInstanceReplaceNodeAction(String name, BdsInstanceReplaceNodeActionArgs args)
    public BdsInstanceReplaceNodeAction(String name, BdsInstanceReplaceNodeActionArgs args, CustomResourceOptions options)
    
    type: oci:BigDataService:BdsInstanceReplaceNodeAction
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "oci_bigdataservice_bdsinstancereplacenodeaction" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args BdsInstanceReplaceNodeActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BdsInstanceReplaceNodeActionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BdsInstanceReplaceNodeActionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BdsInstanceReplaceNodeActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BdsInstanceReplaceNodeActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var bdsInstanceReplaceNodeActionResource = new Oci.BigDataService.BdsInstanceReplaceNodeAction("bdsInstanceReplaceNodeActionResource", new()
    {
        BdsInstanceId = "string",
        NodeHostName = "string",
        ClusterAdminPassword = "string",
        NodeBackupId = "string",
        SecretId = "string",
        Shape = "string",
    });
    
    example, err := bigdataservice.NewBdsInstanceReplaceNodeAction(ctx, "bdsInstanceReplaceNodeActionResource", &bigdataservice.BdsInstanceReplaceNodeActionArgs{
    	BdsInstanceId:        pulumi.String("string"),
    	NodeHostName:         pulumi.String("string"),
    	ClusterAdminPassword: pulumi.String("string"),
    	NodeBackupId:         pulumi.String("string"),
    	SecretId:             pulumi.String("string"),
    	Shape:                pulumi.String("string"),
    })
    
    resource "oci_bigdataservice_bdsinstancereplacenodeaction" "bdsInstanceReplaceNodeActionResource" {
      bds_instance_id        = "string"
      node_host_name         = "string"
      cluster_admin_password = "string"
      node_backup_id         = "string"
      secret_id              = "string"
      shape                  = "string"
    }
    
    var bdsInstanceReplaceNodeActionResource = new BdsInstanceReplaceNodeAction("bdsInstanceReplaceNodeActionResource", BdsInstanceReplaceNodeActionArgs.builder()
        .bdsInstanceId("string")
        .nodeHostName("string")
        .clusterAdminPassword("string")
        .nodeBackupId("string")
        .secretId("string")
        .shape("string")
        .build());
    
    bds_instance_replace_node_action_resource = oci.bigdataservice.BdsInstanceReplaceNodeAction("bdsInstanceReplaceNodeActionResource",
        bds_instance_id="string",
        node_host_name="string",
        cluster_admin_password="string",
        node_backup_id="string",
        secret_id="string",
        shape="string")
    
    const bdsInstanceReplaceNodeActionResource = new oci.bigdataservice.BdsInstanceReplaceNodeAction("bdsInstanceReplaceNodeActionResource", {
        bdsInstanceId: "string",
        nodeHostName: "string",
        clusterAdminPassword: "string",
        nodeBackupId: "string",
        secretId: "string",
        shape: "string",
    });
    
    type: oci:BigDataService:BdsInstanceReplaceNodeAction
    properties:
        bdsInstanceId: string
        clusterAdminPassword: string
        nodeBackupId: string
        nodeHostName: string
        secretId: string
        shape: string
    

    BdsInstanceReplaceNodeAction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BdsInstanceReplaceNodeAction resource accepts the following input properties:

    BdsInstanceId string
    The OCID of the Big Data Service cluster.
    NodeHostName string
    Host name of the node to replace.
    ClusterAdminPassword string
    Base64-encoded cluster admin password. Use this or secretId.
    NodeBackupId string
    The OCID of the node backup to use for replacement.
    SecretId string
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    Shape string

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    BdsInstanceId string
    The OCID of the Big Data Service cluster.
    NodeHostName string
    Host name of the node to replace.
    ClusterAdminPassword string
    Base64-encoded cluster admin password. Use this or secretId.
    NodeBackupId string
    The OCID of the node backup to use for replacement.
    SecretId string
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    Shape string

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bds_instance_id string
    The OCID of the Big Data Service cluster.
    node_host_name string
    Host name of the node to replace.
    cluster_admin_password string
    Base64-encoded cluster admin password. Use this or secretId.
    node_backup_id string
    The OCID of the node backup to use for replacement.
    secret_id string
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape string

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bdsInstanceId String
    The OCID of the Big Data Service cluster.
    nodeHostName String
    Host name of the node to replace.
    clusterAdminPassword String
    Base64-encoded cluster admin password. Use this or secretId.
    nodeBackupId String
    The OCID of the node backup to use for replacement.
    secretId String
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape String

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bdsInstanceId string
    The OCID of the Big Data Service cluster.
    nodeHostName string
    Host name of the node to replace.
    clusterAdminPassword string
    Base64-encoded cluster admin password. Use this or secretId.
    nodeBackupId string
    The OCID of the node backup to use for replacement.
    secretId string
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape string

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bds_instance_id str
    The OCID of the Big Data Service cluster.
    node_host_name str
    Host name of the node to replace.
    cluster_admin_password str
    Base64-encoded cluster admin password. Use this or secretId.
    node_backup_id str
    The OCID of the node backup to use for replacement.
    secret_id str
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape str

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bdsInstanceId String
    The OCID of the Big Data Service cluster.
    nodeHostName String
    Host name of the node to replace.
    clusterAdminPassword String
    Base64-encoded cluster admin password. Use this or secretId.
    nodeBackupId String
    The OCID of the node backup to use for replacement.
    secretId String
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape String

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BdsInstanceReplaceNodeAction resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BdsInstanceReplaceNodeAction Resource

    Get an existing BdsInstanceReplaceNodeAction resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BdsInstanceReplaceNodeActionState, opts?: CustomResourceOptions): BdsInstanceReplaceNodeAction
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bds_instance_id: Optional[str] = None,
            cluster_admin_password: Optional[str] = None,
            node_backup_id: Optional[str] = None,
            node_host_name: Optional[str] = None,
            secret_id: Optional[str] = None,
            shape: Optional[str] = None) -> BdsInstanceReplaceNodeAction
    func GetBdsInstanceReplaceNodeAction(ctx *Context, name string, id IDInput, state *BdsInstanceReplaceNodeActionState, opts ...ResourceOption) (*BdsInstanceReplaceNodeAction, error)
    public static BdsInstanceReplaceNodeAction Get(string name, Input<string> id, BdsInstanceReplaceNodeActionState? state, CustomResourceOptions? opts = null)
    public static BdsInstanceReplaceNodeAction get(String name, Output<String> id, BdsInstanceReplaceNodeActionState state, CustomResourceOptions options)
    resources:  _:    type: oci:BigDataService:BdsInstanceReplaceNodeAction    get:      id: ${id}
    import {
      to = oci_bigdataservice_bdsinstancereplacenodeaction.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BdsInstanceId string
    The OCID of the Big Data Service cluster.
    ClusterAdminPassword string
    Base64-encoded cluster admin password. Use this or secretId.
    NodeBackupId string
    The OCID of the node backup to use for replacement.
    NodeHostName string
    Host name of the node to replace.
    SecretId string
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    Shape string

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    BdsInstanceId string
    The OCID of the Big Data Service cluster.
    ClusterAdminPassword string
    Base64-encoded cluster admin password. Use this or secretId.
    NodeBackupId string
    The OCID of the node backup to use for replacement.
    NodeHostName string
    Host name of the node to replace.
    SecretId string
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    Shape string

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bds_instance_id string
    The OCID of the Big Data Service cluster.
    cluster_admin_password string
    Base64-encoded cluster admin password. Use this or secretId.
    node_backup_id string
    The OCID of the node backup to use for replacement.
    node_host_name string
    Host name of the node to replace.
    secret_id string
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape string

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bdsInstanceId String
    The OCID of the Big Data Service cluster.
    clusterAdminPassword String
    Base64-encoded cluster admin password. Use this or secretId.
    nodeBackupId String
    The OCID of the node backup to use for replacement.
    nodeHostName String
    Host name of the node to replace.
    secretId String
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape String

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bdsInstanceId string
    The OCID of the Big Data Service cluster.
    clusterAdminPassword string
    Base64-encoded cluster admin password. Use this or secretId.
    nodeBackupId string
    The OCID of the node backup to use for replacement.
    nodeHostName string
    Host name of the node to replace.
    secretId string
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape string

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bds_instance_id str
    The OCID of the Big Data Service cluster.
    cluster_admin_password str
    Base64-encoded cluster admin password. Use this or secretId.
    node_backup_id str
    The OCID of the node backup to use for replacement.
    node_host_name str
    Host name of the node to replace.
    secret_id str
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape str

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    bdsInstanceId String
    The OCID of the Big Data Service cluster.
    clusterAdminPassword String
    Base64-encoded cluster admin password. Use this or secretId.
    nodeBackupId String
    The OCID of the node backup to use for replacement.
    nodeHostName String
    Host name of the node to replace.
    secretId String
    The OCID of the secret that stores the cluster admin password. Use this or clusterAdminPassword.
    shape String

    The shape to use for the replacement node. If not specified, the existing node shape is used.

    IMPORTANT This is an action resource. Any change forces Terraform to create the action resource again and invoke the replace node workflow.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.12.0
    published on Thursday, May 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial