1. Packages
  2. Ibm Provider
  3. API Docs
  4. getBackupRecoveryConnectorStatus
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getBackupRecoveryConnectorStatus

Explore with Pulumi AI

Provides a read-only data source to retrieve information about Data-Source Connector Status. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

Example Usage

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

const backupRecoveryConnectorStatus = ibm.getBackupRecoveryConnectorStatus({
    accessToken: resource.ibm_backup_recovery_connector_access_token.name.access_token,
});
Copy
import pulumi
import pulumi_ibm as ibm

backup_recovery_connector_status = ibm.get_backup_recovery_connector_status(access_token=resource["ibm_backup_recovery_connector_access_token"]["name"]["access_token"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetBackupRecoveryConnectorStatus(ctx, &ibm.GetBackupRecoveryConnectorStatusArgs{
			AccessToken: resource.Ibm_backup_recovery_connector_access_token.Name.Access_token,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var backupRecoveryConnectorStatus = Ibm.GetBackupRecoveryConnectorStatus.Invoke(new()
    {
        AccessToken = resource.Ibm_backup_recovery_connector_access_token.Name.Access_token,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetBackupRecoveryConnectorStatusArgs;
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 backupRecoveryConnectorStatus = IbmFunctions.getBackupRecoveryConnectorStatus(GetBackupRecoveryConnectorStatusArgs.builder()
            .accessToken(resource.ibm_backup_recovery_connector_access_token().name().access_token())
            .build());

    }
}
Copy
variables:
  backupRecoveryConnectorStatus:
    fn::invoke:
      function: ibm:getBackupRecoveryConnectorStatus
      arguments:
        accessToken: ${resource.ibm_backup_recovery_connector_access_token.name.access_token}
Copy

Using getBackupRecoveryConnectorStatus

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBackupRecoveryConnectorStatus(args: GetBackupRecoveryConnectorStatusArgs, opts?: InvokeOptions): Promise<GetBackupRecoveryConnectorStatusResult>
function getBackupRecoveryConnectorStatusOutput(args: GetBackupRecoveryConnectorStatusOutputArgs, opts?: InvokeOptions): Output<GetBackupRecoveryConnectorStatusResult>
Copy
def get_backup_recovery_connector_status(access_token: Optional[str] = None,
                                         id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryConnectorStatusResult
def get_backup_recovery_connector_status_output(access_token: Optional[pulumi.Input[str]] = None,
                                         id: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetBackupRecoveryConnectorStatusResult]
Copy
func GetBackupRecoveryConnectorStatus(ctx *Context, args *GetBackupRecoveryConnectorStatusArgs, opts ...InvokeOption) (*GetBackupRecoveryConnectorStatusResult, error)
func GetBackupRecoveryConnectorStatusOutput(ctx *Context, args *GetBackupRecoveryConnectorStatusOutputArgs, opts ...InvokeOption) GetBackupRecoveryConnectorStatusResultOutput
Copy

> Note: This function is named GetBackupRecoveryConnectorStatus in the Go SDK.

public static class GetBackupRecoveryConnectorStatus 
{
    public static Task<GetBackupRecoveryConnectorStatusResult> InvokeAsync(GetBackupRecoveryConnectorStatusArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupRecoveryConnectorStatusResult> Invoke(GetBackupRecoveryConnectorStatusInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBackupRecoveryConnectorStatusResult> getBackupRecoveryConnectorStatus(GetBackupRecoveryConnectorStatusArgs args, InvokeOptions options)
public static Output<GetBackupRecoveryConnectorStatusResult> getBackupRecoveryConnectorStatus(GetBackupRecoveryConnectorStatusArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getBackupRecoveryConnectorStatus:getBackupRecoveryConnectorStatus
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccessToken This property is required. string
Specify an access token for connector authentication.
Id string
The unique identifier of the Data-Source Connector Status.
AccessToken This property is required. string
Specify an access token for connector authentication.
Id string
The unique identifier of the Data-Source Connector Status.
accessToken This property is required. String
Specify an access token for connector authentication.
id String
The unique identifier of the Data-Source Connector Status.
accessToken This property is required. string
Specify an access token for connector authentication.
id string
The unique identifier of the Data-Source Connector Status.
access_token This property is required. str
Specify an access token for connector authentication.
id str
The unique identifier of the Data-Source Connector Status.
accessToken This property is required. String
Specify an access token for connector authentication.
id String
The unique identifier of the Data-Source Connector Status.

getBackupRecoveryConnectorStatus Result

The following output properties are available:

AccessToken string
ClusterConnectionStatuses List<GetBackupRecoveryConnectorStatusClusterConnectionStatus>
(List) Specifies the data-source connector-cluster connectivity status. Nested schema for cluster_connection_status:
Id string
The unique identifier of the Data-Source Connector Status.
IsCertificateValid bool
(Boolean) Flag to indicate if connector certificate is valid.
RegistrationStatuses List<GetBackupRecoveryConnectorStatusRegistrationStatus>
(List) Specifies the data-source connector registration status. Nested schema for registration_status:
AccessToken string
ClusterConnectionStatuses []GetBackupRecoveryConnectorStatusClusterConnectionStatus
(List) Specifies the data-source connector-cluster connectivity status. Nested schema for cluster_connection_status:
Id string
The unique identifier of the Data-Source Connector Status.
IsCertificateValid bool
(Boolean) Flag to indicate if connector certificate is valid.
RegistrationStatuses []GetBackupRecoveryConnectorStatusRegistrationStatus
(List) Specifies the data-source connector registration status. Nested schema for registration_status:
accessToken String
clusterConnectionStatuses List<GetBackupRecoveryConnectorStatusClusterConnectionStatus>
(List) Specifies the data-source connector-cluster connectivity status. Nested schema for cluster_connection_status:
id String
The unique identifier of the Data-Source Connector Status.
isCertificateValid Boolean
(Boolean) Flag to indicate if connector certificate is valid.
registrationStatuses List<GetBackupRecoveryConnectorStatusRegistrationStatus>
(List) Specifies the data-source connector registration status. Nested schema for registration_status:
accessToken string
clusterConnectionStatuses GetBackupRecoveryConnectorStatusClusterConnectionStatus[]
(List) Specifies the data-source connector-cluster connectivity status. Nested schema for cluster_connection_status:
id string
The unique identifier of the Data-Source Connector Status.
isCertificateValid boolean
(Boolean) Flag to indicate if connector certificate is valid.
registrationStatuses GetBackupRecoveryConnectorStatusRegistrationStatus[]
(List) Specifies the data-source connector registration status. Nested schema for registration_status:
access_token str
cluster_connection_statuses Sequence[GetBackupRecoveryConnectorStatusClusterConnectionStatus]
(List) Specifies the data-source connector-cluster connectivity status. Nested schema for cluster_connection_status:
id str
The unique identifier of the Data-Source Connector Status.
is_certificate_valid bool
(Boolean) Flag to indicate if connector certificate is valid.
registration_statuses Sequence[GetBackupRecoveryConnectorStatusRegistrationStatus]
(List) Specifies the data-source connector registration status. Nested schema for registration_status:
accessToken String
clusterConnectionStatuses List<Property Map>
(List) Specifies the data-source connector-cluster connectivity status. Nested schema for cluster_connection_status:
id String
The unique identifier of the Data-Source Connector Status.
isCertificateValid Boolean
(Boolean) Flag to indicate if connector certificate is valid.
registrationStatuses List<Property Map>
(List) Specifies the data-source connector registration status. Nested schema for registration_status:

Supporting Types

GetBackupRecoveryConnectorStatusClusterConnectionStatus

IsActive This property is required. bool
(Boolean) Specifies if the connection to the cluster is active.
LastConnectedTimestampMsecs This property is required. double
(Integer) Specifies last known connectivity status time in milliseconds.
Message This property is required. string
(String) Specifies the message corresponding the registration.
IsActive This property is required. bool
(Boolean) Specifies if the connection to the cluster is active.
LastConnectedTimestampMsecs This property is required. float64
(Integer) Specifies last known connectivity status time in milliseconds.
Message This property is required. string
(String) Specifies the message corresponding the registration.
isActive This property is required. Boolean
(Boolean) Specifies if the connection to the cluster is active.
lastConnectedTimestampMsecs This property is required. Double
(Integer) Specifies last known connectivity status time in milliseconds.
message This property is required. String
(String) Specifies the message corresponding the registration.
isActive This property is required. boolean
(Boolean) Specifies if the connection to the cluster is active.
lastConnectedTimestampMsecs This property is required. number
(Integer) Specifies last known connectivity status time in milliseconds.
message This property is required. string
(String) Specifies the message corresponding the registration.
is_active This property is required. bool
(Boolean) Specifies if the connection to the cluster is active.
last_connected_timestamp_msecs This property is required. float
(Integer) Specifies last known connectivity status time in milliseconds.
message This property is required. str
(String) Specifies the message corresponding the registration.
isActive This property is required. Boolean
(Boolean) Specifies if the connection to the cluster is active.
lastConnectedTimestampMsecs This property is required. Number
(Integer) Specifies last known connectivity status time in milliseconds.
message This property is required. String
(String) Specifies the message corresponding the registration.

GetBackupRecoveryConnectorStatusRegistrationStatus

Message This property is required. string
(String) Specifies the message corresponding the registration.
Status This property is required. string
(String) Specifies the registration status.

  • Constraints: Allowable values are: NotDone, InProgress, Success, Failed.
Message This property is required. string
(String) Specifies the message corresponding the registration.
Status This property is required. string
(String) Specifies the registration status.

  • Constraints: Allowable values are: NotDone, InProgress, Success, Failed.
message This property is required. String
(String) Specifies the message corresponding the registration.
status This property is required. String
(String) Specifies the registration status.

  • Constraints: Allowable values are: NotDone, InProgress, Success, Failed.
message This property is required. string
(String) Specifies the message corresponding the registration.
status This property is required. string
(String) Specifies the registration status.

  • Constraints: Allowable values are: NotDone, InProgress, Success, Failed.
message This property is required. str
(String) Specifies the message corresponding the registration.
status This property is required. str
(String) Specifies the registration status.

  • Constraints: Allowable values are: NotDone, InProgress, Success, Failed.
message This property is required. String
(String) Specifies the message corresponding the registration.
status This property is required. String
(String) Specifies the registration status.

  • Constraints: Allowable values are: NotDone, InProgress, Success, Failed.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.