Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getHpcsKeyTemplate
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getHpcsKeyTemplate

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

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

    Example Usage

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

const keyTemplate = ibm.getHpcsKeyTemplate({
    instanceId: "76195d24-8a31-4c6d-9050-c35f09375cfb",
    region: "us-east",
    templateId: "d8cc1ef7-d13b-4731-95be-1f7c98c9f524",
    ukoVault: ibm_hpcs_vault.vault.vault_id,
});

    import pulumi
import pulumi_ibm as ibm

key_template = ibm.get_hpcs_key_template(instance_id="76195d24-8a31-4c6d-9050-c35f09375cfb",
    region="us-east",
    template_id="d8cc1ef7-d13b-4731-95be-1f7c98c9f524",
    uko_vault=ibm_hpcs_vault["vault"]["vault_id"])

    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.LookupHpcsKeyTemplate(ctx, &ibm.LookupHpcsKeyTemplateArgs{
			InstanceId: "76195d24-8a31-4c6d-9050-c35f09375cfb",
			Region:     "us-east",
			TemplateId: "d8cc1ef7-d13b-4731-95be-1f7c98c9f524",
			UkoVault:   ibm_hpcs_vault.Vault.Vault_id,
		}, 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 keyTemplate = Ibm.GetHpcsKeyTemplate.Invoke(new()
    {
        InstanceId = "76195d24-8a31-4c6d-9050-c35f09375cfb",
        Region = "us-east",
        TemplateId = "d8cc1ef7-d13b-4731-95be-1f7c98c9f524",
        UkoVault = ibm_hpcs_vault.Vault.Vault_id,
    });

});

    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.GetHpcsKeyTemplateArgs;
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 keyTemplate = IbmFunctions.getHpcsKeyTemplate(GetHpcsKeyTemplateArgs.builder()
            .instanceId("76195d24-8a31-4c6d-9050-c35f09375cfb")
            .region("us-east")
            .templateId("d8cc1ef7-d13b-4731-95be-1f7c98c9f524")
            .ukoVault(ibm_hpcs_vault.vault().vault_id())
            .build());

    }
}

    variables:
  keyTemplate:
    fn::invoke:
      function: ibm:getHpcsKeyTemplate
      arguments:
        instanceId: 76195d24-8a31-4c6d-9050-c35f09375cfb
        region: us-east
        templateId: d8cc1ef7-d13b-4731-95be-1f7c98c9f524
        ukoVault: ${ibm_hpcs_vault.vault.vault_id}

    Using getHpcsKeyTemplate

    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 getHpcsKeyTemplate(args: GetHpcsKeyTemplateArgs, opts?: InvokeOptions): Promise<GetHpcsKeyTemplateResult>
function getHpcsKeyTemplateOutput(args: GetHpcsKeyTemplateOutputArgs, opts?: InvokeOptions): Output<GetHpcsKeyTemplateResult>
    def get_hpcs_key_template(id: Optional[str] = None,
                          instance_id: Optional[str] = None,
                          region: Optional[str] = None,
                          template_id: Optional[str] = None,
                          uko_vault: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetHpcsKeyTemplateResult
def get_hpcs_key_template_output(id: Optional[pulumi.Input[str]] = None,
                          instance_id: Optional[pulumi.Input[str]] = None,
                          region: Optional[pulumi.Input[str]] = None,
                          template_id: Optional[pulumi.Input[str]] = None,
                          uko_vault: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetHpcsKeyTemplateResult]
    func LookupHpcsKeyTemplate(ctx *Context, args *LookupHpcsKeyTemplateArgs, opts ...InvokeOption) (*LookupHpcsKeyTemplateResult, error)
func LookupHpcsKeyTemplateOutput(ctx *Context, args *LookupHpcsKeyTemplateOutputArgs, opts ...InvokeOption) LookupHpcsKeyTemplateResultOutput

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

    public static class GetHpcsKeyTemplate 
{
    public static Task<GetHpcsKeyTemplateResult> InvokeAsync(GetHpcsKeyTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetHpcsKeyTemplateResult> Invoke(GetHpcsKeyTemplateInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHpcsKeyTemplateResult> getHpcsKeyTemplate(GetHpcsKeyTemplateArgs args, InvokeOptions options)
public static Output<GetHpcsKeyTemplateResult> getHpcsKeyTemplate(GetHpcsKeyTemplateArgs args, InvokeOptions options)

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

    The following arguments are supported:

    InstanceId string
    ID of UKO Instance

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

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    TemplateId string
    UUID of the template.
    UkoVault string
    The UUID of the Vault in which the update is to take place.
    Id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    InstanceId string
    ID of UKO Instance

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

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    TemplateId string
    UUID of the template.
    UkoVault string
    The UUID of the Vault in which the update is to take place.
    Id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    instanceId String
    ID of UKO Instance

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

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    templateId String
    UUID of the template.
    ukoVault String
    The UUID of the Vault in which the update is to take place.
    id String
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    instanceId string
    ID of UKO Instance

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

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    templateId string
    UUID of the template.
    ukoVault string
    The UUID of the Vault in which the update is to take place.
    id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    instance_id str
    ID of UKO Instance

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

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    template_id str
    UUID of the template.
    uko_vault str
    The UUID of the Vault in which the update is to take place.
    id str
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    instanceId String
    ID of UKO Instance

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

    • Constraints: Allowable values are: au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao.
    templateId String
    UUID of the template.
    ukoVault String
    The UUID of the Vault in which the update is to take place.
    id String
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.

    getHpcsKeyTemplate Result

    The following output properties are available:

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

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    Description string
    (String) Description of the key template.

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

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    Id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    InstanceId string
    Keys List<GetHpcsKeyTemplateKey>
    (List) Properties describing the properties of the managed key. Nested scheme for key:
    Keystores List<GetHpcsKeyTemplateKeystore>
    (List)

    • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
    Name string
    (String) Name of the referenced vault.

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

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    Vaults List<GetHpcsKeyTemplateVault>
    (List) Reference to a vault. Nested scheme for vault:
    Version double
    (Integer) Version of the key template. Every time the key template is updated, the version will be updated automatically.

    • Constraints: The maximum value is 2147483647. The minimum value is 1.
    CreatedAt string
    (String) Date and time when the key template was created.
    CreatedBy string
    (String) ID of the user that created the key template.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    Description string
    (String) Description of the key template.

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

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    Id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    InstanceId string
    Keys []GetHpcsKeyTemplateKey
    (List) Properties describing the properties of the managed key. Nested scheme for key:
    Keystores []GetHpcsKeyTemplateKeystore
    (List)

    • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
    Name string
    (String) Name of the referenced vault.

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

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    Vaults []GetHpcsKeyTemplateVault
    (List) Reference to a vault. Nested scheme for vault:
    Version float64
    (Integer) Version of the key template. Every time the key template is updated, the version will be updated automatically.

    • Constraints: The maximum value is 2147483647. The minimum value is 1.
    createdAt String
    (String) Date and time when the key template was created.
    createdBy String
    (String) ID of the user that created the key template.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    description String
    (String) Description of the key template.

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

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id String
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    instanceId String
    keys List<GetHpcsKeyTemplateKey>
    (List) Properties describing the properties of the managed key. Nested scheme for key:
    keystores List<GetHpcsKeyTemplateKeystore>
    (List)

    • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
    name String
    (String) Name of the referenced vault.

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

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    vaults List<GetHpcsKeyTemplateVault>
    (List) Reference to a vault. Nested scheme for vault:
    version Double
    (Integer) Version of the key template. Every time the key template is updated, the version will be updated automatically.

    • Constraints: The maximum value is 2147483647. The minimum value is 1.
    createdAt string
    (String) Date and time when the key template was created.
    createdBy string
    (String) ID of the user that created the key template.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    description string
    (String) Description of the key template.

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

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    instanceId string
    keys GetHpcsKeyTemplateKey[]
    (List) Properties describing the properties of the managed key. Nested scheme for key:
    keystores GetHpcsKeyTemplateKeystore[]
    (List)

    • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
    name string
    (String) Name of the referenced vault.

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

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    vaults GetHpcsKeyTemplateVault[]
    (List) Reference to a vault. Nested scheme for vault:
    version number
    (Integer) Version of the key template. Every time the key template is updated, the version will be updated automatically.

    • Constraints: The maximum value is 2147483647. The minimum value is 1.
    created_at str
    (String) Date and time when the key template was created.
    created_by str
    (String) ID of the user that created the key template.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    description str
    (String) Description of the key template.

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

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id str
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    instance_id str
    keys Sequence[GetHpcsKeyTemplateKey]
    (List) Properties describing the properties of the managed key. Nested scheme for key:
    keystores Sequence[GetHpcsKeyTemplateKeystore]
    (List)

    • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
    name str
    (String) Name of the referenced vault.

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

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    vaults Sequence[GetHpcsKeyTemplateVault]
    (List) Reference to a vault. Nested scheme for vault:
    version float
    (Integer) Version of the key template. Every time the key template is updated, the version will be updated automatically.

    • Constraints: The maximum value is 2147483647. The minimum value is 1.
    createdAt String
    (String) Date and time when the key template was created.
    createdBy String
    (String) ID of the user that created the key template.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    description String
    (String) Description of the key template.

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

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id String
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    instanceId String
    keys List<Property Map>
    (List) Properties describing the properties of the managed key. Nested scheme for key:
    keystores List<Property Map>
    (List)

    • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
    name String
    (String) Name of the referenced vault.

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

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9-]+$/.
    vaults List<Property Map>
    (List) Reference to a vault. Nested scheme for vault:
    version Number
    (Integer) Version of the key template. Every time the key template is updated, the version will be updated automatically.

    • Constraints: The maximum value is 2147483647. The minimum value is 1.

    Supporting Types

    GetHpcsKeyTemplateKey

    ActivationDate string
    (String) Key activation date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    Algorithm string
    (String) The algorithm of the key.

    • Constraints: Allowable values are: aes, rsa, hmac, ec.
    ExpirationDate string
    (String) Key expiration date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    Size string
    (String) The size of the underlying cryptographic key or key pair. E.g. "256" for AES keys, or "2048" for RSA.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9]+$/.
    State string
    (String) The state that the key will be in after generation.

    • Constraints: The default value is active. Allowable values are: pre_activation, active.
    ActivationDate string
    (String) Key activation date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    Algorithm string
    (String) The algorithm of the key.

    • Constraints: Allowable values are: aes, rsa, hmac, ec.
    ExpirationDate string
    (String) Key expiration date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    Size string
    (String) The size of the underlying cryptographic key or key pair. E.g. "256" for AES keys, or "2048" for RSA.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9]+$/.
    State string
    (String) The state that the key will be in after generation.

    • Constraints: The default value is active. Allowable values are: pre_activation, active.
    activationDate String
    (String) Key activation date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    algorithm String
    (String) The algorithm of the key.

    • Constraints: Allowable values are: aes, rsa, hmac, ec.
    expirationDate String
    (String) Key expiration date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    size String
    (String) The size of the underlying cryptographic key or key pair. E.g. "256" for AES keys, or "2048" for RSA.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9]+$/.
    state String
    (String) The state that the key will be in after generation.

    • Constraints: The default value is active. Allowable values are: pre_activation, active.
    activationDate string
    (String) Key activation date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    algorithm string
    (String) The algorithm of the key.

    • Constraints: Allowable values are: aes, rsa, hmac, ec.
    expirationDate string
    (String) Key expiration date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    size string
    (String) The size of the underlying cryptographic key or key pair. E.g. "256" for AES keys, or "2048" for RSA.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9]+$/.
    state string
    (String) The state that the key will be in after generation.

    • Constraints: The default value is active. Allowable values are: pre_activation, active.
    activation_date str
    (String) Key activation date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    algorithm str
    (String) The algorithm of the key.

    • Constraints: Allowable values are: aes, rsa, hmac, ec.
    expiration_date str
    (String) Key expiration date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    size str
    (String) The size of the underlying cryptographic key or key pair. E.g. "256" for AES keys, or "2048" for RSA.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9]+$/.
    state str
    (String) The state that the key will be in after generation.

    • Constraints: The default value is active. Allowable values are: pre_activation, active.
    activationDate String
    (String) Key activation date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    algorithm String
    (String) The algorithm of the key.

    • Constraints: Allowable values are: aes, rsa, hmac, ec.
    expirationDate String
    (String) Key expiration date can be provided as a period definition (e.g. PY1 means 1 year).

    • Constraints: The maximum length is 100 characters. The minimum length is 3 characters. The value must match regular expression /P^[0-9YMWD]+$/.
    size String
    (String) The size of the underlying cryptographic key or key pair. E.g. "256" for AES keys, or "2048" for RSA.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9]+$/.
    state String
    (String) The state that the key will be in after generation.

    • Constraints: The default value is active. Allowable values are: pre_activation, active.

    GetHpcsKeyTemplateKeystore

    GoogleKeyProtectionLevel string
    (String)

    • Constraints: Allowable values are: software, hsm.
    GoogleKeyPurpose string
    (String)

    • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
    GoogleKmsAlgorithm string
    (String)

    • Constraints: Allowable values are: google_symmetric_encryption, ec_sign_p256_sha256, ec_sign_p384_sha384, ec_sign_secp256k1_sha256, rsa_sign_pss_2048_sha256, rsa_sign_pss_3072_sha256, rsa_sign_pss_4096_sha256, rsa_sign_pss_4096_sha512, rsa_sign_pkcs1_2048_sha256, rsa_sign_pkcs1_3072_sha256, rsa_sign_pkcs1_4096_sha256, rsa_sign_pkcs1_4096_sha512, rsa_sign_raw_pkcs1_2048, rsa_sign_raw_pkcs1_3072, rsa_sign_raw_pkcs1_4096, rsa_decrypt_oaep_2048_sha1, rsa_decrypt_oaep_2048_sha256, rsa_decrypt_oaep_3072_sha1, rsa_decrypt_oaep_3072_sha256, rsa_decrypt_oaep_4096_sha1, rsa_decrypt_oaep_4096_sha256, rsa_decrypt_oaep_4096_sha512, hmac_sha256.
    Group string
    (String) Which keystore group to distribute the key to.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9-_ ]+$/.
    Type string
    (String) Type of keystore.

    • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
    GoogleKeyProtectionLevel string
    (String)

    • Constraints: Allowable values are: software, hsm.
    GoogleKeyPurpose string
    (String)

    • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
    GoogleKmsAlgorithm string
    (String)

    • Constraints: Allowable values are: google_symmetric_encryption, ec_sign_p256_sha256, ec_sign_p384_sha384, ec_sign_secp256k1_sha256, rsa_sign_pss_2048_sha256, rsa_sign_pss_3072_sha256, rsa_sign_pss_4096_sha256, rsa_sign_pss_4096_sha512, rsa_sign_pkcs1_2048_sha256, rsa_sign_pkcs1_3072_sha256, rsa_sign_pkcs1_4096_sha256, rsa_sign_pkcs1_4096_sha512, rsa_sign_raw_pkcs1_2048, rsa_sign_raw_pkcs1_3072, rsa_sign_raw_pkcs1_4096, rsa_decrypt_oaep_2048_sha1, rsa_decrypt_oaep_2048_sha256, rsa_decrypt_oaep_3072_sha1, rsa_decrypt_oaep_3072_sha256, rsa_decrypt_oaep_4096_sha1, rsa_decrypt_oaep_4096_sha256, rsa_decrypt_oaep_4096_sha512, hmac_sha256.
    Group string
    (String) Which keystore group to distribute the key to.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9-_ ]+$/.
    Type string
    (String) Type of keystore.

    • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
    googleKeyProtectionLevel String
    (String)

    • Constraints: Allowable values are: software, hsm.
    googleKeyPurpose String
    (String)

    • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
    googleKmsAlgorithm String
    (String)

    • Constraints: Allowable values are: google_symmetric_encryption, ec_sign_p256_sha256, ec_sign_p384_sha384, ec_sign_secp256k1_sha256, rsa_sign_pss_2048_sha256, rsa_sign_pss_3072_sha256, rsa_sign_pss_4096_sha256, rsa_sign_pss_4096_sha512, rsa_sign_pkcs1_2048_sha256, rsa_sign_pkcs1_3072_sha256, rsa_sign_pkcs1_4096_sha256, rsa_sign_pkcs1_4096_sha512, rsa_sign_raw_pkcs1_2048, rsa_sign_raw_pkcs1_3072, rsa_sign_raw_pkcs1_4096, rsa_decrypt_oaep_2048_sha1, rsa_decrypt_oaep_2048_sha256, rsa_decrypt_oaep_3072_sha1, rsa_decrypt_oaep_3072_sha256, rsa_decrypt_oaep_4096_sha1, rsa_decrypt_oaep_4096_sha256, rsa_decrypt_oaep_4096_sha512, hmac_sha256.
    group String
    (String) Which keystore group to distribute the key to.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9-_ ]+$/.
    type String
    (String) Type of keystore.

    • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
    googleKeyProtectionLevel string
    (String)

    • Constraints: Allowable values are: software, hsm.
    googleKeyPurpose string
    (String)

    • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
    googleKmsAlgorithm string
    (String)

    • Constraints: Allowable values are: google_symmetric_encryption, ec_sign_p256_sha256, ec_sign_p384_sha384, ec_sign_secp256k1_sha256, rsa_sign_pss_2048_sha256, rsa_sign_pss_3072_sha256, rsa_sign_pss_4096_sha256, rsa_sign_pss_4096_sha512, rsa_sign_pkcs1_2048_sha256, rsa_sign_pkcs1_3072_sha256, rsa_sign_pkcs1_4096_sha256, rsa_sign_pkcs1_4096_sha512, rsa_sign_raw_pkcs1_2048, rsa_sign_raw_pkcs1_3072, rsa_sign_raw_pkcs1_4096, rsa_decrypt_oaep_2048_sha1, rsa_decrypt_oaep_2048_sha256, rsa_decrypt_oaep_3072_sha1, rsa_decrypt_oaep_3072_sha256, rsa_decrypt_oaep_4096_sha1, rsa_decrypt_oaep_4096_sha256, rsa_decrypt_oaep_4096_sha512, hmac_sha256.
    group string
    (String) Which keystore group to distribute the key to.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9-_ ]+$/.
    type string
    (String) Type of keystore.

    • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
    google_key_protection_level str
    (String)

    • Constraints: Allowable values are: software, hsm.
    google_key_purpose str
    (String)

    • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
    google_kms_algorithm str
    (String)

    • Constraints: Allowable values are: google_symmetric_encryption, ec_sign_p256_sha256, ec_sign_p384_sha384, ec_sign_secp256k1_sha256, rsa_sign_pss_2048_sha256, rsa_sign_pss_3072_sha256, rsa_sign_pss_4096_sha256, rsa_sign_pss_4096_sha512, rsa_sign_pkcs1_2048_sha256, rsa_sign_pkcs1_3072_sha256, rsa_sign_pkcs1_4096_sha256, rsa_sign_pkcs1_4096_sha512, rsa_sign_raw_pkcs1_2048, rsa_sign_raw_pkcs1_3072, rsa_sign_raw_pkcs1_4096, rsa_decrypt_oaep_2048_sha1, rsa_decrypt_oaep_2048_sha256, rsa_decrypt_oaep_3072_sha1, rsa_decrypt_oaep_3072_sha256, rsa_decrypt_oaep_4096_sha1, rsa_decrypt_oaep_4096_sha256, rsa_decrypt_oaep_4096_sha512, hmac_sha256.
    group str
    (String) Which keystore group to distribute the key to.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9-_ ]+$/.
    type str
    (String) Type of keystore.

    • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
    googleKeyProtectionLevel String
    (String)

    • Constraints: Allowable values are: software, hsm.
    googleKeyPurpose String
    (String)

    • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
    googleKmsAlgorithm String
    (String)

    • Constraints: Allowable values are: google_symmetric_encryption, ec_sign_p256_sha256, ec_sign_p384_sha384, ec_sign_secp256k1_sha256, rsa_sign_pss_2048_sha256, rsa_sign_pss_3072_sha256, rsa_sign_pss_4096_sha256, rsa_sign_pss_4096_sha512, rsa_sign_pkcs1_2048_sha256, rsa_sign_pkcs1_3072_sha256, rsa_sign_pkcs1_4096_sha256, rsa_sign_pkcs1_4096_sha512, rsa_sign_raw_pkcs1_2048, rsa_sign_raw_pkcs1_3072, rsa_sign_raw_pkcs1_4096, rsa_decrypt_oaep_2048_sha1, rsa_decrypt_oaep_2048_sha256, rsa_decrypt_oaep_3072_sha1, rsa_decrypt_oaep_3072_sha256, rsa_decrypt_oaep_4096_sha1, rsa_decrypt_oaep_4096_sha256, rsa_decrypt_oaep_4096_sha512, hmac_sha256.
    group String
    (String) Which keystore group to distribute the key to.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9-_ ]+$/.
    type String
    (String) Type of keystore.

    • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.

    GetHpcsKeyTemplateVault

    Href string
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    Id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    Name string
    (String) Name of the referenced vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.
    Href string
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    Id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    Name string
    (String) Name of the referenced vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.
    href String
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id String
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    name String
    (String) Name of the referenced vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.
    href string
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id string
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    name string
    (String) Name of the referenced vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.
    href str
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id str
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    name str
    (String) Name of the referenced vault.

    • Constraints: The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.
    href String
    (String) A URL that uniquely identifies your cloud resource.

    • Constraints: The maximum length is 200 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._~:\/?&=-]+$/.
    id String
    (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[-0-9a-z]+$/.
    name String
    (String) Name of the referenced vault.

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

    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.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm