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

ibm.StorageEvault

Explore with Pulumi AI

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

    Create, delete, and update a EVault storage resource. For more information, about storage evalut getting started with IBM Cloud backup.

    Example Usage

    In the following example, you can create 20G of EVault storage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const test = new ibm.StorageEvault("test", {
        capacity: 20,
        datacenter: "dal05",
        virtualInstanceId: 62870765,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    test = ibm.StorageEvault("test",
        capacity=20,
        datacenter="dal05",
        virtual_instance_id=62870765)
    
    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.NewStorageEvault(ctx, "test", &ibm.StorageEvaultArgs{
    			Capacity:          pulumi.Float64(20),
    			Datacenter:        pulumi.String("dal05"),
    			VirtualInstanceId: pulumi.Float64(62870765),
    		})
    		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 test = new Ibm.StorageEvault("test", new()
        {
            Capacity = 20,
            Datacenter = "dal05",
            VirtualInstanceId = 62870765,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.StorageEvault;
    import com.pulumi.ibm.StorageEvaultArgs;
    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 test = new StorageEvault("test", StorageEvaultArgs.builder()
                .capacity("20")
                .datacenter("dal05")
                .virtualInstanceId("62870765")
                .build());
    
        }
    }
    
    resources:
      test:
        type: ibm:StorageEvault
        properties:
          capacity: '20'
          datacenter: dal05
          virtualInstanceId: '62870765'
    

    Create StorageEvault Resource

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

    Constructor syntax

    new StorageEvault(name: string, args: StorageEvaultArgs, opts?: CustomResourceOptions);
    @overload
    def StorageEvault(resource_name: str,
                      args: StorageEvaultArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def StorageEvault(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      capacity: Optional[float] = None,
                      datacenter: Optional[str] = None,
                      hardware_instance_id: Optional[float] = None,
                      storage_evault_id: Optional[str] = None,
                      tags: Optional[Sequence[str]] = None,
                      timeouts: Optional[StorageEvaultTimeoutsArgs] = None,
                      virtual_instance_id: Optional[float] = None)
    func NewStorageEvault(ctx *Context, name string, args StorageEvaultArgs, opts ...ResourceOption) (*StorageEvault, error)
    public StorageEvault(string name, StorageEvaultArgs args, CustomResourceOptions? opts = null)
    public StorageEvault(String name, StorageEvaultArgs args)
    public StorageEvault(String name, StorageEvaultArgs args, CustomResourceOptions options)
    
    type: ibm:StorageEvault
    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 StorageEvaultArgs
    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 StorageEvaultArgs
    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 StorageEvaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StorageEvaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StorageEvaultArgs
    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 storageEvaultResource = new Ibm.StorageEvault("storageEvaultResource", new()
    {
        Capacity = 0,
        Datacenter = "string",
        HardwareInstanceId = 0,
        StorageEvaultId = "string",
        Tags = new[]
        {
            "string",
        },
        Timeouts = new Ibm.Inputs.StorageEvaultTimeoutsArgs
        {
            Create = "string",
            Update = "string",
        },
        VirtualInstanceId = 0,
    });
    
    example, err := ibm.NewStorageEvault(ctx, "storageEvaultResource", &ibm.StorageEvaultArgs{
    	Capacity:           pulumi.Float64(0),
    	Datacenter:         pulumi.String("string"),
    	HardwareInstanceId: pulumi.Float64(0),
    	StorageEvaultId:    pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Timeouts: &ibm.StorageEvaultTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	VirtualInstanceId: pulumi.Float64(0),
    })
    
    var storageEvaultResource = new StorageEvault("storageEvaultResource", StorageEvaultArgs.builder()
        .capacity(0)
        .datacenter("string")
        .hardwareInstanceId(0)
        .storageEvaultId("string")
        .tags("string")
        .timeouts(StorageEvaultTimeoutsArgs.builder()
            .create("string")
            .update("string")
            .build())
        .virtualInstanceId(0)
        .build());
    
    storage_evault_resource = ibm.StorageEvault("storageEvaultResource",
        capacity=0,
        datacenter="string",
        hardware_instance_id=0,
        storage_evault_id="string",
        tags=["string"],
        timeouts={
            "create": "string",
            "update": "string",
        },
        virtual_instance_id=0)
    
    const storageEvaultResource = new ibm.StorageEvault("storageEvaultResource", {
        capacity: 0,
        datacenter: "string",
        hardwareInstanceId: 0,
        storageEvaultId: "string",
        tags: ["string"],
        timeouts: {
            create: "string",
            update: "string",
        },
        virtualInstanceId: 0,
    });
    
    type: ibm:StorageEvault
    properties:
        capacity: 0
        datacenter: string
        hardwareInstanceId: 0
        storageEvaultId: string
        tags:
            - string
        timeouts:
            create: string
            update: string
        virtualInstanceId: 0
    

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

    Capacity double
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    Datacenter string
    The data center where you want to provision the EVault storage instance.
    HardwareInstanceId double
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    StorageEvaultId string
    (String) The unique identifier of the EVault.
    Tags List<string>
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timeouts StorageEvaultTimeouts
    VirtualInstanceId double
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    Capacity float64
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    Datacenter string
    The data center where you want to provision the EVault storage instance.
    HardwareInstanceId float64
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    StorageEvaultId string
    (String) The unique identifier of the EVault.
    Tags []string
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timeouts StorageEvaultTimeoutsArgs
    VirtualInstanceId float64
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    capacity Double
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    datacenter String
    The data center where you want to provision the EVault storage instance.
    hardwareInstanceId Double
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    storageEvaultId String
    (String) The unique identifier of the EVault.
    tags List<String>
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageEvaultTimeouts
    virtualInstanceId Double
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    capacity number
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    datacenter string
    The data center where you want to provision the EVault storage instance.
    hardwareInstanceId number
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    storageEvaultId string
    (String) The unique identifier of the EVault.
    tags string[]
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageEvaultTimeouts
    virtualInstanceId number
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    capacity float
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    datacenter str
    The data center where you want to provision the EVault storage instance.
    hardware_instance_id float
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    storage_evault_id str
    (String) The unique identifier of the EVault.
    tags Sequence[str]
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageEvaultTimeoutsArgs
    virtual_instance_id float
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    capacity Number
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    datacenter String
    The data center where you want to provision the EVault storage instance.
    hardwareInstanceId Number
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    storageEvaultId String
    (String) The unique identifier of the EVault.
    tags List<String>
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts Property Map
    virtualInstanceId Number
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (String) The password of the EVault.
    ServiceResourceName string
    (String) The name of an EVault storage network resource.
    Username string
    (String) The username of the EVault.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (String) The password of the EVault.
    ServiceResourceName string
    (String) The name of an EVault storage network resource.
    Username string
    (String) The username of the EVault.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (String) The password of the EVault.
    serviceResourceName String
    (String) The name of an EVault storage network resource.
    username String
    (String) The username of the EVault.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    (String) The password of the EVault.
    serviceResourceName string
    (String) The name of an EVault storage network resource.
    username string
    (String) The username of the EVault.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    (String) The password of the EVault.
    service_resource_name str
    (String) The name of an EVault storage network resource.
    username str
    (String) The username of the EVault.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (String) The password of the EVault.
    serviceResourceName String
    (String) The name of an EVault storage network resource.
    username String
    (String) The username of the EVault.

    Look up Existing StorageEvault Resource

    Get an existing StorageEvault 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?: StorageEvaultState, opts?: CustomResourceOptions): StorageEvault
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            capacity: Optional[float] = None,
            datacenter: Optional[str] = None,
            hardware_instance_id: Optional[float] = None,
            password: Optional[str] = None,
            service_resource_name: Optional[str] = None,
            storage_evault_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            timeouts: Optional[StorageEvaultTimeoutsArgs] = None,
            username: Optional[str] = None,
            virtual_instance_id: Optional[float] = None) -> StorageEvault
    func GetStorageEvault(ctx *Context, name string, id IDInput, state *StorageEvaultState, opts ...ResourceOption) (*StorageEvault, error)
    public static StorageEvault Get(string name, Input<string> id, StorageEvaultState? state, CustomResourceOptions? opts = null)
    public static StorageEvault get(String name, Output<String> id, StorageEvaultState state, CustomResourceOptions options)
    resources:  _:    type: ibm:StorageEvault    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:
    Capacity double
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    Datacenter string
    The data center where you want to provision the EVault storage instance.
    HardwareInstanceId double
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    Password string
    (String) The password of the EVault.
    ServiceResourceName string
    (String) The name of an EVault storage network resource.
    StorageEvaultId string
    (String) The unique identifier of the EVault.
    Tags List<string>
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timeouts StorageEvaultTimeouts
    Username string
    (String) The username of the EVault.
    VirtualInstanceId double
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    Capacity float64
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    Datacenter string
    The data center where you want to provision the EVault storage instance.
    HardwareInstanceId float64
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    Password string
    (String) The password of the EVault.
    ServiceResourceName string
    (String) The name of an EVault storage network resource.
    StorageEvaultId string
    (String) The unique identifier of the EVault.
    Tags []string
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timeouts StorageEvaultTimeoutsArgs
    Username string
    (String) The username of the EVault.
    VirtualInstanceId float64
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    capacity Double
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    datacenter String
    The data center where you want to provision the EVault storage instance.
    hardwareInstanceId Double
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    password String
    (String) The password of the EVault.
    serviceResourceName String
    (String) The name of an EVault storage network resource.
    storageEvaultId String
    (String) The unique identifier of the EVault.
    tags List<String>
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageEvaultTimeouts
    username String
    (String) The username of the EVault.
    virtualInstanceId Double
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    capacity number
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    datacenter string
    The data center where you want to provision the EVault storage instance.
    hardwareInstanceId number
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    password string
    (String) The password of the EVault.
    serviceResourceName string
    (String) The name of an EVault storage network resource.
    storageEvaultId string
    (String) The unique identifier of the EVault.
    tags string[]
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageEvaultTimeouts
    username string
    (String) The username of the EVault.
    virtualInstanceId number
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    capacity float
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    datacenter str
    The data center where you want to provision the EVault storage instance.
    hardware_instance_id float
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    password str
    (String) The password of the EVault.
    service_resource_name str
    (String) The name of an EVault storage network resource.
    storage_evault_id str
    (String) The unique identifier of the EVault.
    tags Sequence[str]
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageEvaultTimeoutsArgs
    username str
    (String) The username of the EVault.
    virtual_instance_id float
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.
    capacity Number
    The amount of storage capacity that you want to allocate, specified in gigabytes.
    datacenter String
    The data center where you want to provision the EVault storage instance.
    hardwareInstanceId Number
    The ID of the hardware instance. Note Conflicts with virtual_instance_id.
    password String
    (String) The password of the EVault.
    serviceResourceName String
    (String) The name of an EVault storage network resource.
    storageEvaultId String
    (String) The unique identifier of the EVault.
    tags List<String>
    Tags associated with the storage EVault instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts Property Map
    username String
    (String) The username of the EVault.
    virtualInstanceId Number
    The ID of the virtual instance. Note Conflicts with hardware_instance_id.

    Supporting Types

    StorageEvaultTimeouts, StorageEvaultTimeoutsArgs

    Create string
    Update string
    Create string
    Update string
    create String
    update String
    create string
    update string
    create str
    update str
    create 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