Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getHpcs
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getHpcs

Explore with Pulumi AI

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

    Imports a read only copy of an existing Hyper Protect Crypto Services resource.

    Example Usage

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

const hpcsInstance = ibm.getHpcs({
    name: "test",
});

    import pulumi
import pulumi_ibm as ibm

hpcs_instance = ibm.get_hpcs(name="test")

    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.LookupHpcs(ctx, &ibm.LookupHpcsArgs{
			Name: "test",
		}, 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 hpcsInstance = Ibm.GetHpcs.Invoke(new()
    {
        Name = "test",
    });

});

    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.GetHpcsArgs;
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 hpcsInstance = IbmFunctions.getHpcs(GetHpcsArgs.builder()
            .name("test")
            .build());

    }
}

    variables:
  hpcsInstance:
    fn::invoke:
      function: ibm:getHpcs
      arguments:
        name: test

    Using getHpcs

    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 getHpcs(args: GetHpcsArgs, opts?: InvokeOptions): Promise<GetHpcsResult>
function getHpcsOutput(args: GetHpcsOutputArgs, opts?: InvokeOptions): Output<GetHpcsResult>
    def get_hpcs(id: Optional[str] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             resource_group_id: Optional[str] = None,
             service: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetHpcsResult
def get_hpcs_output(id: Optional[pulumi.Input[str]] = None,
             location: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             resource_group_id: Optional[pulumi.Input[str]] = None,
             service: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetHpcsResult]
    func LookupHpcs(ctx *Context, args *LookupHpcsArgs, opts ...InvokeOption) (*LookupHpcsResult, error)
func LookupHpcsOutput(ctx *Context, args *LookupHpcsOutputArgs, opts ...InvokeOption) LookupHpcsResultOutput

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

    public static class GetHpcs 
{
    public static Task<GetHpcsResult> InvokeAsync(GetHpcsArgs args, InvokeOptions? opts = null)
    public static Output<GetHpcsResult> Invoke(GetHpcsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHpcsResult> getHpcs(GetHpcsArgs args, InvokeOptions options)
public static Output<GetHpcsResult> getHpcs(GetHpcsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getHpcs:getHpcs
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    Id string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    Location string
    The location for this Hyper Protect Crypto Services instance
    ResourceGroupId string
    The ID of the resource group.
    Service string
    (String) The service type hs-crypto of an instance.
    Name string
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    Id string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    Location string
    The location for this Hyper Protect Crypto Services instance
    ResourceGroupId string
    The ID of the resource group.
    Service string
    (String) The service type hs-crypto of an instance.
    name String
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    id String
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    location String
    The location for this Hyper Protect Crypto Services instance
    resourceGroupId String
    The ID of the resource group.
    service String
    (String) The service type hs-crypto of an instance.
    name string
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    id string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    location string
    The location for this Hyper Protect Crypto Services instance
    resourceGroupId string
    The ID of the resource group.
    service string
    (String) The service type hs-crypto of an instance.
    name str
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    id str
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    location str
    The location for this Hyper Protect Crypto Services instance
    resource_group_id str
    The ID of the resource group.
    service str
    (String) The service type hs-crypto of an instance.
    name String
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    id String
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    location String
    The location for this Hyper Protect Crypto Services instance
    resourceGroupId String
    The ID of the resource group.
    service String
    (String) The service type hs-crypto of an instance.

    getHpcs Result

    The following output properties are available:

    Crn string
    (String) The CRN of the Hyper Protect Crypto Services instance.
    Extensions Dictionary<string, string>
    (List) The extended metadata as a map associated with the resource instance.
    FailoverUnits double
    (Integer) The number of failover crypto units for your service instance.
    Guid string
    (String) Unique identifier of resource instance.
    HsmInfos List<GetHpcsHsmInfo>
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    Id string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    Location string
    Name string
    (String) Name of an admin.
    Plan string
    (String) The pricing plan for your service instance.
    ResourceGroupId string
    ServiceEndpoints string
    (String) The network access to your service instance. Possible values are public-and-private, private-only.
    Status string
    (String) Status of the Hyper Protect Crypto Services instance.
    Units double
    (Integer) The number of operational crypto units for your service instance.
    Service string
    (String) The service type hs-crypto of an instance.
    Crn string
    (String) The CRN of the Hyper Protect Crypto Services instance.
    Extensions map[string]string
    (List) The extended metadata as a map associated with the resource instance.
    FailoverUnits float64
    (Integer) The number of failover crypto units for your service instance.
    Guid string
    (String) Unique identifier of resource instance.
    HsmInfos []GetHpcsHsmInfo
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    Id string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    Location string
    Name string
    (String) Name of an admin.
    Plan string
    (String) The pricing plan for your service instance.
    ResourceGroupId string
    ServiceEndpoints string
    (String) The network access to your service instance. Possible values are public-and-private, private-only.
    Status string
    (String) Status of the Hyper Protect Crypto Services instance.
    Units float64
    (Integer) The number of operational crypto units for your service instance.
    Service string
    (String) The service type hs-crypto of an instance.
    crn String
    (String) The CRN of the Hyper Protect Crypto Services instance.
    extensions Map<String,String>
    (List) The extended metadata as a map associated with the resource instance.
    failoverUnits Double
    (Integer) The number of failover crypto units for your service instance.
    guid String
    (String) Unique identifier of resource instance.
    hsmInfos List<GetHpcsHsmInfo>
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    id String
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    location String
    name String
    (String) Name of an admin.
    plan String
    (String) The pricing plan for your service instance.
    resourceGroupId String
    serviceEndpoints String
    (String) The network access to your service instance. Possible values are public-and-private, private-only.
    status String
    (String) Status of the Hyper Protect Crypto Services instance.
    units Double
    (Integer) The number of operational crypto units for your service instance.
    service String
    (String) The service type hs-crypto of an instance.
    crn string
    (String) The CRN of the Hyper Protect Crypto Services instance.
    extensions {[key: string]: string}
    (List) The extended metadata as a map associated with the resource instance.
    failoverUnits number
    (Integer) The number of failover crypto units for your service instance.
    guid string
    (String) Unique identifier of resource instance.
    hsmInfos GetHpcsHsmInfo[]
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    id string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    location string
    name string
    (String) Name of an admin.
    plan string
    (String) The pricing plan for your service instance.
    resourceGroupId string
    serviceEndpoints string
    (String) The network access to your service instance. Possible values are public-and-private, private-only.
    status string
    (String) Status of the Hyper Protect Crypto Services instance.
    units number
    (Integer) The number of operational crypto units for your service instance.
    service string
    (String) The service type hs-crypto of an instance.
    crn str
    (String) The CRN of the Hyper Protect Crypto Services instance.
    extensions Mapping[str, str]
    (List) The extended metadata as a map associated with the resource instance.
    failover_units float
    (Integer) The number of failover crypto units for your service instance.
    guid str
    (String) Unique identifier of resource instance.
    hsm_infos Sequence[GetHpcsHsmInfo]
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    id str
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    location str
    name str
    (String) Name of an admin.
    plan str
    (String) The pricing plan for your service instance.
    resource_group_id str
    service_endpoints str
    (String) The network access to your service instance. Possible values are public-and-private, private-only.
    status str
    (String) Status of the Hyper Protect Crypto Services instance.
    units float
    (Integer) The number of operational crypto units for your service instance.
    service str
    (String) The service type hs-crypto of an instance.
    crn String
    (String) The CRN of the Hyper Protect Crypto Services instance.
    extensions Map<String>
    (List) The extended metadata as a map associated with the resource instance.
    failoverUnits Number
    (Integer) The number of failover crypto units for your service instance.
    guid String
    (String) Unique identifier of resource instance.
    hsmInfos List<Property Map>
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    id String
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    location String
    name String
    (String) Name of an admin.
    plan String
    (String) The pricing plan for your service instance.
    resourceGroupId String
    serviceEndpoints String
    (String) The network access to your service instance. Possible values are public-and-private, private-only.
    status String
    (String) Status of the Hyper Protect Crypto Services instance.
    units Number
    (Integer) The number of operational crypto units for your service instance.
    service String
    (String) The service type hs-crypto of an instance.

    Supporting Types

    GetHpcsHsmInfo

    Admins List<GetHpcsHsmInfoAdmin>
    (List) List of Admins for crypto units. Nested scheme for admins:
    CurrentMkStatus string
    (String) Status of current master key register.
    CurrentMkvp string
    (String) Current master key register verification pattern.
    HsmId string
    (String) The HSM ID.
    HsmLocation string
    (String) The HSM Location.
    HsmType string
    (String) The HSM Type.
    NewMkStatus string
    (String) Status of new master key register.
    NewMkvp string
    (String) New master key register verification pattern.
    RevocationThreshold double
    (Integer) Revocation threshold for crypto units.
    SignatureThreshold double
    (Integer) Signature threshold for crypto units.
    Admins []GetHpcsHsmInfoAdmin
    (List) List of Admins for crypto units. Nested scheme for admins:
    CurrentMkStatus string
    (String) Status of current master key register.
    CurrentMkvp string
    (String) Current master key register verification pattern.
    HsmId string
    (String) The HSM ID.
    HsmLocation string
    (String) The HSM Location.
    HsmType string
    (String) The HSM Type.
    NewMkStatus string
    (String) Status of new master key register.
    NewMkvp string
    (String) New master key register verification pattern.
    RevocationThreshold float64
    (Integer) Revocation threshold for crypto units.
    SignatureThreshold float64
    (Integer) Signature threshold for crypto units.
    admins List<GetHpcsHsmInfoAdmin>
    (List) List of Admins for crypto units. Nested scheme for admins:
    currentMkStatus String
    (String) Status of current master key register.
    currentMkvp String
    (String) Current master key register verification pattern.
    hsmId String
    (String) The HSM ID.
    hsmLocation String
    (String) The HSM Location.
    hsmType String
    (String) The HSM Type.
    newMkStatus String
    (String) Status of new master key register.
    newMkvp String
    (String) New master key register verification pattern.
    revocationThreshold Double
    (Integer) Revocation threshold for crypto units.
    signatureThreshold Double
    (Integer) Signature threshold for crypto units.
    admins GetHpcsHsmInfoAdmin[]
    (List) List of Admins for crypto units. Nested scheme for admins:
    currentMkStatus string
    (String) Status of current master key register.
    currentMkvp string
    (String) Current master key register verification pattern.
    hsmId string
    (String) The HSM ID.
    hsmLocation string
    (String) The HSM Location.
    hsmType string
    (String) The HSM Type.
    newMkStatus string
    (String) Status of new master key register.
    newMkvp string
    (String) New master key register verification pattern.
    revocationThreshold number
    (Integer) Revocation threshold for crypto units.
    signatureThreshold number
    (Integer) Signature threshold for crypto units.
    admins Sequence[GetHpcsHsmInfoAdmin]
    (List) List of Admins for crypto units. Nested scheme for admins:
    current_mk_status str
    (String) Status of current master key register.
    current_mkvp str
    (String) Current master key register verification pattern.
    hsm_id str
    (String) The HSM ID.
    hsm_location str
    (String) The HSM Location.
    hsm_type str
    (String) The HSM Type.
    new_mk_status str
    (String) Status of new master key register.
    new_mkvp str
    (String) New master key register verification pattern.
    revocation_threshold float
    (Integer) Revocation threshold for crypto units.
    signature_threshold float
    (Integer) Signature threshold for crypto units.
    admins List<Property Map>
    (List) List of Admins for crypto units. Nested scheme for admins:
    currentMkStatus String
    (String) Status of current master key register.
    currentMkvp String
    (String) Current master key register verification pattern.
    hsmId String
    (String) The HSM ID.
    hsmLocation String
    (String) The HSM Location.
    hsmType String
    (String) The HSM Type.
    newMkStatus String
    (String) Status of new master key register.
    newMkvp String
    (String) New master key register verification pattern.
    revocationThreshold Number
    (Integer) Revocation threshold for crypto units.
    signatureThreshold Number
    (Integer) Signature threshold for crypto units.

    GetHpcsHsmInfoAdmin

    Name string
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    Ski string
    (String) Subject key identifier of the administrator signature key.
    Name string
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    Ski string
    (String) Subject key identifier of the administrator signature key.
    name String
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    ski String
    (String) Subject key identifier of the administrator signature key.
    name string
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    ski string
    (String) Subject key identifier of the administrator signature key.
    name str
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    ski str
    (String) Subject key identifier of the administrator signature key.
    name String
    The name used to identify the Hyper Protect Crypto Services instance in the IBM Cloud UI.
    ski String
    (String) Subject key identifier of the administrator signature key.

    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
    ibm-cloud/terraform-provider-ibm