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

ibm.Hpcs

Explore with Pulumi AI

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

    Example Usage

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

const hpcs = new ibm.Hpcs("hpcs", {
    admins: [
        {
            key: "/cloudTKE/1.sigkey",
            name: "admin1",
            token: "<sensitive1234>",
        },
        {
            key: "/cloudTKE/2.sigkey",
            name: "admin2",
            token: "<sensitive1234>",
        },
    ],
    location: "us-south",
    plan: "standard",
    revocationThreshold: 1,
    signatureThreshold: 1,
    units: 2,
});

    import pulumi
import pulumi_ibm as ibm

hpcs = ibm.Hpcs("hpcs",
    admins=[
        {
            "key": "/cloudTKE/1.sigkey",
            "name": "admin1",
            "token": "<sensitive1234>",
        },
        {
            "key": "/cloudTKE/2.sigkey",
            "name": "admin2",
            "token": "<sensitive1234>",
        },
    ],
    location="us-south",
    plan="standard",
    revocation_threshold=1,
    signature_threshold=1,
    units=2)

    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.NewHpcs(ctx, "hpcs", &ibm.HpcsArgs{
			Admins: ibm.HpcsAdminArray{
				&ibm.HpcsAdminArgs{
					Key:   pulumi.String("/cloudTKE/1.sigkey"),
					Name:  pulumi.String("admin1"),
					Token: pulumi.String("<sensitive1234>"),
				},
				&ibm.HpcsAdminArgs{
					Key:   pulumi.String("/cloudTKE/2.sigkey"),
					Name:  pulumi.String("admin2"),
					Token: pulumi.String("<sensitive1234>"),
				},
			},
			Location:            pulumi.String("us-south"),
			Plan:                pulumi.String("standard"),
			RevocationThreshold: pulumi.Float64(1),
			SignatureThreshold:  pulumi.Float64(1),
			Units:               pulumi.Float64(2),
		})
		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 hpcs = new Ibm.Hpcs("hpcs", new()
    {
        Admins = new[]
        {
            new Ibm.Inputs.HpcsAdminArgs
            {
                Key = "/cloudTKE/1.sigkey",
                Name = "admin1",
                Token = "<sensitive1234>",
            },
            new Ibm.Inputs.HpcsAdminArgs
            {
                Key = "/cloudTKE/2.sigkey",
                Name = "admin2",
                Token = "<sensitive1234>",
            },
        },
        Location = "us-south",
        Plan = "standard",
        RevocationThreshold = 1,
        SignatureThreshold = 1,
        Units = 2,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.Hpcs;
import com.pulumi.ibm.HpcsArgs;
import com.pulumi.ibm.inputs.HpcsAdminArgs;
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 hpcs = new Hpcs("hpcs", HpcsArgs.builder()
            .admins(            
                HpcsAdminArgs.builder()
                    .key("/cloudTKE/1.sigkey")
                    .name("admin1")
                    .token("<sensitive1234>")
                    .build(),
                HpcsAdminArgs.builder()
                    .key("/cloudTKE/2.sigkey")
                    .name("admin2")
                    .token("<sensitive1234>")
                    .build())
            .location("us-south")
            .plan("standard")
            .revocationThreshold(1)
            .signatureThreshold(1)
            .units(2)
            .build());

    }
}

    resources:
  hpcs:
    type: ibm:Hpcs
    properties:
      admins:
        - key: /cloudTKE/1.sigkey
          name: admin1
          token: <sensitive1234>
        - key: /cloudTKE/2.sigkey
          name: admin2
          token: <sensitive1234>
      location: us-south
      plan: standard
      revocationThreshold: 1
      signatureThreshold: 1
      units: 2

    Create Hpcs Resource

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

    Constructor syntax

    new Hpcs(name: string, args: HpcsArgs, opts?: CustomResourceOptions);
    @overload
def Hpcs(resource_name: str,
         args: HpcsArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Hpcs(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         admins: Optional[Sequence[HpcsAdminArgs]] = None,
         units: Optional[float] = None,
         signature_threshold: Optional[float] = None,
         location: Optional[str] = None,
         revocation_threshold: Optional[float] = None,
         plan: Optional[str] = None,
         resource_group_id: Optional[str] = None,
         name: Optional[str] = None,
         service: Optional[str] = None,
         service_endpoints: Optional[str] = None,
         signature_server_url: Optional[str] = None,
         hpcs_id: Optional[str] = None,
         tags: Optional[Sequence[str]] = None,
         timeouts: Optional[HpcsTimeoutsArgs] = None,
         failover_units: Optional[float] = None)
    func NewHpcs(ctx *Context, name string, args HpcsArgs, opts ...ResourceOption) (*Hpcs, error)
    public Hpcs(string name, HpcsArgs args, CustomResourceOptions? opts = null)
    public Hpcs(String name, HpcsArgs args)
public Hpcs(String name, HpcsArgs args, CustomResourceOptions options)

    type: ibm:Hpcs
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 HpcsArgs
    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 HpcsArgs
    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 HpcsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HpcsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HpcsArgs
    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 hpcsResource = new Ibm.Hpcs("hpcsResource", new()
{
    Admins = new[]
    {
        new Ibm.Inputs.HpcsAdminArgs
        {
            Key = "string",
            Name = "string",
            Token = "string",
        },
    },
    Units = 0,
    SignatureThreshold = 0,
    Location = "string",
    RevocationThreshold = 0,
    Plan = "string",
    ResourceGroupId = "string",
    Name = "string",
    Service = "string",
    ServiceEndpoints = "string",
    SignatureServerUrl = "string",
    HpcsId = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.HpcsTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    FailoverUnits = 0,
});

    example, err := ibm.NewHpcs(ctx, "hpcsResource", &ibm.HpcsArgs{
	Admins: ibm.HpcsAdminArray{
		&ibm.HpcsAdminArgs{
			Key:   pulumi.String("string"),
			Name:  pulumi.String("string"),
			Token: pulumi.String("string"),
		},
	},
	Units:               pulumi.Float64(0),
	SignatureThreshold:  pulumi.Float64(0),
	Location:            pulumi.String("string"),
	RevocationThreshold: pulumi.Float64(0),
	Plan:                pulumi.String("string"),
	ResourceGroupId:     pulumi.String("string"),
	Name:                pulumi.String("string"),
	Service:             pulumi.String("string"),
	ServiceEndpoints:    pulumi.String("string"),
	SignatureServerUrl:  pulumi.String("string"),
	HpcsId:              pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.HpcsTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	FailoverUnits: pulumi.Float64(0),
})

    var hpcsResource = new Hpcs("hpcsResource", HpcsArgs.builder()
    .admins(HpcsAdminArgs.builder()
        .key("string")
        .name("string")
        .token("string")
        .build())
    .units(0)
    .signatureThreshold(0)
    .location("string")
    .revocationThreshold(0)
    .plan("string")
    .resourceGroupId("string")
    .name("string")
    .service("string")
    .serviceEndpoints("string")
    .signatureServerUrl("string")
    .hpcsId("string")
    .tags("string")
    .timeouts(HpcsTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .failoverUnits(0)
    .build());

    hpcs_resource = ibm.Hpcs("hpcsResource",
    admins=[{
        "key": "string",
        "name": "string",
        "token": "string",
    }],
    units=0,
    signature_threshold=0,
    location="string",
    revocation_threshold=0,
    plan="string",
    resource_group_id="string",
    name="string",
    service="string",
    service_endpoints="string",
    signature_server_url="string",
    hpcs_id="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    failover_units=0)

    const hpcsResource = new ibm.Hpcs("hpcsResource", {
    admins: [{
        key: "string",
        name: "string",
        token: "string",
    }],
    units: 0,
    signatureThreshold: 0,
    location: "string",
    revocationThreshold: 0,
    plan: "string",
    resourceGroupId: "string",
    name: "string",
    service: "string",
    serviceEndpoints: "string",
    signatureServerUrl: "string",
    hpcsId: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    failoverUnits: 0,
});

    type: ibm:Hpcs
properties:
    admins:
        - key: string
          name: string
          token: string
    failoverUnits: 0
    hpcsId: string
    location: string
    name: string
    plan: string
    resourceGroupId: string
    revocationThreshold: 0
    service: string
    serviceEndpoints: string
    signatureServerUrl: string
    signatureThreshold: 0
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
    units: 0

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

    Admins List<HpcsAdmin>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    Location string
    The location where the HPCS instance available
    Plan string
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    RevocationThreshold double
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    SignatureThreshold double
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    Units double
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    FailoverUnits double
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    HpcsId string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    Name string
    The name of your Hyper Protect Crypto Services instance.
    ResourceGroupId string
    The ID of resource group where you want to organize and manage your service instance.
    Service string
    (String) The service type (hs-crypto) of the instance.
    ServiceEndpoints string
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    SignatureServerUrl string

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    Tags List<string>
    Tags that are associated with your instance are used to organize your resources.
    Timeouts HpcsTimeouts
    Admins []HpcsAdminArgs
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    Location string
    The location where the HPCS instance available
    Plan string
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    RevocationThreshold float64
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    SignatureThreshold float64
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    Units float64
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    FailoverUnits float64
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    HpcsId string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    Name string
    The name of your Hyper Protect Crypto Services instance.
    ResourceGroupId string
    The ID of resource group where you want to organize and manage your service instance.
    Service string
    (String) The service type (hs-crypto) of the instance.
    ServiceEndpoints string
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    SignatureServerUrl string

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    Tags []string
    Tags that are associated with your instance are used to organize your resources.
    Timeouts HpcsTimeoutsArgs
    admins List<HpcsAdmin>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    location String
    The location where the HPCS instance available
    plan String
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    revocationThreshold Double
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    signatureThreshold Double
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    units Double
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    failoverUnits Double
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    hpcsId String
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    name String
    The name of your Hyper Protect Crypto Services instance.
    resourceGroupId String
    The ID of resource group where you want to organize and manage your service instance.
    service String
    (String) The service type (hs-crypto) of the instance.
    serviceEndpoints String
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    signatureServerUrl String

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    tags List<String>
    Tags that are associated with your instance are used to organize your resources.
    timeouts HpcsTimeouts
    admins HpcsAdmin[]
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    location string
    The location where the HPCS instance available
    plan string
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    revocationThreshold number
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    signatureThreshold number
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    units number
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    failoverUnits number
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    hpcsId string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    name string
    The name of your Hyper Protect Crypto Services instance.
    resourceGroupId string
    The ID of resource group where you want to organize and manage your service instance.
    service string
    (String) The service type (hs-crypto) of the instance.
    serviceEndpoints string
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    signatureServerUrl string

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    tags string[]
    Tags that are associated with your instance are used to organize your resources.
    timeouts HpcsTimeouts
    admins Sequence[HpcsAdminArgs]
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    location str
    The location where the HPCS instance available
    plan str
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    revocation_threshold float
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    signature_threshold float
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    units float
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    failover_units float
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    hpcs_id str
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    name str
    The name of your Hyper Protect Crypto Services instance.
    resource_group_id str
    The ID of resource group where you want to organize and manage your service instance.
    service str
    (String) The service type (hs-crypto) of the instance.
    service_endpoints str
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    signature_server_url str

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    tags Sequence[str]
    Tags that are associated with your instance are used to organize your resources.
    timeouts HpcsTimeoutsArgs
    admins List<Property Map>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    location String
    The location where the HPCS instance available
    plan String
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    revocationThreshold Number
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    signatureThreshold Number
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    units Number
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    failoverUnits Number
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    hpcsId String
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    name String
    The name of your Hyper Protect Crypto Services instance.
    resourceGroupId String
    The ID of resource group where you want to organize and manage your service instance.
    service String
    (String) The service type (hs-crypto) of the instance.
    serviceEndpoints String
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    signatureServerUrl String

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    tags List<String>
    Tags that are associated with your instance are used to organize your resources.
    timeouts Property Map

    Outputs

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

    CreatedAt string
    (String) The date when the instance was created.
    CreatedBy string
    (String) The subject who created the instance.
    Crn string
    (String) CRN of the Hyper Protect Crypto Services instance.
    DashboardUrl string
    Dashboard URL to access resource.
    DeletedAt string
    (String) The date when the instance was deleted.
    DeletedBy string
    (String) The subject who deleted the instance.
    Extensions Dictionary<string, string>
    (List) The extended metadata as a map associated with the resource instance.
    Guid string
    (String) Unique identifier of resource instance.
    HsmInfos List<HpcsHsmInfo>
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceAliasesUrl string
    (String) The relative path to the resource aliases for the instance.
    ResourceBindingsUrl string
    (String) The relative path to the resource bindings for the instance.
    ResourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    RestoredAt string
    (String) The date when the instance under reclamation was restored.
    RestoredBy string
    (String) The subject who restored the instance back from reclamation.
    ScheduledReclaimAt string
    (String) The date when the instance was scheduled for reclamation.
    ScheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    State string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    Status string
    (String) Status of the hpcs instance.
    UpdateAt string
    (String) The date when the instance was last updated.
    UpdateBy string
    (String) The subject who updated the instance.
    CreatedAt string
    (String) The date when the instance was created.
    CreatedBy string
    (String) The subject who created the instance.
    Crn string
    (String) CRN of the Hyper Protect Crypto Services instance.
    DashboardUrl string
    Dashboard URL to access resource.
    DeletedAt string
    (String) The date when the instance was deleted.
    DeletedBy string
    (String) The subject who deleted the instance.
    Extensions map[string]string
    (List) The extended metadata as a map associated with the resource instance.
    Guid string
    (String) Unique identifier of resource instance.
    HsmInfos []HpcsHsmInfo
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceAliasesUrl string
    (String) The relative path to the resource aliases for the instance.
    ResourceBindingsUrl string
    (String) The relative path to the resource bindings for the instance.
    ResourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    RestoredAt string
    (String) The date when the instance under reclamation was restored.
    RestoredBy string
    (String) The subject who restored the instance back from reclamation.
    ScheduledReclaimAt string
    (String) The date when the instance was scheduled for reclamation.
    ScheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    State string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    Status string
    (String) Status of the hpcs instance.
    UpdateAt string
    (String) The date when the instance was last updated.
    UpdateBy string
    (String) The subject who updated the instance.
    createdAt String
    (String) The date when the instance was created.
    createdBy String
    (String) The subject who created the instance.
    crn String
    (String) CRN of the Hyper Protect Crypto Services instance.
    dashboardUrl String
    Dashboard URL to access resource.
    deletedAt String
    (String) The date when the instance was deleted.
    deletedBy String
    (String) The subject who deleted the instance.
    extensions Map<String,String>
    (List) The extended metadata as a map associated with the resource instance.
    guid String
    (String) Unique identifier of resource instance.
    hsmInfos List<HpcsHsmInfo>
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceAliasesUrl String
    (String) The relative path to the resource aliases for the instance.
    resourceBindingsUrl String
    (String) The relative path to the resource bindings for the instance.
    resourceKeysUrl String
    (String) The relative path to the resource keys for the instance.
    restoredAt String
    (String) The date when the instance under reclamation was restored.
    restoredBy String
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt String
    (String) The date when the instance was scheduled for reclamation.
    scheduledReclaimBy String
    (String) The subject who initiated the instance reclamation.
    state String
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status String
    (String) Status of the hpcs instance.
    updateAt String
    (String) The date when the instance was last updated.
    updateBy String
    (String) The subject who updated the instance.
    createdAt string
    (String) The date when the instance was created.
    createdBy string
    (String) The subject who created the instance.
    crn string
    (String) CRN of the Hyper Protect Crypto Services instance.
    dashboardUrl string
    Dashboard URL to access resource.
    deletedAt string
    (String) The date when the instance was deleted.
    deletedBy string
    (String) The subject who deleted the instance.
    extensions {[key: string]: string}
    (List) The extended metadata as a map associated with the resource instance.
    guid string
    (String) Unique identifier of resource instance.
    hsmInfos HpcsHsmInfo[]
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    id string
    The provider-assigned unique ID for this managed resource.
    resourceAliasesUrl string
    (String) The relative path to the resource aliases for the instance.
    resourceBindingsUrl string
    (String) The relative path to the resource bindings for the instance.
    resourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    restoredAt string
    (String) The date when the instance under reclamation was restored.
    restoredBy string
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt string
    (String) The date when the instance was scheduled for reclamation.
    scheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    state string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status string
    (String) Status of the hpcs instance.
    updateAt string
    (String) The date when the instance was last updated.
    updateBy string
    (String) The subject who updated the instance.
    created_at str
    (String) The date when the instance was created.
    created_by str
    (String) The subject who created the instance.
    crn str
    (String) CRN of the Hyper Protect Crypto Services instance.
    dashboard_url str
    Dashboard URL to access resource.
    deleted_at str
    (String) The date when the instance was deleted.
    deleted_by str
    (String) The subject who deleted the instance.
    extensions Mapping[str, str]
    (List) The extended metadata as a map associated with the resource instance.
    guid str
    (String) Unique identifier of resource instance.
    hsm_infos Sequence[HpcsHsmInfo]
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    id str
    The provider-assigned unique ID for this managed resource.
    resource_aliases_url str
    (String) The relative path to the resource aliases for the instance.
    resource_bindings_url str
    (String) The relative path to the resource bindings for the instance.
    resource_keys_url str
    (String) The relative path to the resource keys for the instance.
    restored_at str
    (String) The date when the instance under reclamation was restored.
    restored_by str
    (String) The subject who restored the instance back from reclamation.
    scheduled_reclaim_at str
    (String) The date when the instance was scheduled for reclamation.
    scheduled_reclaim_by str
    (String) The subject who initiated the instance reclamation.
    state str
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status str
    (String) Status of the hpcs instance.
    update_at str
    (String) The date when the instance was last updated.
    update_by str
    (String) The subject who updated the instance.
    createdAt String
    (String) The date when the instance was created.
    createdBy String
    (String) The subject who created the instance.
    crn String
    (String) CRN of the Hyper Protect Crypto Services instance.
    dashboardUrl String
    Dashboard URL to access resource.
    deletedAt String
    (String) The date when the instance was deleted.
    deletedBy String
    (String) The subject who deleted the instance.
    extensions Map<String>
    (List) The extended metadata as a map associated with the resource 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
    The provider-assigned unique ID for this managed resource.
    resourceAliasesUrl String
    (String) The relative path to the resource aliases for the instance.
    resourceBindingsUrl String
    (String) The relative path to the resource bindings for the instance.
    resourceKeysUrl String
    (String) The relative path to the resource keys for the instance.
    restoredAt String
    (String) The date when the instance under reclamation was restored.
    restoredBy String
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt String
    (String) The date when the instance was scheduled for reclamation.
    scheduledReclaimBy String
    (String) The subject who initiated the instance reclamation.
    state String
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status String
    (String) Status of the hpcs instance.
    updateAt String
    (String) The date when the instance was last updated.
    updateBy String
    (String) The subject who updated the instance.

    Look up Existing Hpcs Resource

    Get an existing Hpcs 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?: HpcsState, opts?: CustomResourceOptions): Hpcs
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admins: Optional[Sequence[HpcsAdminArgs]] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        crn: Optional[str] = None,
        dashboard_url: Optional[str] = None,
        deleted_at: Optional[str] = None,
        deleted_by: Optional[str] = None,
        extensions: Optional[Mapping[str, str]] = None,
        failover_units: Optional[float] = None,
        guid: Optional[str] = None,
        hpcs_id: Optional[str] = None,
        hsm_infos: Optional[Sequence[HpcsHsmInfoArgs]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        plan: Optional[str] = None,
        resource_aliases_url: Optional[str] = None,
        resource_bindings_url: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_keys_url: Optional[str] = None,
        restored_at: Optional[str] = None,
        restored_by: Optional[str] = None,
        revocation_threshold: Optional[float] = None,
        scheduled_reclaim_at: Optional[str] = None,
        scheduled_reclaim_by: Optional[str] = None,
        service: Optional[str] = None,
        service_endpoints: Optional[str] = None,
        signature_server_url: Optional[str] = None,
        signature_threshold: Optional[float] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[HpcsTimeoutsArgs] = None,
        units: Optional[float] = None,
        update_at: Optional[str] = None,
        update_by: Optional[str] = None) -> Hpcs
    func GetHpcs(ctx *Context, name string, id IDInput, state *HpcsState, opts ...ResourceOption) (*Hpcs, error)
    public static Hpcs Get(string name, Input<string> id, HpcsState? state, CustomResourceOptions? opts = null)
    public static Hpcs get(String name, Output<String> id, HpcsState state, CustomResourceOptions options)
    resources:  _:    type: ibm:Hpcs    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:
    Admins List<HpcsAdmin>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    CreatedAt string
    (String) The date when the instance was created.
    CreatedBy string
    (String) The subject who created the instance.
    Crn string
    (String) CRN of the Hyper Protect Crypto Services instance.
    DashboardUrl string
    Dashboard URL to access resource.
    DeletedAt string
    (String) The date when the instance was deleted.
    DeletedBy string
    (String) The subject who deleted the instance.
    Extensions Dictionary<string, string>
    (List) The extended metadata as a map associated with the resource instance.
    FailoverUnits double
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    Guid string
    (String) Unique identifier of resource instance.
    HpcsId string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    HsmInfos List<HpcsHsmInfo>
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    Location string
    The location where the HPCS instance available
    Name string
    The name of your Hyper Protect Crypto Services instance.
    Plan string
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    ResourceAliasesUrl string
    (String) The relative path to the resource aliases for the instance.
    ResourceBindingsUrl string
    (String) The relative path to the resource bindings for the instance.
    ResourceGroupId string
    The ID of resource group where you want to organize and manage your service instance.
    ResourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    RestoredAt string
    (String) The date when the instance under reclamation was restored.
    RestoredBy string
    (String) The subject who restored the instance back from reclamation.
    RevocationThreshold double
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    ScheduledReclaimAt string
    (String) The date when the instance was scheduled for reclamation.
    ScheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    Service string
    (String) The service type (hs-crypto) of the instance.
    ServiceEndpoints string
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    SignatureServerUrl string

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    SignatureThreshold double
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    State string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    Status string
    (String) Status of the hpcs instance.
    Tags List<string>
    Tags that are associated with your instance are used to organize your resources.
    Timeouts HpcsTimeouts
    Units double
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    UpdateAt string
    (String) The date when the instance was last updated.
    UpdateBy string
    (String) The subject who updated the instance.
    Admins []HpcsAdminArgs
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    CreatedAt string
    (String) The date when the instance was created.
    CreatedBy string
    (String) The subject who created the instance.
    Crn string
    (String) CRN of the Hyper Protect Crypto Services instance.
    DashboardUrl string
    Dashboard URL to access resource.
    DeletedAt string
    (String) The date when the instance was deleted.
    DeletedBy string
    (String) The subject who deleted the instance.
    Extensions map[string]string
    (List) The extended metadata as a map associated with the resource instance.
    FailoverUnits float64
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    Guid string
    (String) Unique identifier of resource instance.
    HpcsId string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    HsmInfos []HpcsHsmInfoArgs
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    Location string
    The location where the HPCS instance available
    Name string
    The name of your Hyper Protect Crypto Services instance.
    Plan string
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    ResourceAliasesUrl string
    (String) The relative path to the resource aliases for the instance.
    ResourceBindingsUrl string
    (String) The relative path to the resource bindings for the instance.
    ResourceGroupId string
    The ID of resource group where you want to organize and manage your service instance.
    ResourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    RestoredAt string
    (String) The date when the instance under reclamation was restored.
    RestoredBy string
    (String) The subject who restored the instance back from reclamation.
    RevocationThreshold float64
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    ScheduledReclaimAt string
    (String) The date when the instance was scheduled for reclamation.
    ScheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    Service string
    (String) The service type (hs-crypto) of the instance.
    ServiceEndpoints string
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    SignatureServerUrl string

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    SignatureThreshold float64
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    State string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    Status string
    (String) Status of the hpcs instance.
    Tags []string
    Tags that are associated with your instance are used to organize your resources.
    Timeouts HpcsTimeoutsArgs
    Units float64
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    UpdateAt string
    (String) The date when the instance was last updated.
    UpdateBy string
    (String) The subject who updated the instance.
    admins List<HpcsAdmin>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    createdAt String
    (String) The date when the instance was created.
    createdBy String
    (String) The subject who created the instance.
    crn String
    (String) CRN of the Hyper Protect Crypto Services instance.
    dashboardUrl String
    Dashboard URL to access resource.
    deletedAt String
    (String) The date when the instance was deleted.
    deletedBy String
    (String) The subject who deleted the instance.
    extensions Map<String,String>
    (List) The extended metadata as a map associated with the resource instance.
    failoverUnits Double
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    guid String
    (String) Unique identifier of resource instance.
    hpcsId String
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    hsmInfos List<HpcsHsmInfo>
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    location String
    The location where the HPCS instance available
    name String
    The name of your Hyper Protect Crypto Services instance.
    plan String
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    resourceAliasesUrl String
    (String) The relative path to the resource aliases for the instance.
    resourceBindingsUrl String
    (String) The relative path to the resource bindings for the instance.
    resourceGroupId String
    The ID of resource group where you want to organize and manage your service instance.
    resourceKeysUrl String
    (String) The relative path to the resource keys for the instance.
    restoredAt String
    (String) The date when the instance under reclamation was restored.
    restoredBy String
    (String) The subject who restored the instance back from reclamation.
    revocationThreshold Double
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    scheduledReclaimAt String
    (String) The date when the instance was scheduled for reclamation.
    scheduledReclaimBy String
    (String) The subject who initiated the instance reclamation.
    service String
    (String) The service type (hs-crypto) of the instance.
    serviceEndpoints String
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    signatureServerUrl String

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    signatureThreshold Double
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    state String
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status String
    (String) Status of the hpcs instance.
    tags List<String>
    Tags that are associated with your instance are used to organize your resources.
    timeouts HpcsTimeouts
    units Double
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    updateAt String
    (String) The date when the instance was last updated.
    updateBy String
    (String) The subject who updated the instance.
    admins HpcsAdmin[]
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    createdAt string
    (String) The date when the instance was created.
    createdBy string
    (String) The subject who created the instance.
    crn string
    (String) CRN of the Hyper Protect Crypto Services instance.
    dashboardUrl string
    Dashboard URL to access resource.
    deletedAt string
    (String) The date when the instance was deleted.
    deletedBy string
    (String) The subject who deleted the instance.
    extensions {[key: string]: string}
    (List) The extended metadata as a map associated with the resource instance.
    failoverUnits number
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    guid string
    (String) Unique identifier of resource instance.
    hpcsId string
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    hsmInfos HpcsHsmInfo[]
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    location string
    The location where the HPCS instance available
    name string
    The name of your Hyper Protect Crypto Services instance.
    plan string
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    resourceAliasesUrl string
    (String) The relative path to the resource aliases for the instance.
    resourceBindingsUrl string
    (String) The relative path to the resource bindings for the instance.
    resourceGroupId string
    The ID of resource group where you want to organize and manage your service instance.
    resourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    restoredAt string
    (String) The date when the instance under reclamation was restored.
    restoredBy string
    (String) The subject who restored the instance back from reclamation.
    revocationThreshold number
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    scheduledReclaimAt string
    (String) The date when the instance was scheduled for reclamation.
    scheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    service string
    (String) The service type (hs-crypto) of the instance.
    serviceEndpoints string
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    signatureServerUrl string

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    signatureThreshold number
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    state string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status string
    (String) Status of the hpcs instance.
    tags string[]
    Tags that are associated with your instance are used to organize your resources.
    timeouts HpcsTimeouts
    units number
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    updateAt string
    (String) The date when the instance was last updated.
    updateBy string
    (String) The subject who updated the instance.
    admins Sequence[HpcsAdminArgs]
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    created_at str
    (String) The date when the instance was created.
    created_by str
    (String) The subject who created the instance.
    crn str
    (String) CRN of the Hyper Protect Crypto Services instance.
    dashboard_url str
    Dashboard URL to access resource.
    deleted_at str
    (String) The date when the instance was deleted.
    deleted_by str
    (String) The subject who deleted the instance.
    extensions Mapping[str, str]
    (List) The extended metadata as a map associated with the resource instance.
    failover_units float
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    guid str
    (String) Unique identifier of resource instance.
    hpcs_id str
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    hsm_infos Sequence[HpcsHsmInfoArgs]
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    location str
    The location where the HPCS instance available
    name str
    The name of your Hyper Protect Crypto Services instance.
    plan str
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    resource_aliases_url str
    (String) The relative path to the resource aliases for the instance.
    resource_bindings_url str
    (String) The relative path to the resource bindings for the instance.
    resource_group_id str
    The ID of resource group where you want to organize and manage your service instance.
    resource_keys_url str
    (String) The relative path to the resource keys for the instance.
    restored_at str
    (String) The date when the instance under reclamation was restored.
    restored_by str
    (String) The subject who restored the instance back from reclamation.
    revocation_threshold float
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    scheduled_reclaim_at str
    (String) The date when the instance was scheduled for reclamation.
    scheduled_reclaim_by str
    (String) The subject who initiated the instance reclamation.
    service str
    (String) The service type (hs-crypto) of the instance.
    service_endpoints str
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    signature_server_url str

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    signature_threshold float
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    state str
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status str
    (String) Status of the hpcs instance.
    tags Sequence[str]
    Tags that are associated with your instance are used to organize your resources.
    timeouts HpcsTimeoutsArgs
    units float
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    update_at str
    (String) The date when the instance was last updated.
    update_by str
    (String) The subject who updated the instance.
    admins List<Property Map>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: Nested scheme for admins:
    createdAt String
    (String) The date when the instance was created.
    createdBy String
    (String) The subject who created the instance.
    crn String
    (String) CRN of the Hyper Protect Crypto Services instance.
    dashboardUrl String
    Dashboard URL to access resource.
    deletedAt String
    (String) The date when the instance was deleted.
    deletedBy String
    (String) The subject who deleted the instance.
    extensions Map<String>
    (List) The extended metadata as a map associated with the resource instance.
    failoverUnits Number
    The number of failover crypto units for your service instance. Valid values are 0, 2, or 3, and it must be less than or equal to the number of operational crypto units. If you set it 0, cross-region high availability will not be enabled. Currently, you can enable this option only in the us-south and us-east region. If you do not specify the value, the default value is 0.
    guid String
    (String) Unique identifier of resource instance.
    hpcsId String
    (String) The unique identifier CRN of this Hyper Protect Crypto Services instance.
    hsmInfos List<Property Map>
    (List) HSM config of the crypto units. Nested scheme for hsm_info:
    location String
    The location where the HPCS instance available
    name String
    The name of your Hyper Protect Crypto Services instance.
    plan String
    The pricing plan for your service instance. Currently, only the standard plan is supportd.
    resourceAliasesUrl String
    (String) The relative path to the resource aliases for the instance.
    resourceBindingsUrl String
    (String) The relative path to the resource bindings for the instance.
    resourceGroupId String
    The ID of resource group where you want to organize and manage your service instance.
    resourceKeysUrl String
    (String) The relative path to the resource keys for the instance.
    restoredAt String
    (String) The date when the instance under reclamation was restored.
    restoredBy String
    (String) The subject who restored the instance back from reclamation.
    revocationThreshold Number
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    scheduledReclaimAt String
    (String) The date when the instance was scheduled for reclamation.
    scheduledReclaimBy String
    (String) The subject who initiated the instance reclamation.
    service String
    (String) The service type (hs-crypto) of the instance.
    serviceEndpoints String
    The network access to your service instance. Valid values are public-and-private and private-only. If you do not specify the value, the default setting is public-and-private.
    signatureServerUrl String

    The URL and port number where the signing service is running. If you are using a third-party signing service to provide administrator signature keys, you need to specify this parameter.

    Note: If you manage multiple service instances in the main.tf file, make sure to set the same signature_server_url parameter for each instance. Otherwise, you will not be able to perform the actions successfully.

    signatureThreshold Number
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    state String
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status String
    (String) Status of the hpcs instance.
    tags List<String>
    Tags that are associated with your instance are used to organize your resources.
    timeouts Property Map
    units Number
    The number of operational crypto units for your service instance. Valid values are 2 and 3.
    updateAt String
    (String) The date when the instance was last updated.
    updateBy String
    (String) The subject who updated the instance.

    Supporting Types

    HpcsAdmin, HpcsAdminArgs

    Key string

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the absolute path and the file name of the signature key file that is to be used.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the name of the signature key depending on the signing service definition. The character string for the key name is appended to a URI that is sent to the signing service and must contain only unreserved characters as defined by section 2.3 of RFC3986.

    Name string
    The name of the administrator. It needs to be no more than 30 characters in length.
    Token string

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the administrator password to access the corresponding signature key file.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the token that authorizes use of the signature key depending on the signing service definition.

    Key string

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the absolute path and the file name of the signature key file that is to be used.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the name of the signature key depending on the signing service definition. The character string for the key name is appended to a URI that is sent to the signing service and must contain only unreserved characters as defined by section 2.3 of RFC3986.

    Name string
    The name of the administrator. It needs to be no more than 30 characters in length.
    Token string

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the administrator password to access the corresponding signature key file.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the token that authorizes use of the signature key depending on the signing service definition.

    key String

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the absolute path and the file name of the signature key file that is to be used.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the name of the signature key depending on the signing service definition. The character string for the key name is appended to a URI that is sent to the signing service and must contain only unreserved characters as defined by section 2.3 of RFC3986.

    name String
    The name of the administrator. It needs to be no more than 30 characters in length.
    token String

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the administrator password to access the corresponding signature key file.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the token that authorizes use of the signature key depending on the signing service definition.

    key string

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the absolute path and the file name of the signature key file that is to be used.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the name of the signature key depending on the signing service definition. The character string for the key name is appended to a URI that is sent to the signing service and must contain only unreserved characters as defined by section 2.3 of RFC3986.

    name string
    The name of the administrator. It needs to be no more than 30 characters in length.
    token string

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the administrator password to access the corresponding signature key file.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the token that authorizes use of the signature key depending on the signing service definition.

    key str

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the absolute path and the file name of the signature key file that is to be used.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the name of the signature key depending on the signing service definition. The character string for the key name is appended to a URI that is sent to the signing service and must contain only unreserved characters as defined by section 2.3 of RFC3986.

    name str
    The name of the administrator. It needs to be no more than 30 characters in length.
    token str

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the administrator password to access the corresponding signature key file.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the token that authorizes use of the signature key depending on the signing service definition.

    key String

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the absolute path and the file name of the signature key file that is to be used.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the name of the signature key depending on the signing service definition. The character string for the key name is appended to a URI that is sent to the signing service and must contain only unreserved characters as defined by section 2.3 of RFC3986.

    name String
    The name of the administrator. It needs to be no more than 30 characters in length.
    token String

    If you are using signature key files on the local workstation that are created by the TKE CLI plug-in and are not using a third-party signing service, specify the administrator password to access the corresponding signature key file.

    Note: If you are using a signing service (signature_server_url) to provide signature keys, specify the token that authorizes use of the signature key depending on the signing service definition.

    HpcsHsmInfo, HpcsHsmInfoArgs

    Admins List<HpcsHsmInfoAdmin>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: 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) HSM ID.
    HsmLocation string
    (String) HSM Location.
    HsmType string
    (String) HSM Type.
    NewMkStatus string
    (String) Status of New Master Key Register.
    NewMkvp string
    (String) New Master Key Register Verification Pattern.
    RevocationThreshold double
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    SignatureThreshold double
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    Admins []HpcsHsmInfoAdmin
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: 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) HSM ID.
    HsmLocation string
    (String) HSM Location.
    HsmType string
    (String) HSM Type.
    NewMkStatus string
    (String) Status of New Master Key Register.
    NewMkvp string
    (String) New Master Key Register Verification Pattern.
    RevocationThreshold float64
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    SignatureThreshold float64
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    admins List<HpcsHsmInfoAdmin>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: 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) HSM ID.
    hsmLocation String
    (String) HSM Location.
    hsmType String
    (String) HSM Type.
    newMkStatus String
    (String) Status of New Master Key Register.
    newMkvp String
    (String) New Master Key Register Verification Pattern.
    revocationThreshold Double
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    signatureThreshold Double
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    admins HpcsHsmInfoAdmin[]
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: 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) HSM ID.
    hsmLocation string
    (String) HSM Location.
    hsmType string
    (String) HSM Type.
    newMkStatus string
    (String) Status of New Master Key Register.
    newMkvp string
    (String) New Master Key Register Verification Pattern.
    revocationThreshold number
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    signatureThreshold number
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    admins Sequence[HpcsHsmInfoAdmin]
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: 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) HSM ID.
    hsm_location str
    (String) HSM Location.
    hsm_type str
    (String) 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
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    signature_threshold float
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.
    admins List<Property Map>
    The list of administrators for the instance crypto units. You can set up to 8 administrators and the number needs to be equal to or greater than the thresholds that you specify. The following values need to be set for each administrator: 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) HSM ID.
    hsmLocation String
    (String) HSM Location.
    hsmType String
    (String) HSM Type.
    newMkStatus String
    (String) Status of New Master Key Register.
    newMkvp String
    (String) New Master Key Register Verification Pattern.
    revocationThreshold Number
    The number of administrator signatures that is required to remove an administrator after you leave imprint mode. The valid value is between 1 and 8.
    signatureThreshold Number
    The number of administrator signatures that is required to execute administrative commands. The valid value is between 1 and 8. You need to set it to at least 2 to enable quorum authentication.

    HpcsHsmInfoAdmin, HpcsHsmInfoAdminArgs

    Name string
    The name of the administrator. It needs to be no more than 30 characters in length.
    Ski string
    (String) Subject Key Identifier of the administrator signature key.
    Name string
    The name of the administrator. It needs to be no more than 30 characters in length.
    Ski string
    (String) Subject Key Identifier of the administrator signature key.
    name String
    The name of the administrator. It needs to be no more than 30 characters in length.
    ski String
    (String) Subject Key Identifier of the administrator signature key.
    name string
    The name of the administrator. It needs to be no more than 30 characters in length.
    ski string
    (String) Subject Key Identifier of the administrator signature key.
    name str
    The name of the administrator. It needs to be no more than 30 characters in length.
    ski str
    (String) Subject Key Identifier of the administrator signature key.
    name String
    The name of the administrator. It needs to be no more than 30 characters in length.
    ski String
    (String) Subject Key Identifier of the administrator signature key.

    HpcsTimeouts, HpcsTimeoutsArgs

    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

    Import

    The ibm_hpcs can be imported by using the crn.

    bash

    $ pulumi import ibm:index/hpcs:Hpcs hpcs <crn>

    Example

    $ pulumi import ibm:index/hpcs:Hpcs hpcs crn:v1:bluemix:public:hs-crypto:us-south:a/4448261269a14562b839e0a3019ed980:f115115b-5087-4a4e-9cc8-71acf0542c0d::

    To learn more about importing existing cloud resources, see Importing resources.

    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