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

ibm.HpcsKeyTemplate

Explore with Pulumi AI

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

Provides a resource for key_template. This allows key_template to be created, updated and deleted.

Example Usage

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

const keyTemplateInstance = new ibm.HpcsKeyTemplate("keyTemplateInstance", {
    instanceId: ibm_hpcs_vault.vault_instance.instance_id,
    region: ibm_hpcs_vault.vault_instance.region,
    ukoVault: ibm_hpcs_vault.vault_instance.vault_id,
    vault: {
        id: ibm_hpcs_vault.vault_instance.vault_id,
    },
    description: "example key template",
    key: {
        size: "256",
        algorithm: "aes",
        activationDate: "P5Y1M1W2D",
        expirationDate: "P1Y2M1W4D",
        state: "active",
    },
    keystores: [{
        group: "Production",
        type: "aws_kms",
    }],
});
Copy
import pulumi
import pulumi_ibm as ibm

key_template_instance = ibm.HpcsKeyTemplate("keyTemplateInstance",
    instance_id=ibm_hpcs_vault["vault_instance"]["instance_id"],
    region=ibm_hpcs_vault["vault_instance"]["region"],
    uko_vault=ibm_hpcs_vault["vault_instance"]["vault_id"],
    vault={
        "id": ibm_hpcs_vault["vault_instance"]["vault_id"],
    },
    description="example key template",
    key={
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active",
    },
    keystores=[{
        "group": "Production",
        "type": "aws_kms",
    }])
Copy
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.NewHpcsKeyTemplate(ctx, "keyTemplateInstance", &ibm.HpcsKeyTemplateArgs{
			InstanceId: pulumi.Any(ibm_hpcs_vault.Vault_instance.Instance_id),
			Region:     pulumi.Any(ibm_hpcs_vault.Vault_instance.Region),
			UkoVault:   pulumi.Any(ibm_hpcs_vault.Vault_instance.Vault_id),
			Vault: &ibm.HpcsKeyTemplateVaultArgs{
				Id: pulumi.Any(ibm_hpcs_vault.Vault_instance.Vault_id),
			},
			Description: pulumi.String("example key template"),
			Key: &ibm.HpcsKeyTemplateKeyArgs{
				Size:           pulumi.String("256"),
				Algorithm:      pulumi.String("aes"),
				ActivationDate: pulumi.String("P5Y1M1W2D"),
				ExpirationDate: pulumi.String("P1Y2M1W4D"),
				State:          pulumi.String("active"),
			},
			Keystores: ibm.HpcsKeyTemplateKeystoreArray{
				&ibm.HpcsKeyTemplateKeystoreArgs{
					Group: pulumi.String("Production"),
					Type:  pulumi.String("aws_kms"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var keyTemplateInstance = new Ibm.HpcsKeyTemplate("keyTemplateInstance", new()
    {
        InstanceId = ibm_hpcs_vault.Vault_instance.Instance_id,
        Region = ibm_hpcs_vault.Vault_instance.Region,
        UkoVault = ibm_hpcs_vault.Vault_instance.Vault_id,
        Vault = new Ibm.Inputs.HpcsKeyTemplateVaultArgs
        {
            Id = ibm_hpcs_vault.Vault_instance.Vault_id,
        },
        Description = "example key template",
        Key = new Ibm.Inputs.HpcsKeyTemplateKeyArgs
        {
            Size = "256",
            Algorithm = "aes",
            ActivationDate = "P5Y1M1W2D",
            ExpirationDate = "P1Y2M1W4D",
            State = "active",
        },
        Keystores = new[]
        {
            new Ibm.Inputs.HpcsKeyTemplateKeystoreArgs
            {
                Group = "Production",
                Type = "aws_kms",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.HpcsKeyTemplate;
import com.pulumi.ibm.HpcsKeyTemplateArgs;
import com.pulumi.ibm.inputs.HpcsKeyTemplateVaultArgs;
import com.pulumi.ibm.inputs.HpcsKeyTemplateKeyArgs;
import com.pulumi.ibm.inputs.HpcsKeyTemplateKeystoreArgs;
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 keyTemplateInstance = new HpcsKeyTemplate("keyTemplateInstance", HpcsKeyTemplateArgs.builder()
            .instanceId(ibm_hpcs_vault.vault_instance().instance_id())
            .region(ibm_hpcs_vault.vault_instance().region())
            .ukoVault(ibm_hpcs_vault.vault_instance().vault_id())
            .vault(HpcsKeyTemplateVaultArgs.builder()
                .id(ibm_hpcs_vault.vault_instance().vault_id())
                .build())
            .description("example key template")
            .key(HpcsKeyTemplateKeyArgs.builder()
                .size("256")
                .algorithm("aes")
                .activationDate("P5Y1M1W2D")
                .expirationDate("P1Y2M1W4D")
                .state("active")
                .build())
            .keystores(HpcsKeyTemplateKeystoreArgs.builder()
                .group("Production")
                .type("aws_kms")
                .build())
            .build());

    }
}
Copy
resources:
  keyTemplateInstance:
    type: ibm:HpcsKeyTemplate
    properties:
      instanceId: ${ibm_hpcs_vault.vault_instance.instance_id}
      region: ${ibm_hpcs_vault.vault_instance.region}
      ukoVault: ${ibm_hpcs_vault.vault_instance.vault_id}
      vault:
        id: ${ibm_hpcs_vault.vault_instance.vault_id}
      description: example key template
      key:
        size: '256'
        algorithm: aes
        activationDate: P5Y1M1W2D
        expirationDate: P1Y2M1W4D
        state: active
      keystores:
        - group: Production
          type: aws_kms
Copy

Create HpcsKeyTemplate Resource

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

Constructor syntax

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

@overload
def HpcsKeyTemplate(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    instance_id: Optional[str] = None,
                    key: Optional[HpcsKeyTemplateKeyArgs] = None,
                    keystores: Optional[Sequence[HpcsKeyTemplateKeystoreArgs]] = None,
                    region: Optional[str] = None,
                    uko_vault: Optional[str] = None,
                    vault: Optional[HpcsKeyTemplateVaultArgs] = None,
                    description: Optional[str] = None,
                    hpcs_key_template_id: Optional[str] = None,
                    name: Optional[str] = None)
func NewHpcsKeyTemplate(ctx *Context, name string, args HpcsKeyTemplateArgs, opts ...ResourceOption) (*HpcsKeyTemplate, error)
public HpcsKeyTemplate(string name, HpcsKeyTemplateArgs args, CustomResourceOptions? opts = null)
public HpcsKeyTemplate(String name, HpcsKeyTemplateArgs args)
public HpcsKeyTemplate(String name, HpcsKeyTemplateArgs args, CustomResourceOptions options)

type: ibm:HpcsKeyTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HpcsKeyTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HpcsKeyTemplateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HpcsKeyTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HpcsKeyTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HpcsKeyTemplateArgs
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 hpcsKeyTemplateResource = new Ibm.HpcsKeyTemplate("hpcsKeyTemplateResource", new()
{
    InstanceId = "string",
    Key = new Ibm.Inputs.HpcsKeyTemplateKeyArgs
    {
        ActivationDate = "string",
        Algorithm = "string",
        ExpirationDate = "string",
        Size = "string",
        State = "string",
    },
    Keystores = new[]
    {
        new Ibm.Inputs.HpcsKeyTemplateKeystoreArgs
        {
            Group = "string",
            Type = "string",
            GoogleKeyProtectionLevel = "string",
            GoogleKeyPurpose = "string",
            GoogleKmsAlgorithm = "string",
        },
    },
    Region = "string",
    UkoVault = "string",
    Vault = new Ibm.Inputs.HpcsKeyTemplateVaultArgs
    {
        Id = "string",
    },
    Description = "string",
    HpcsKeyTemplateId = "string",
    Name = "string",
});
Copy
example, err := ibm.NewHpcsKeyTemplate(ctx, "hpcsKeyTemplateResource", &ibm.HpcsKeyTemplateArgs{
	InstanceId: pulumi.String("string"),
	Key: &ibm.HpcsKeyTemplateKeyArgs{
		ActivationDate: pulumi.String("string"),
		Algorithm:      pulumi.String("string"),
		ExpirationDate: pulumi.String("string"),
		Size:           pulumi.String("string"),
		State:          pulumi.String("string"),
	},
	Keystores: ibm.HpcsKeyTemplateKeystoreArray{
		&ibm.HpcsKeyTemplateKeystoreArgs{
			Group:                    pulumi.String("string"),
			Type:                     pulumi.String("string"),
			GoogleKeyProtectionLevel: pulumi.String("string"),
			GoogleKeyPurpose:         pulumi.String("string"),
			GoogleKmsAlgorithm:       pulumi.String("string"),
		},
	},
	Region:   pulumi.String("string"),
	UkoVault: pulumi.String("string"),
	Vault: &ibm.HpcsKeyTemplateVaultArgs{
		Id: pulumi.String("string"),
	},
	Description:       pulumi.String("string"),
	HpcsKeyTemplateId: pulumi.String("string"),
	Name:              pulumi.String("string"),
})
Copy
var hpcsKeyTemplateResource = new HpcsKeyTemplate("hpcsKeyTemplateResource", HpcsKeyTemplateArgs.builder()
    .instanceId("string")
    .key(HpcsKeyTemplateKeyArgs.builder()
        .activationDate("string")
        .algorithm("string")
        .expirationDate("string")
        .size("string")
        .state("string")
        .build())
    .keystores(HpcsKeyTemplateKeystoreArgs.builder()
        .group("string")
        .type("string")
        .googleKeyProtectionLevel("string")
        .googleKeyPurpose("string")
        .googleKmsAlgorithm("string")
        .build())
    .region("string")
    .ukoVault("string")
    .vault(HpcsKeyTemplateVaultArgs.builder()
        .id("string")
        .build())
    .description("string")
    .hpcsKeyTemplateId("string")
    .name("string")
    .build());
Copy
hpcs_key_template_resource = ibm.HpcsKeyTemplate("hpcsKeyTemplateResource",
    instance_id="string",
    key={
        "activation_date": "string",
        "algorithm": "string",
        "expiration_date": "string",
        "size": "string",
        "state": "string",
    },
    keystores=[{
        "group": "string",
        "type": "string",
        "google_key_protection_level": "string",
        "google_key_purpose": "string",
        "google_kms_algorithm": "string",
    }],
    region="string",
    uko_vault="string",
    vault={
        "id": "string",
    },
    description="string",
    hpcs_key_template_id="string",
    name="string")
Copy
const hpcsKeyTemplateResource = new ibm.HpcsKeyTemplate("hpcsKeyTemplateResource", {
    instanceId: "string",
    key: {
        activationDate: "string",
        algorithm: "string",
        expirationDate: "string",
        size: "string",
        state: "string",
    },
    keystores: [{
        group: "string",
        type: "string",
        googleKeyProtectionLevel: "string",
        googleKeyPurpose: "string",
        googleKmsAlgorithm: "string",
    }],
    region: "string",
    ukoVault: "string",
    vault: {
        id: "string",
    },
    description: "string",
    hpcsKeyTemplateId: "string",
    name: "string",
});
Copy
type: ibm:HpcsKeyTemplate
properties:
    description: string
    hpcsKeyTemplateId: string
    instanceId: string
    key:
        activationDate: string
        algorithm: string
        expirationDate: string
        size: string
        state: string
    keystores:
        - googleKeyProtectionLevel: string
          googleKeyPurpose: string
          googleKmsAlgorithm: string
          group: string
          type: string
    name: string
    region: string
    ukoVault: string
    vault:
        id: string
Copy

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

InstanceId This property is required. string
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
Key This property is required. HpcsKeyTemplateKey
Properties describing the properties of the managed key. Nested scheme for key:
Keystores This property is required. List<HpcsKeyTemplateKeystore>
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
Region This property is required. string
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
UkoVault This property is required. string
The UUID of the Vault in which the update is to take place.
Vault This property is required. HpcsKeyTemplateVault
ID of the Vault where the entity is to be created in. Nested scheme for vault:
Description 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 /(.|\\n)*/.
HpcsKeyTemplateId string
Name string
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
InstanceId This property is required. string
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
Key This property is required. HpcsKeyTemplateKeyArgs
Properties describing the properties of the managed key. Nested scheme for key:
Keystores This property is required. []HpcsKeyTemplateKeystoreArgs
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
Region This property is required. string
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
UkoVault This property is required. string
The UUID of the Vault in which the update is to take place.
Vault This property is required. HpcsKeyTemplateVaultArgs
ID of the Vault where the entity is to be created in. Nested scheme for vault:
Description 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 /(.|\\n)*/.
HpcsKeyTemplateId string
Name string
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
instanceId This property is required. String
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
key This property is required. HpcsKeyTemplateKey
Properties describing the properties of the managed key. Nested scheme for key:
keystores This property is required. List<HpcsKeyTemplateKeystore>
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
region This property is required. String
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
ukoVault This property is required. String
The UUID of the Vault in which the update is to take place.
vault This property is required. HpcsKeyTemplateVault
ID of the Vault where the entity is to be created in. Nested scheme for vault:
description 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 /(.|\\n)*/.
hpcsKeyTemplateId String
name String
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
instanceId This property is required. string
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
key This property is required. HpcsKeyTemplateKey
Properties describing the properties of the managed key. Nested scheme for key:
keystores This property is required. HpcsKeyTemplateKeystore[]
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
region This property is required. string
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
ukoVault This property is required. string
The UUID of the Vault in which the update is to take place.
vault This property is required. HpcsKeyTemplateVault
ID of the Vault where the entity is to be created in. Nested scheme for vault:
description 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 /(.|\\n)*/.
hpcsKeyTemplateId string
name string
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
instance_id This property is required. str
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
key This property is required. HpcsKeyTemplateKeyArgs
Properties describing the properties of the managed key. Nested scheme for key:
keystores This property is required. Sequence[HpcsKeyTemplateKeystoreArgs]
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
region This property is required. str
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
uko_vault This property is required. str
The UUID of the Vault in which the update is to take place.
vault This property is required. HpcsKeyTemplateVaultArgs
ID of the Vault where the entity is to be created in. Nested scheme for vault:
description str
Description of the key template.

  • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.
hpcs_key_template_id str
name str
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
instanceId This property is required. String
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
key This property is required. Property Map
Properties describing the properties of the managed key. Nested scheme for key:
keystores This property is required. List<Property Map>
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
region This property is required. String
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
ukoVault This property is required. String
The UUID of the Vault in which the update is to take place.
vault This property is required. Property Map
ID of the Vault where the entity is to be created in. Nested scheme for vault:
description 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 /(.|\\n)*/.
hpcsKeyTemplateId String
name String
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.

Outputs

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

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-]+$/.
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
The provider-assigned unique ID for this managed resource.
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-]+$/.
Version string
(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-]+$/.
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
The provider-assigned unique ID for this managed resource.
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-]+$/.
Version string
(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-]+$/.
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
The provider-assigned unique ID for this managed resource.
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-]+$/.
version String
(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-]+$/.
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
The provider-assigned unique ID for this managed resource.
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-]+$/.
version string
(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-]+$/.
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
The provider-assigned unique ID for this managed resource.
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-]+$/.
version str
(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-]+$/.
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
The provider-assigned unique ID for this managed resource.
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-]+$/.
version String
(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.

Look up Existing HpcsKeyTemplate Resource

Get an existing HpcsKeyTemplate 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?: HpcsKeyTemplateState, opts?: CustomResourceOptions): HpcsKeyTemplate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        description: Optional[str] = None,
        hpcs_key_template_id: Optional[str] = None,
        href: Optional[str] = None,
        instance_id: Optional[str] = None,
        key: Optional[HpcsKeyTemplateKeyArgs] = None,
        keystores: Optional[Sequence[HpcsKeyTemplateKeystoreArgs]] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        uko_vault: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        vault: Optional[HpcsKeyTemplateVaultArgs] = None,
        version: Optional[str] = None) -> HpcsKeyTemplate
func GetHpcsKeyTemplate(ctx *Context, name string, id IDInput, state *HpcsKeyTemplateState, opts ...ResourceOption) (*HpcsKeyTemplate, error)
public static HpcsKeyTemplate Get(string name, Input<string> id, HpcsKeyTemplateState? state, CustomResourceOptions? opts = null)
public static HpcsKeyTemplate get(String name, Output<String> id, HpcsKeyTemplateState state, CustomResourceOptions options)
resources:  _:    type: ibm:HpcsKeyTemplate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
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
Description of the key template.

  • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.
HpcsKeyTemplateId string
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._~:\/?&=-]+$/.
InstanceId string
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
Key HpcsKeyTemplateKey
Properties describing the properties of the managed key. Nested scheme for key:
Keystores List<HpcsKeyTemplateKeystore>
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
Name string
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
Region string
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
UkoVault string
The UUID of the Vault in which the update is to take place.
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-]+$/.
Vault HpcsKeyTemplateVault
ID of the Vault where the entity is to be created in. Nested scheme for vault:
Version string
(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
Description of the key template.

  • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.
HpcsKeyTemplateId string
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._~:\/?&=-]+$/.
InstanceId string
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
Key HpcsKeyTemplateKeyArgs
Properties describing the properties of the managed key. Nested scheme for key:
Keystores []HpcsKeyTemplateKeystoreArgs
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
Name string
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
Region string
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
UkoVault string
The UUID of the Vault in which the update is to take place.
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-]+$/.
Vault HpcsKeyTemplateVaultArgs
ID of the Vault where the entity is to be created in. Nested scheme for vault:
Version string
(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
Description of the key template.

  • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.
hpcsKeyTemplateId String
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._~:\/?&=-]+$/.
instanceId String
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
key HpcsKeyTemplateKey
Properties describing the properties of the managed key. Nested scheme for key:
keystores List<HpcsKeyTemplateKeystore>
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
name String
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
region String
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
ukoVault String
The UUID of the Vault in which the update is to take place.
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-]+$/.
vault HpcsKeyTemplateVault
ID of the Vault where the entity is to be created in. Nested scheme for vault:
version String
(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
Description of the key template.

  • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.
hpcsKeyTemplateId string
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._~:\/?&=-]+$/.
instanceId string
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
key HpcsKeyTemplateKey
Properties describing the properties of the managed key. Nested scheme for key:
keystores HpcsKeyTemplateKeystore[]
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
name string
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
region string
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
ukoVault string
The UUID of the Vault in which the update is to take place.
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-]+$/.
vault HpcsKeyTemplateVault
ID of the Vault where the entity is to be created in. Nested scheme for vault:
version string
(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
Description of the key template.

  • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.
hpcs_key_template_id str
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._~:\/?&=-]+$/.
instance_id str
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
key HpcsKeyTemplateKeyArgs
Properties describing the properties of the managed key. Nested scheme for key:
keystores Sequence[HpcsKeyTemplateKeystoreArgs]
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
name str
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
region str
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
uko_vault str
The UUID of the Vault in which the update is to take place.
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-]+$/.
vault HpcsKeyTemplateVaultArgs
ID of the Vault where the entity is to be created in. Nested scheme for vault:
version str
(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
Description of the key template.

  • Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.
hpcsKeyTemplateId String
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._~:\/?&=-]+$/.
instanceId String
ID of UKO Instance

  • Constraints: Must match the ID of the UKO instance you are trying to work with.
key Property Map
Properties describing the properties of the managed key. Nested scheme for key:
keystores List<Property Map>
An array describing the type and group of target keystores the managed key is to be installed in.

  • Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for keystores:
name String
Name of the template, it will be referenced when creating managed keys.

  • Constraints: The maximum length is 30 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z][A-Za-z0-9-]*$/.
region String
Region of the UKO Instance

  • Constraints: Must match the region of the UKO instance you are trying to work with. 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.
ukoVault String
The UUID of the Vault in which the update is to take place.
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-]+$/.
vault Property Map
ID of the Vault where the entity is to be created in. Nested scheme for vault:
version String
(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

HpcsKeyTemplateKey
, HpcsKeyTemplateKeyArgs

ActivationDate This property is required. 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 This property is required. string
The algorithm of the key.

  • Constraints: Allowable values are: aes, rsa, hmac, ec.
ExpirationDate This property is required. 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 This property is required. 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 This property is required. string
The state that the key will be in after generation.

  • Constraints: The default value is active. Allowable values are: pre_activation, active.
ActivationDate This property is required. 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 This property is required. string
The algorithm of the key.

  • Constraints: Allowable values are: aes, rsa, hmac, ec.
ExpirationDate This property is required. 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 This property is required. 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 This property is required. string
The state that the key will be in after generation.

  • Constraints: The default value is active. Allowable values are: pre_activation, active.
activationDate This property is required. 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 This property is required. String
The algorithm of the key.

  • Constraints: Allowable values are: aes, rsa, hmac, ec.
expirationDate This property is required. 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 This property is required. 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 This property is required. String
The state that the key will be in after generation.

  • Constraints: The default value is active. Allowable values are: pre_activation, active.
activationDate This property is required. 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 This property is required. string
The algorithm of the key.

  • Constraints: Allowable values are: aes, rsa, hmac, ec.
expirationDate This property is required. 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 This property is required. 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 This property is required. 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 This property is required. str
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 This property is required. str
The algorithm of the key.

  • Constraints: Allowable values are: aes, rsa, hmac, ec.
expiration_date This property is required. str
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 This property is required. str
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 This property is required. str
The state that the key will be in after generation.

  • Constraints: The default value is active. Allowable values are: pre_activation, active.
activationDate This property is required. 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 This property is required. String
The algorithm of the key.

  • Constraints: Allowable values are: aes, rsa, hmac, ec.
expirationDate This property is required. 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 This property is required. 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 This property is required. String
The state that the key will be in after generation.

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

HpcsKeyTemplateKeystore
, HpcsKeyTemplateKeystoreArgs

Group This property is required. 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 This property is required. string
Type of keystore.

  • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
GoogleKeyProtectionLevel string
  • Constraints: Allowable values are: software, hsm.
GoogleKeyPurpose string
  • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
GoogleKmsAlgorithm 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 This property is required. 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 This property is required. string
Type of keystore.

  • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
GoogleKeyProtectionLevel string
  • Constraints: Allowable values are: software, hsm.
GoogleKeyPurpose string
  • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
GoogleKmsAlgorithm 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 This property is required. 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 This property is required. String
Type of keystore.

  • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
googleKeyProtectionLevel String
  • Constraints: Allowable values are: software, hsm.
googleKeyPurpose String
  • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
googleKmsAlgorithm 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 This property is required. 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 This property is required. string
Type of keystore.

  • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
googleKeyProtectionLevel string
  • Constraints: Allowable values are: software, hsm.
googleKeyPurpose string
  • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
googleKmsAlgorithm 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 This property is required. str
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 This property is required. str
Type of keystore.

  • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
google_key_protection_level str
  • Constraints: Allowable values are: software, hsm.
google_key_purpose str
  • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
google_kms_algorithm str
  • 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 This property is required. 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 This property is required. String
Type of keystore.

  • Constraints: Allowable values are: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms.
googleKeyProtectionLevel String
  • Constraints: Allowable values are: software, hsm.
googleKeyPurpose String
  • Constraints: Allowable values are: encrypt_decrypt, asymmetric_decrypt, asymmetric_sign, mac.
googleKmsAlgorithm 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.

HpcsKeyTemplateVault
, HpcsKeyTemplateVaultArgs

Id This property is required. 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]+$/.
Id This property is required. 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]+$/.
id This property is required. 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]+$/.
id This property is required. 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]+$/.
id This property is required. str
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]+$/.
id This property is required. 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]+$/.

Import

You can import the ibm_hpcs_key_template resource by using region, instance_id, vault_id, and template_id.

Syntax

bash

$ pulumi import ibm:index/hpcsKeyTemplate:HpcsKeyTemplate template <region>/<instance_id>/<vault_id>/<template_id>
Copy

Example

$ pulumi import ibm:index/hpcsKeyTemplate:HpcsKeyTemplate key_template us-east/76195d24-8a31-4c6d-9050-c35f09375cfb/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/d8cc1ef7-d13b-4731-95be-1f7c98c9f524
Copy

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