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

ibm.getHpcsVault

Explore with Pulumi AI

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

    Provides a read-only data source for vault. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const vault = ibm.getHpcsVault({
        instanceId: "76195d24-8a31-4c6d-9050-c35f09375cfb",
        region: "us-east",
        vaultId: "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    vault = ibm.get_hpcs_vault(instance_id="76195d24-8a31-4c6d-9050-c35f09375cfb",
        region="us-east",
        vault_id="5295ad47-2ce9-43c3-b9e7-e5a9482c362b")
    
    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.LookupHpcsVault(ctx, &ibm.LookupHpcsVaultArgs{
    			InstanceId: "76195d24-8a31-4c6d-9050-c35f09375cfb",
    			Region:     "us-east",
    			VaultId:    "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    		}, 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.GetHpcsVault.Invoke(new()
        {
            InstanceId = "76195d24-8a31-4c6d-9050-c35f09375cfb",
            Region = "us-east",
            VaultId = "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        });
    
    });
    
    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.GetHpcsVaultArgs;
    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.getHpcsVault(GetHpcsVaultArgs.builder()
                .instanceId("76195d24-8a31-4c6d-9050-c35f09375cfb")
                .region("us-east")
                .vaultId("5295ad47-2ce9-43c3-b9e7-e5a9482c362b")
                .build());
    
        }
    }
    
    variables:
      vault:
        fn::invoke:
          function: ibm:getHpcsVault
          arguments:
            instanceId: 76195d24-8a31-4c6d-9050-c35f09375cfb
            region: us-east
            vaultId: 5295ad47-2ce9-43c3-b9e7-e5a9482c362b
    

    Using getHpcsVault

    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 getHpcsVault(args: GetHpcsVaultArgs, opts?: InvokeOptions): Promise<GetHpcsVaultResult>
    function getHpcsVaultOutput(args: GetHpcsVaultOutputArgs, opts?: InvokeOptions): Output<GetHpcsVaultResult>
    def get_hpcs_vault(id: Optional[str] = None,
                       instance_id: Optional[str] = None,
                       region: Optional[str] = None,
                       vault_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetHpcsVaultResult
    def get_hpcs_vault_output(id: Optional[pulumi.Input[str]] = None,
                       instance_id: Optional[pulumi.Input[str]] = None,
                       region: Optional[pulumi.Input[str]] = None,
                       vault_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetHpcsVaultResult]
    func LookupHpcsVault(ctx *Context, args *LookupHpcsVaultArgs, opts ...InvokeOption) (*LookupHpcsVaultResult, error)
    func LookupHpcsVaultOutput(ctx *Context, args *LookupHpcsVaultOutputArgs, opts ...InvokeOption) LookupHpcsVaultResultOutput

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

    public static class GetHpcsVault 
    {
        public static Task<GetHpcsVaultResult> InvokeAsync(GetHpcsVaultArgs args, InvokeOptions? opts = null)
        public static Output<GetHpcsVaultResult> Invoke(GetHpcsVaultInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHpcsVaultResult> getHpcsVault(GetHpcsVaultArgs args, InvokeOptions options)
    public static Output<GetHpcsVaultResult> getHpcsVault(GetHpcsVaultArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getHpcsVault:getHpcsVault
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    ID of UKO Instance

    • Constraints: Must match the ID of the UKO instance you are trying to work with.
    Region string
    Region of the UKO Instance

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    VaultId string
    UUID of the vault.
    Id string
    InstanceId string
    ID of UKO Instance

    • Constraints: Must match the ID of the UKO instance you are trying to work with.
    Region string
    Region of the UKO Instance

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    VaultId string
    UUID of the vault.
    Id string
    instanceId String
    ID of UKO Instance

    • Constraints: Must match the ID of the UKO instance you are trying to work with.
    region String
    Region of the UKO Instance

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    vaultId String
    UUID of the vault.
    id String
    instanceId string
    ID of UKO Instance

    • Constraints: Must match the ID of the UKO instance you are trying to work with.
    region string
    Region of the UKO Instance

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    vaultId string
    UUID of the vault.
    id string
    instance_id str
    ID of UKO Instance

    • Constraints: Must match the ID of the UKO instance you are trying to work with.
    region str
    Region of the UKO Instance

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    vault_id str
    UUID of the vault.
    id str
    instanceId String
    ID of UKO Instance

    • Constraints: Must match the ID of the UKO instance you are trying to work with.
    region String
    Region of the UKO Instance

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    vaultId String
    UUID of the vault.
    id String

    getHpcsVault Result

    The following output properties are available:

    CreatedAt string
    (String) Date and time when the vault was created.
    CreatedBy string
    (String) ID of the user that created the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$%'_-]*$/.
    Description string
    (Required, String) Description of the vault.

    • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /.*/.
    Href string
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    Id string
    InstanceId string
    Name string
    (String) Name of the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    Region string
    UpdatedAt string
    (String) Date and time when the vault was last updated.
    UpdatedBy string
    (String) ID of the user that last updated the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    VaultId string
    The unique identifier of the vault.
    CreatedAt string
    (String) Date and time when the vault was created.
    CreatedBy string
    (String) ID of the user that created the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$%'_-]*$/.
    Description string
    (Required, String) Description of the vault.

    • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /.*/.
    Href string
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    Id string
    InstanceId string
    Name string
    (String) Name of the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    Region string
    UpdatedAt string
    (String) Date and time when the vault was last updated.
    UpdatedBy string
    (String) ID of the user that last updated the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    VaultId string
    The unique identifier of the vault.
    createdAt String
    (String) Date and time when the vault was created.
    createdBy String
    (String) ID of the user that created the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$%'_-]*$/.
    description String
    (Required, String) Description of the vault.

    • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /.*/.
    href String
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id String
    instanceId String
    name String
    (String) Name of the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    region String
    updatedAt String
    (String) Date and time when the vault was last updated.
    updatedBy String
    (String) ID of the user that last updated the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    vaultId String
    The unique identifier of the vault.
    createdAt string
    (String) Date and time when the vault was created.
    createdBy string
    (String) ID of the user that created the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$%'_-]*$/.
    description string
    (Required, String) Description of the vault.

    • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /.*/.
    href string
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id string
    instanceId string
    name string
    (String) Name of the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    region string
    updatedAt string
    (String) Date and time when the vault was last updated.
    updatedBy string
    (String) ID of the user that last updated the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    vaultId string
    The unique identifier of the vault.
    created_at str
    (String) Date and time when the vault was created.
    created_by str
    (String) ID of the user that created the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$%'_-]*$/.
    description str
    (Required, String) Description of the vault.

    • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /.*/.
    href str
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id str
    instance_id str
    name str
    (String) Name of the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    region str
    updated_at str
    (String) Date and time when the vault was last updated.
    updated_by str
    (String) ID of the user that last updated the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    vault_id str
    The unique identifier of the vault.
    createdAt String
    (String) Date and time when the vault was created.
    createdBy String
    (String) ID of the user that created the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$%'_-]*$/.
    description String
    (Required, String) Description of the vault.

    • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /.*/.
    href String
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id String
    instanceId String
    name String
    (String) Name of the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    region String
    updatedAt String
    (String) Date and time when the vault was last updated.
    updatedBy String
    (String) ID of the user that last updated the vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9#@!$% '_-]*$/.
    vaultId String
    The unique identifier of the vault.

    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