ibm 1.80.0-beta0 published on Tuesday, Jun 24, 2025 by ibm-cloud
ibm.getCosBackupVault
Explore with Pulumi AI
Retrieves information for a backup vault that stores bucket backup data.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const vault = ibm.getCosBackupVault({
backupVaultName: "name of the vault",
region: "us",
serviceInstanceId: "instance_id",
});
import pulumi
import pulumi_ibm as ibm
vault = ibm.get_cos_backup_vault(backup_vault_name="name of the vault",
region="us",
service_instance_id="instance_id")
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.LookupCosBackupVault(ctx, &ibm.LookupCosBackupVaultArgs{
BackupVaultName: "name of the vault",
Region: "us",
ServiceInstanceId: "instance_id",
}, nil)
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 vault = Ibm.GetCosBackupVault.Invoke(new()
{
BackupVaultName = "name of the vault",
Region = "us",
ServiceInstanceId = "instance_id",
});
});
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.GetCosBackupVaultArgs;
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 vault = IbmFunctions.getCosBackupVault(GetCosBackupVaultArgs.builder()
.backupVaultName("name of the vault")
.region("us")
.serviceInstanceId("instance_id")
.build());
}
}
variables:
vault:
fn::invoke:
function: ibm:getCosBackupVault
arguments:
backupVaultName: name of the vault
region: us
serviceInstanceId: instance_id
Using getCosBackupVault
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 getCosBackupVault(args: GetCosBackupVaultArgs, opts?: InvokeOptions): Promise<GetCosBackupVaultResult>
function getCosBackupVaultOutput(args: GetCosBackupVaultOutputArgs, opts?: InvokeOptions): Output<GetCosBackupVaultResult>
def get_cos_backup_vault(backup_vault_name: Optional[str] = None,
id: Optional[str] = None,
region: Optional[str] = None,
service_instance_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCosBackupVaultResult
def get_cos_backup_vault_output(backup_vault_name: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
service_instance_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCosBackupVaultResult]
func LookupCosBackupVault(ctx *Context, args *LookupCosBackupVaultArgs, opts ...InvokeOption) (*LookupCosBackupVaultResult, error)
func LookupCosBackupVaultOutput(ctx *Context, args *LookupCosBackupVaultOutputArgs, opts ...InvokeOption) LookupCosBackupVaultResultOutput
> Note: This function is named LookupCosBackupVault
in the Go SDK.
public static class GetCosBackupVault
{
public static Task<GetCosBackupVaultResult> InvokeAsync(GetCosBackupVaultArgs args, InvokeOptions? opts = null)
public static Output<GetCosBackupVaultResult> Invoke(GetCosBackupVaultInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCosBackupVaultResult> getCosBackupVault(GetCosBackupVaultArgs args, InvokeOptions options)
public static Output<GetCosBackupVaultResult> getCosBackupVault(GetCosBackupVaultArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getCosBackupVault:getCosBackupVault
arguments:
# arguments dictionary
The following arguments are supported:
- Backup
Vault stringName - Name of the backup vault.
- Region string
- The location of the COS backup vault.
- Service
Instance stringId - The service instance of the Backup Vault.
- Id string
- Backup
Vault stringName - Name of the backup vault.
- Region string
- The location of the COS backup vault.
- Service
Instance stringId - The service instance of the Backup Vault.
- Id string
- backup
Vault StringName - Name of the backup vault.
- region String
- The location of the COS backup vault.
- service
Instance StringId - The service instance of the Backup Vault.
- id String
- backup
Vault stringName - Name of the backup vault.
- region string
- The location of the COS backup vault.
- service
Instance stringId - The service instance of the Backup Vault.
- id string
- backup_
vault_ strname - Name of the backup vault.
- region str
- The location of the COS backup vault.
- service_
instance_ strid - The service instance of the Backup Vault.
- id str
- backup
Vault StringName - Name of the backup vault.
- region String
- The location of the COS backup vault.
- service
Instance StringId - The service instance of the Backup Vault.
- id String
getCosBackupVault Result
The following output properties are available:
- Activity
Tracking boolManagement Events - (Bool) Whether notification has been sent for the management events for backup vault.
- Backup
Vault stringName - Id string
- Kms
Key stringCrn - (String) Crn of the key protect root key.
- Metrics
Monitoring boolUsage Metrics - (Bool) Whether usage metrics is collected for this backup vault.
- Region string
- Service
Instance stringId
- Activity
Tracking boolManagement Events - (Bool) Whether notification has been sent for the management events for backup vault.
- Backup
Vault stringName - Id string
- Kms
Key stringCrn - (String) Crn of the key protect root key.
- Metrics
Monitoring boolUsage Metrics - (Bool) Whether usage metrics is collected for this backup vault.
- Region string
- Service
Instance stringId
- activity
Tracking BooleanManagement Events - (Bool) Whether notification has been sent for the management events for backup vault.
- backup
Vault StringName - id String
- kms
Key StringCrn - (String) Crn of the key protect root key.
- metrics
Monitoring BooleanUsage Metrics - (Bool) Whether usage metrics is collected for this backup vault.
- region String
- service
Instance StringId
- activity
Tracking booleanManagement Events - (Bool) Whether notification has been sent for the management events for backup vault.
- backup
Vault stringName - id string
- kms
Key stringCrn - (String) Crn of the key protect root key.
- metrics
Monitoring booleanUsage Metrics - (Bool) Whether usage metrics is collected for this backup vault.
- region string
- service
Instance stringId
- activity_
tracking_ boolmanagement_ events - (Bool) Whether notification has been sent for the management events for backup vault.
- backup_
vault_ strname - id str
- kms_
key_ strcrn - (String) Crn of the key protect root key.
- metrics_
monitoring_ boolusage_ metrics - (Bool) Whether usage metrics is collected for this backup vault.
- region str
- service_
instance_ strid
- activity
Tracking BooleanManagement Events - (Bool) Whether notification has been sent for the management events for backup vault.
- backup
Vault StringName - id String
- kms
Key StringCrn - (String) Crn of the key protect root key.
- metrics
Monitoring BooleanUsage Metrics - (Bool) Whether usage metrics is collected for this backup vault.
- region String
- service
Instance StringId
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.