Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. BackupRecoveryConnectorAgentRegistration
Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.BackupRecoveryConnectorAgentRegistration

Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Create Connector agent registration requests with this resource.

    NOTE: This resource must be executed on the source VSI (Virtual Server Instance) where the connector agent is installed, as it calls localhost APIs.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const backupRecoveryConnectorAgentRegistrationInstance = new ibm.BackupRecoveryConnectorAgentRegistration("backup_recovery_connector_agent_registration_instance", {
    registrationToken: "eyJ",
    connectionName: "terra-conn-register-Connector-1",
    joinExistingConnection: false,
});

    import pulumi
import pulumi_ibm as ibm

backup_recovery_connector_agent_registration_instance = ibm.BackupRecoveryConnectorAgentRegistration("backup_recovery_connector_agent_registration_instance",
    registration_token="eyJ",
    connection_name="terra-conn-register-Connector-1",
    join_existing_connection=False)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewBackupRecoveryConnectorAgentRegistration(ctx, "backup_recovery_connector_agent_registration_instance", &ibm.BackupRecoveryConnectorAgentRegistrationArgs{
			RegistrationToken:      pulumi.String("eyJ"),
			ConnectionName:         pulumi.String("terra-conn-register-Connector-1"),
			JoinExistingConnection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var backupRecoveryConnectorAgentRegistrationInstance = new Ibm.BackupRecoveryConnectorAgentRegistration("backup_recovery_connector_agent_registration_instance", new()
    {
        RegistrationToken = "eyJ",
        ConnectionName = "terra-conn-register-Connector-1",
        JoinExistingConnection = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.BackupRecoveryConnectorAgentRegistration;
import com.pulumi.ibm.BackupRecoveryConnectorAgentRegistrationArgs;
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 backupRecoveryConnectorAgentRegistrationInstance = new BackupRecoveryConnectorAgentRegistration("backupRecoveryConnectorAgentRegistrationInstance", BackupRecoveryConnectorAgentRegistrationArgs.builder()
            .registrationToken("eyJ")
            .connectionName("terra-conn-register-Connector-1")
            .joinExistingConnection(false)
            .build());

    }
}

    resources:
  backupRecoveryConnectorAgentRegistrationInstance:
    type: ibm:BackupRecoveryConnectorAgentRegistration
    name: backup_recovery_connector_agent_registration_instance
    properties:
      registrationToken: eyJ
      connectionName: terra-conn-register-Connector-1
      joinExistingConnection: false

    Example coming soon!

    Create BackupRecoveryConnectorAgentRegistration Resource

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

    Constructor syntax

    new BackupRecoveryConnectorAgentRegistration(name: string, args: BackupRecoveryConnectorAgentRegistrationArgs, opts?: CustomResourceOptions);
    @overload
def BackupRecoveryConnectorAgentRegistration(resource_name: str,
                                             args: BackupRecoveryConnectorAgentRegistrationArgs,
                                             opts: Optional[ResourceOptions] = None)

@overload
def BackupRecoveryConnectorAgentRegistration(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             connection_name: Optional[str] = None,
                                             registration_token: Optional[str] = None,
                                             backup_recovery_connector_agent_registration_id: Optional[str] = None,
                                             endpoint_type: Optional[str] = None,
                                             instance_id: Optional[str] = None,
                                             join_existing_connection: Optional[bool] = None,
                                             region: Optional[str] = None,
                                             service_name: Optional[str] = None)
    func NewBackupRecoveryConnectorAgentRegistration(ctx *Context, name string, args BackupRecoveryConnectorAgentRegistrationArgs, opts ...ResourceOption) (*BackupRecoveryConnectorAgentRegistration, error)
    public BackupRecoveryConnectorAgentRegistration(string name, BackupRecoveryConnectorAgentRegistrationArgs args, CustomResourceOptions? opts = null)
    public BackupRecoveryConnectorAgentRegistration(String name, BackupRecoveryConnectorAgentRegistrationArgs args)
public BackupRecoveryConnectorAgentRegistration(String name, BackupRecoveryConnectorAgentRegistrationArgs args, CustomResourceOptions options)

    type: ibm:BackupRecoveryConnectorAgentRegistration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "ibm_backup_recovery_connector_agent_registration" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BackupRecoveryConnectorAgentRegistrationArgs
    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 BackupRecoveryConnectorAgentRegistrationArgs
    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 BackupRecoveryConnectorAgentRegistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupRecoveryConnectorAgentRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupRecoveryConnectorAgentRegistrationArgs
    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 backupRecoveryConnectorAgentRegistrationResource = new Ibm.BackupRecoveryConnectorAgentRegistration("backupRecoveryConnectorAgentRegistrationResource", new()
{
    ConnectionName = "string",
    RegistrationToken = "string",
    BackupRecoveryConnectorAgentRegistrationId = "string",
    EndpointType = "string",
    InstanceId = "string",
    JoinExistingConnection = false,
    Region = "string",
    ServiceName = "string",
});

    example, err := ibm.NewBackupRecoveryConnectorAgentRegistration(ctx, "backupRecoveryConnectorAgentRegistrationResource", &ibm.BackupRecoveryConnectorAgentRegistrationArgs{
	ConnectionName:    pulumi.String("string"),
	RegistrationToken: pulumi.String("string"),
	BackupRecoveryConnectorAgentRegistrationId: pulumi.String("string"),
	EndpointType:           pulumi.String("string"),
	InstanceId:             pulumi.String("string"),
	JoinExistingConnection: pulumi.Bool(false),
	Region:                 pulumi.String("string"),
	ServiceName:            pulumi.String("string"),
})

    resource "ibm_backup_recovery_connector_agent_registration" "backupRecoveryConnectorAgentRegistrationResource" {
  lifecycle {
    create_before_destroy = true
  }
  connection_name                                 = "string"
  registration_token                              = "string"
  backup_recovery_connector_agent_registration_id = "string"
  endpoint_type                                   = "string"
  instance_id                                     = "string"
  join_existing_connection                        = false
  region                                          = "string"
  service_name                                    = "string"
}

    var backupRecoveryConnectorAgentRegistrationResource = new BackupRecoveryConnectorAgentRegistration("backupRecoveryConnectorAgentRegistrationResource", BackupRecoveryConnectorAgentRegistrationArgs.builder()
    .connectionName("string")
    .registrationToken("string")
    .backupRecoveryConnectorAgentRegistrationId("string")
    .endpointType("string")
    .instanceId("string")
    .joinExistingConnection(false)
    .region("string")
    .serviceName("string")
    .build());

    backup_recovery_connector_agent_registration_resource = ibm.BackupRecoveryConnectorAgentRegistration("backupRecoveryConnectorAgentRegistrationResource",
    connection_name="string",
    registration_token="string",
    backup_recovery_connector_agent_registration_id="string",
    endpoint_type="string",
    instance_id="string",
    join_existing_connection=False,
    region="string",
    service_name="string")

    const backupRecoveryConnectorAgentRegistrationResource = new ibm.BackupRecoveryConnectorAgentRegistration("backupRecoveryConnectorAgentRegistrationResource", {
    connectionName: "string",
    registrationToken: "string",
    backupRecoveryConnectorAgentRegistrationId: "string",
    endpointType: "string",
    instanceId: "string",
    joinExistingConnection: false,
    region: "string",
    serviceName: "string",
});

    type: ibm:BackupRecoveryConnectorAgentRegistration
properties:
    backupRecoveryConnectorAgentRegistrationId: string
    connectionName: string
    endpointType: string
    instanceId: string
    joinExistingConnection: false
    region: string
    registrationToken: string
    serviceName: string

    BackupRecoveryConnectorAgentRegistration 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 BackupRecoveryConnectorAgentRegistration resource accepts the following input properties:

    ConnectionName string
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    RegistrationToken string
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    BackupRecoveryConnectorAgentRegistrationId string
    EndpointType string
    public or private. Defaults to 'public' if not provided.
    InstanceId string
    The instnace ID of the Backup Recovery instance.
    JoinExistingConnection bool
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    Region string
    The region of the Backup Recovery instance.
    ServiceName string
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    ConnectionName string
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    RegistrationToken string
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    BackupRecoveryConnectorAgentRegistrationId string
    EndpointType string
    public or private. Defaults to 'public' if not provided.
    InstanceId string
    The instnace ID of the Backup Recovery instance.
    JoinExistingConnection bool
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    Region string
    The region of the Backup Recovery instance.
    ServiceName string
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    connection_name string
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    registration_token string
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    backup_recovery_connector_agent_registration_id string
    endpoint_type string
    public or private. Defaults to 'public' if not provided.
    instance_id string
    The instnace ID of the Backup Recovery instance.
    join_existing_connection bool
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region string
    The region of the Backup Recovery instance.
    service_name string
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    connectionName String
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    registrationToken String
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    backupRecoveryConnectorAgentRegistrationId String
    endpointType String
    public or private. Defaults to 'public' if not provided.
    instanceId String
    The instnace ID of the Backup Recovery instance.
    joinExistingConnection Boolean
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region String
    The region of the Backup Recovery instance.
    serviceName String
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    connectionName string
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    registrationToken string
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    backupRecoveryConnectorAgentRegistrationId string
    endpointType string
    public or private. Defaults to 'public' if not provided.
    instanceId string
    The instnace ID of the Backup Recovery instance.
    joinExistingConnection boolean
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region string
    The region of the Backup Recovery instance.
    serviceName string
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    connection_name str
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    registration_token str
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    backup_recovery_connector_agent_registration_id str
    endpoint_type str
    public or private. Defaults to 'public' if not provided.
    instance_id str
    The instnace ID of the Backup Recovery instance.
    join_existing_connection bool
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region str
    The region of the Backup Recovery instance.
    service_name str
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    connectionName String
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    registrationToken String
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    backupRecoveryConnectorAgentRegistrationId String
    endpointType String
    public or private. Defaults to 'public' if not provided.
    instanceId String
    The instnace ID of the Backup Recovery instance.
    joinExistingConnection Boolean
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region String
    The region of the Backup Recovery instance.
    serviceName String
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RegistrationStatus string
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegistrationStatus string
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    id string
    The provider-assigned unique ID for this managed resource.
    registration_status string
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    id String
    The provider-assigned unique ID for this managed resource.
    registrationStatus String
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    id string
    The provider-assigned unique ID for this managed resource.
    registrationStatus string
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    id str
    The provider-assigned unique ID for this managed resource.
    registration_status str
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    id String
    The provider-assigned unique ID for this managed resource.
    registrationStatus String
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.

    Look up Existing BackupRecoveryConnectorAgentRegistration Resource

    Get an existing BackupRecoveryConnectorAgentRegistration 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?: BackupRecoveryConnectorAgentRegistrationState, opts?: CustomResourceOptions): BackupRecoveryConnectorAgentRegistration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_recovery_connector_agent_registration_id: Optional[str] = None,
        connection_name: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        instance_id: Optional[str] = None,
        join_existing_connection: Optional[bool] = None,
        region: Optional[str] = None,
        registration_status: Optional[str] = None,
        registration_token: Optional[str] = None,
        service_name: Optional[str] = None) -> BackupRecoveryConnectorAgentRegistration
    func GetBackupRecoveryConnectorAgentRegistration(ctx *Context, name string, id IDInput, state *BackupRecoveryConnectorAgentRegistrationState, opts ...ResourceOption) (*BackupRecoveryConnectorAgentRegistration, error)
    public static BackupRecoveryConnectorAgentRegistration Get(string name, Input<string> id, BackupRecoveryConnectorAgentRegistrationState? state, CustomResourceOptions? opts = null)
    public static BackupRecoveryConnectorAgentRegistration get(String name, Output<String> id, BackupRecoveryConnectorAgentRegistrationState state, CustomResourceOptions options)
    resources:  _:    type: ibm:BackupRecoveryConnectorAgentRegistration    get:      id: ${id}
    import {
  to = ibm_backup_recovery_connector_agent_registration.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:
    BackupRecoveryConnectorAgentRegistrationId string
    ConnectionName string
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    EndpointType string
    public or private. Defaults to 'public' if not provided.
    InstanceId string
    The instnace ID of the Backup Recovery instance.
    JoinExistingConnection bool
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    Region string
    The region of the Backup Recovery instance.
    RegistrationStatus string
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    RegistrationToken string
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    ServiceName string
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    BackupRecoveryConnectorAgentRegistrationId string
    ConnectionName string
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    EndpointType string
    public or private. Defaults to 'public' if not provided.
    InstanceId string
    The instnace ID of the Backup Recovery instance.
    JoinExistingConnection bool
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    Region string
    The region of the Backup Recovery instance.
    RegistrationStatus string
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    RegistrationToken string
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    ServiceName string
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    backup_recovery_connector_agent_registration_id string
    connection_name string
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    endpoint_type string
    public or private. Defaults to 'public' if not provided.
    instance_id string
    The instnace ID of the Backup Recovery instance.
    join_existing_connection bool
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region string
    The region of the Backup Recovery instance.
    registration_status string
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    registration_token string
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    service_name string
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    backupRecoveryConnectorAgentRegistrationId String
    connectionName String
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    endpointType String
    public or private. Defaults to 'public' if not provided.
    instanceId String
    The instnace ID of the Backup Recovery instance.
    joinExistingConnection Boolean
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region String
    The region of the Backup Recovery instance.
    registrationStatus String
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    registrationToken String
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    serviceName String
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    backupRecoveryConnectorAgentRegistrationId string
    connectionName string
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    endpointType string
    public or private. Defaults to 'public' if not provided.
    instanceId string
    The instnace ID of the Backup Recovery instance.
    joinExistingConnection boolean
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region string
    The region of the Backup Recovery instance.
    registrationStatus string
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    registrationToken string
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    serviceName string
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    backup_recovery_connector_agent_registration_id str
    connection_name str
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    endpoint_type str
    public or private. Defaults to 'public' if not provided.
    instance_id str
    The instnace ID of the Backup Recovery instance.
    join_existing_connection bool
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region str
    The region of the Backup Recovery instance.
    registration_status str
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    registration_token str
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    service_name str
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.
    backupRecoveryConnectorAgentRegistrationId String
    connectionName String
    Specifies the name to be associated with the connector agent. This must be unique within the tenant to which this connector agent is registered.
    endpointType String
    public or private. Defaults to 'public' if not provided.
    instanceId String
    The instnace ID of the Backup Recovery instance.
    joinExistingConnection Boolean
    Whether this agent is joining a connection that was already claimed by a previous registration (e.g. another agent in the same cluster for clustered sources). When true, the server adds this agent to the existing connection instead of rejecting the request as a duplicate. If the connection does not yet exist, a new one is created regardless of this flag.

    • Constraints: The default value is false.
    region String
    The region of the Backup Recovery instance.
    registrationStatus String
    (String) Used to indicate if a duplicate registration was attempted.

    • Constraints: Allowable values are: registered, already-registered.
    registrationToken String
    The JWT registration token. A single token can be used to register multiple connector agents in that tenant. By default, the token is valid for 24 hours.
    serviceName String
    The service name for the Backup Recovery instance. Defaults to 'backup-recovery' if not provided.

    Import

    Not supported

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    Viewing docs for ibm 2.5.0
    published on Wednesday, Aug 5, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial