1. Packages
  2. Ibm Provider
  3. API Docs
  4. CosBackupVault
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.CosBackupVault

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Create CosBackupVault Resource

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

    Constructor syntax

    new CosBackupVault(name: string, args: CosBackupVaultArgs, opts?: CustomResourceOptions);
    @overload
    def CosBackupVault(resource_name: str,
                       args: CosBackupVaultArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def CosBackupVault(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       backup_vault_name: Optional[str] = None,
                       region: Optional[str] = None,
                       service_instance_id: Optional[str] = None,
                       activity_tracking_management_events: Optional[bool] = None,
                       cos_backup_vault_id: Optional[str] = None,
                       kms_key_crn: Optional[str] = None,
                       metrics_monitoring_usage_metrics: Optional[bool] = None,
                       timeouts: Optional[CosBackupVaultTimeoutsArgs] = None)
    func NewCosBackupVault(ctx *Context, name string, args CosBackupVaultArgs, opts ...ResourceOption) (*CosBackupVault, error)
    public CosBackupVault(string name, CosBackupVaultArgs args, CustomResourceOptions? opts = null)
    public CosBackupVault(String name, CosBackupVaultArgs args)
    public CosBackupVault(String name, CosBackupVaultArgs args, CustomResourceOptions options)
    
    type: ibm:CosBackupVault
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CosBackupVaultArgs
    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 CosBackupVaultArgs
    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 CosBackupVaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CosBackupVaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CosBackupVaultArgs
    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 cosBackupVaultResource = new Ibm.CosBackupVault("cosBackupVaultResource", new()
    {
        BackupVaultName = "string",
        Region = "string",
        ServiceInstanceId = "string",
        ActivityTrackingManagementEvents = false,
        CosBackupVaultId = "string",
        KmsKeyCrn = "string",
        MetricsMonitoringUsageMetrics = false,
        Timeouts = new Ibm.Inputs.CosBackupVaultTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := ibm.NewCosBackupVault(ctx, "cosBackupVaultResource", &ibm.CosBackupVaultArgs{
    	BackupVaultName:                  pulumi.String("string"),
    	Region:                           pulumi.String("string"),
    	ServiceInstanceId:                pulumi.String("string"),
    	ActivityTrackingManagementEvents: pulumi.Bool(false),
    	CosBackupVaultId:                 pulumi.String("string"),
    	KmsKeyCrn:                        pulumi.String("string"),
    	MetricsMonitoringUsageMetrics:    pulumi.Bool(false),
    	Timeouts: &ibm.CosBackupVaultTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var cosBackupVaultResource = new CosBackupVault("cosBackupVaultResource", CosBackupVaultArgs.builder()
        .backupVaultName("string")
        .region("string")
        .serviceInstanceId("string")
        .activityTrackingManagementEvents(false)
        .cosBackupVaultId("string")
        .kmsKeyCrn("string")
        .metricsMonitoringUsageMetrics(false)
        .timeouts(CosBackupVaultTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    cos_backup_vault_resource = ibm.CosBackupVault("cosBackupVaultResource",
        backup_vault_name="string",
        region="string",
        service_instance_id="string",
        activity_tracking_management_events=False,
        cos_backup_vault_id="string",
        kms_key_crn="string",
        metrics_monitoring_usage_metrics=False,
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const cosBackupVaultResource = new ibm.CosBackupVault("cosBackupVaultResource", {
        backupVaultName: "string",
        region: "string",
        serviceInstanceId: "string",
        activityTrackingManagementEvents: false,
        cosBackupVaultId: "string",
        kmsKeyCrn: "string",
        metricsMonitoringUsageMetrics: false,
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: ibm:CosBackupVault
    properties:
        activityTrackingManagementEvents: false
        backupVaultName: string
        cosBackupVaultId: string
        kmsKeyCrn: string
        metricsMonitoringUsageMetrics: false
        region: string
        serviceInstanceId: string
        timeouts:
            create: string
            delete: string
            update: string
    

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

    BackupVaultName string
    Name of the Backup Vault.
    Region string
    Location where backup vault to be created.
    ServiceInstanceId string
    Instance id for the backup vault.
    ActivityTrackingManagementEvents bool
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    CosBackupVaultId string
    KmsKeyCrn string
    The CRN for a KeyProtect root key.
    MetricsMonitoringUsageMetrics bool
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    Timeouts CosBackupVaultTimeouts
    BackupVaultName string
    Name of the Backup Vault.
    Region string
    Location where backup vault to be created.
    ServiceInstanceId string
    Instance id for the backup vault.
    ActivityTrackingManagementEvents bool
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    CosBackupVaultId string
    KmsKeyCrn string
    The CRN for a KeyProtect root key.
    MetricsMonitoringUsageMetrics bool
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    Timeouts CosBackupVaultTimeoutsArgs
    backupVaultName String
    Name of the Backup Vault.
    region String
    Location where backup vault to be created.
    serviceInstanceId String
    Instance id for the backup vault.
    activityTrackingManagementEvents Boolean
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    cosBackupVaultId String
    kmsKeyCrn String
    The CRN for a KeyProtect root key.
    metricsMonitoringUsageMetrics Boolean
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    timeouts CosBackupVaultTimeouts
    backupVaultName string
    Name of the Backup Vault.
    region string
    Location where backup vault to be created.
    serviceInstanceId string
    Instance id for the backup vault.
    activityTrackingManagementEvents boolean
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    cosBackupVaultId string
    kmsKeyCrn string
    The CRN for a KeyProtect root key.
    metricsMonitoringUsageMetrics boolean
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    timeouts CosBackupVaultTimeouts
    backup_vault_name str
    Name of the Backup Vault.
    region str
    Location where backup vault to be created.
    service_instance_id str
    Instance id for the backup vault.
    activity_tracking_management_events bool
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    cos_backup_vault_id str
    kms_key_crn str
    The CRN for a KeyProtect root key.
    metrics_monitoring_usage_metrics bool
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    timeouts CosBackupVaultTimeoutsArgs
    backupVaultName String
    Name of the Backup Vault.
    region String
    Location where backup vault to be created.
    serviceInstanceId String
    Instance id for the backup vault.
    activityTrackingManagementEvents Boolean
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    cosBackupVaultId String
    kmsKeyCrn String
    The CRN for a KeyProtect root key.
    metricsMonitoringUsageMetrics Boolean
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    timeouts Property Map

    Outputs

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

    BackupVaultCrn string
    CRN of resource instance
    Id string
    The provider-assigned unique ID for this managed resource.
    BackupVaultCrn string
    CRN of resource instance
    Id string
    The provider-assigned unique ID for this managed resource.
    backupVaultCrn String
    CRN of resource instance
    id String
    The provider-assigned unique ID for this managed resource.
    backupVaultCrn string
    CRN of resource instance
    id string
    The provider-assigned unique ID for this managed resource.
    backup_vault_crn str
    CRN of resource instance
    id str
    The provider-assigned unique ID for this managed resource.
    backupVaultCrn String
    CRN of resource instance
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CosBackupVault Resource

    Get an existing CosBackupVault 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?: CosBackupVaultState, opts?: CustomResourceOptions): CosBackupVault
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            activity_tracking_management_events: Optional[bool] = None,
            backup_vault_crn: Optional[str] = None,
            backup_vault_name: Optional[str] = None,
            cos_backup_vault_id: Optional[str] = None,
            kms_key_crn: Optional[str] = None,
            metrics_monitoring_usage_metrics: Optional[bool] = None,
            region: Optional[str] = None,
            service_instance_id: Optional[str] = None,
            timeouts: Optional[CosBackupVaultTimeoutsArgs] = None) -> CosBackupVault
    func GetCosBackupVault(ctx *Context, name string, id IDInput, state *CosBackupVaultState, opts ...ResourceOption) (*CosBackupVault, error)
    public static CosBackupVault Get(string name, Input<string> id, CosBackupVaultState? state, CustomResourceOptions? opts = null)
    public static CosBackupVault get(String name, Output<String> id, CosBackupVaultState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CosBackupVault    get:      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:
    ActivityTrackingManagementEvents bool
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    BackupVaultCrn string
    CRN of resource instance
    BackupVaultName string
    Name of the Backup Vault.
    CosBackupVaultId string
    KmsKeyCrn string
    The CRN for a KeyProtect root key.
    MetricsMonitoringUsageMetrics bool
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    Region string
    Location where backup vault to be created.
    ServiceInstanceId string
    Instance id for the backup vault.
    Timeouts CosBackupVaultTimeouts
    ActivityTrackingManagementEvents bool
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    BackupVaultCrn string
    CRN of resource instance
    BackupVaultName string
    Name of the Backup Vault.
    CosBackupVaultId string
    KmsKeyCrn string
    The CRN for a KeyProtect root key.
    MetricsMonitoringUsageMetrics bool
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    Region string
    Location where backup vault to be created.
    ServiceInstanceId string
    Instance id for the backup vault.
    Timeouts CosBackupVaultTimeoutsArgs
    activityTrackingManagementEvents Boolean
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    backupVaultCrn String
    CRN of resource instance
    backupVaultName String
    Name of the Backup Vault.
    cosBackupVaultId String
    kmsKeyCrn String
    The CRN for a KeyProtect root key.
    metricsMonitoringUsageMetrics Boolean
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    region String
    Location where backup vault to be created.
    serviceInstanceId String
    Instance id for the backup vault.
    timeouts CosBackupVaultTimeouts
    activityTrackingManagementEvents boolean
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    backupVaultCrn string
    CRN of resource instance
    backupVaultName string
    Name of the Backup Vault.
    cosBackupVaultId string
    kmsKeyCrn string
    The CRN for a KeyProtect root key.
    metricsMonitoringUsageMetrics boolean
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    region string
    Location where backup vault to be created.
    serviceInstanceId string
    Instance id for the backup vault.
    timeouts CosBackupVaultTimeouts
    activity_tracking_management_events bool
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    backup_vault_crn str
    CRN of resource instance
    backup_vault_name str
    Name of the Backup Vault.
    cos_backup_vault_id str
    kms_key_crn str
    The CRN for a KeyProtect root key.
    metrics_monitoring_usage_metrics bool
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    region str
    Location where backup vault to be created.
    service_instance_id str
    Instance id for the backup vault.
    timeouts CosBackupVaultTimeoutsArgs
    activityTrackingManagementEvents Boolean
    Activity Tracking configuration.Whether to send notifications for management events on the BackupVault.
    backupVaultCrn String
    CRN of resource instance
    backupVaultName String
    Name of the Backup Vault.
    cosBackupVaultId String
    kmsKeyCrn String
    The CRN for a KeyProtect root key.
    metricsMonitoringUsageMetrics Boolean
    Metrics Monitoring configuration.Whether usage metrics are collected for this BackupVault.
    region String
    Location where backup vault to be created.
    serviceInstanceId String
    Instance id for the backup vault.
    timeouts Property Map

    Supporting Types

    CosBackupVaultTimeouts, CosBackupVaultTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud