ibm 1.78.0, Apr 30 25

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

ibm.HpcsManagedKey

Explore with Pulumi AI

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

Example Usage

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

const managedKeyInstance = new ibm.HpcsManagedKey("managedKeyInstance", {
    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,
    },
    label: "terraformKey",
    description: "example key",
    templateName: ibm_hpcs_key_template.key_template_instance.name,
});

import pulumi
import pulumi_ibm as ibm

managed_key_instance = ibm.HpcsManagedKey("managedKeyInstance",
    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"],
    },
    label="terraformKey",
    description="example key",
    template_name=ibm_hpcs_key_template["key_template_instance"]["name"])

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.NewHpcsManagedKey(ctx, "managedKeyInstance", &ibm.HpcsManagedKeyArgs{
			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.HpcsManagedKeyVaultArgs{
				Id: pulumi.Any(ibm_hpcs_vault.Vault_instance.Vault_id),
			},
			Label:        pulumi.String("terraformKey"),
			Description:  pulumi.String("example key"),
			TemplateName: pulumi.Any(ibm_hpcs_key_template.Key_template_instance.Name),
		})
		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 managedKeyInstance = new Ibm.HpcsManagedKey("managedKeyInstance", 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.HpcsManagedKeyVaultArgs
        {
            Id = ibm_hpcs_vault.Vault_instance.Vault_id,
        },
        Label = "terraformKey",
        Description = "example key",
        TemplateName = ibm_hpcs_key_template.Key_template_instance.Name,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.HpcsManagedKey;
import com.pulumi.ibm.HpcsManagedKeyArgs;
import com.pulumi.ibm.inputs.HpcsManagedKeyVaultArgs;
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 managedKeyInstance = new HpcsManagedKey("managedKeyInstance", HpcsManagedKeyArgs.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(HpcsManagedKeyVaultArgs.builder()
                .id(ibm_hpcs_vault.vault_instance().vault_id())
                .build())
            .label("terraformKey")
            .description("example key")
            .templateName(ibm_hpcs_key_template.key_template_instance().name())
            .build());

    }
}

resources:
  managedKeyInstance:
    type: ibm:HpcsManagedKey
    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}
      label: terraformKey
      description: example key
      templateName: ${ibm_hpcs_key_template.key_template_instance.name}

Create HpcsManagedKey Resource

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

Constructor syntax

new HpcsManagedKey(name: string, args: HpcsManagedKeyArgs, opts?: CustomResourceOptions);

@overload
def HpcsManagedKey(resource_name: str,
                   args: HpcsManagedKeyArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def HpcsManagedKey(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_id: Optional[str] = None,
                   label: Optional[str] = None,
                   region: Optional[str] = None,
                   template_name: Optional[str] = None,
                   uko_vault: Optional[str] = None,
                   vault: Optional[HpcsManagedKeyVaultArgs] = None,
                   description: Optional[str] = None,
                   hpcs_managed_key_id: Optional[str] = None,
                   state: Optional[str] = None,
                   tags: Optional[Sequence[HpcsManagedKeyTagArgs]] = None)

func NewHpcsManagedKey(ctx *Context, name string, args HpcsManagedKeyArgs, opts ...ResourceOption) (*HpcsManagedKey, error)

public HpcsManagedKey(string name, HpcsManagedKeyArgs args, CustomResourceOptions? opts = null)

public HpcsManagedKey(String name, HpcsManagedKeyArgs args)
public HpcsManagedKey(String name, HpcsManagedKeyArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args HpcsManagedKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args HpcsManagedKeyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args HpcsManagedKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HpcsManagedKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args HpcsManagedKeyArgs: 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 hpcsManagedKeyResource = new Ibm.HpcsManagedKey("hpcsManagedKeyResource", new()
{
    InstanceId = "string",
    Label = "string",
    Region = "string",
    TemplateName = "string",
    UkoVault = "string",
    Vault = new Ibm.Inputs.HpcsManagedKeyVaultArgs
    {
        Id = "string",
    },
    Description = "string",
    HpcsManagedKeyId = "string",
    State = "string",
    Tags = new[]
    {
        new Ibm.Inputs.HpcsManagedKeyTagArgs
        {
            Name = "string",
            Value = "string",
        },
    },
});

example, err := ibm.NewHpcsManagedKey(ctx, "hpcsManagedKeyResource", &ibm.HpcsManagedKeyArgs{
	InstanceId:   pulumi.String("string"),
	Label:        pulumi.String("string"),
	Region:       pulumi.String("string"),
	TemplateName: pulumi.String("string"),
	UkoVault:     pulumi.String("string"),
	Vault: &ibm.HpcsManagedKeyVaultArgs{
		Id: pulumi.String("string"),
	},
	Description:      pulumi.String("string"),
	HpcsManagedKeyId: pulumi.String("string"),
	State:            pulumi.String("string"),
	Tags: ibm.HpcsManagedKeyTagArray{
		&ibm.HpcsManagedKeyTagArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

var hpcsManagedKeyResource = new HpcsManagedKey("hpcsManagedKeyResource", HpcsManagedKeyArgs.builder()
    .instanceId("string")
    .label("string")
    .region("string")
    .templateName("string")
    .ukoVault("string")
    .vault(HpcsManagedKeyVaultArgs.builder()
        .id("string")
        .build())
    .description("string")
    .hpcsManagedKeyId("string")
    .state("string")
    .tags(HpcsManagedKeyTagArgs.builder()
        .name("string")
        .value("string")
        .build())
    .build());

hpcs_managed_key_resource = ibm.HpcsManagedKey("hpcsManagedKeyResource",
    instance_id="string",
    label="string",
    region="string",
    template_name="string",
    uko_vault="string",
    vault={
        "id": "string",
    },
    description="string",
    hpcs_managed_key_id="string",
    state="string",
    tags=[{
        "name": "string",
        "value": "string",
    }])

const hpcsManagedKeyResource = new ibm.HpcsManagedKey("hpcsManagedKeyResource", {
    instanceId: "string",
    label: "string",
    region: "string",
    templateName: "string",
    ukoVault: "string",
    vault: {
        id: "string",
    },
    description: "string",
    hpcsManagedKeyId: "string",
    state: "string",
    tags: [{
        name: "string",
        value: "string",
    }],
});

type: ibm:HpcsManagedKey
properties:
    description: string
    hpcsManagedKeyId: string
    instanceId: string
    label: string
    region: string
    state: string
    tags:
        - name: string
          value: string
    templateName: string
    ukoVault: string
    vault:
        id: string

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

InstanceId string

ID of UKO Instance

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

Label string

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

TemplateName string

Name of the key template to use when creating a key.

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-]+$/.

UkoVault string

The UUID of the Vault in which the update is to take place.

Vault HpcsManagedKeyVault

ID of the Vault where the entity is to be created in. Nested scheme for vault:

Description string

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

HpcsManagedKeyId 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]+$/.

State string

(String) The state of the key.

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

Tags List<HpcsManagedKeyTag>

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

InstanceId string

ID of UKO Instance

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

Label string

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

TemplateName string

Name of the key template to use when creating a key.

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-]+$/.

UkoVault string

The UUID of the Vault in which the update is to take place.

Vault HpcsManagedKeyVaultArgs

ID of the Vault where the entity is to be created in. Nested scheme for vault:

Description string

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

HpcsManagedKeyId 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]+$/.

State string

(String) The state of the key.

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

Tags []HpcsManagedKeyTagArgs

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

instanceId String

ID of UKO Instance

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

label String

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

templateName String

Name of the key template to use when creating a key.

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-]+$/.

ukoVault String

The UUID of the Vault in which the update is to take place.

vault HpcsManagedKeyVault

ID of the Vault where the entity is to be created in. Nested scheme for vault:

description String

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

hpcsManagedKeyId 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]+$/.

state String

(String) The state of the key.

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

tags List<HpcsManagedKeyTag>

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

instanceId string

ID of UKO Instance

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

label string

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

templateName string

Name of the key template to use when creating a key.

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-]+$/.

ukoVault string

The UUID of the Vault in which the update is to take place.

vault HpcsManagedKeyVault

ID of the Vault where the entity is to be created in. Nested scheme for vault:

description string

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

hpcsManagedKeyId 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]+$/.

state string

(String) The state of the key.

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

tags HpcsManagedKeyTag[]

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

instance_id str

ID of UKO Instance

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

label str

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

template_name str

Name of the key template to use when creating a key.

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-]+$/.

uko_vault str

The UUID of the Vault in which the update is to take place.

vault HpcsManagedKeyVaultArgs

ID of the Vault where the entity is to be created in. Nested scheme for vault:

description str

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

hpcs_managed_key_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]+$/.

state str

(String) The state of the key.

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

tags Sequence[HpcsManagedKeyTagArgs]

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

instanceId String

ID of UKO Instance

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

label String

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

templateName String

Name of the key template to use when creating a key.

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-]+$/.

ukoVault String

The UUID of the Vault in which the update is to take place.

vault Property Map

ID of the Vault where the entity is to be created in. Nested scheme for vault:

description String

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

hpcsManagedKeyId 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]+$/.

state String

(String) The state of the key.

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

tags List<Property Map>

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

Outputs

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

ActivationDate string

(String) First day when the key is active.

Algorithm string

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

CreatedAt string

(String) Date and time when the key was created.

CreatedBy string

(String) ID of the user that created 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-]+$/.

Etag string

ETag identifier for managed_key.

ExpirationDate string

(String) Last day when the key is active.

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.

Instances List<HpcsManagedKeyInstance>

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

KeyId string

The unique identifier of the managed_key.

ReferencedKeystores List<HpcsManagedKeyReferencedKeystore>

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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]+$/.

Templates List<HpcsManagedKeyTemplate>

(List) Reference to a key template. Nested scheme for template:

UpdatedAt string

(String) Date and time when the key was last updated.

UpdatedBy string

(String) ID of the user that last 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-]+$/.

VerificationPatterns List<HpcsManagedKeyVerificationPattern>

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

ActivationDate string

(String) First day when the key is active.

Algorithm string

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

CreatedAt string

(String) Date and time when the key was created.

CreatedBy string

(String) ID of the user that created 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-]+$/.

Etag string

ETag identifier for managed_key.

ExpirationDate string

(String) Last day when the key is active.

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.

Instances []HpcsManagedKeyInstance

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

KeyId string

The unique identifier of the managed_key.

ReferencedKeystores []HpcsManagedKeyReferencedKeystore

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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]+$/.

Templates []HpcsManagedKeyTemplate

(List) Reference to a key template. Nested scheme for template:

UpdatedAt string

(String) Date and time when the key was last updated.

UpdatedBy string

(String) ID of the user that last 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-]+$/.

VerificationPatterns []HpcsManagedKeyVerificationPattern

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

activationDate String

(String) First day when the key is active.

algorithm String

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

createdAt String

(String) Date and time when the key was created.

createdBy String

(String) ID of the user that created 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-]+$/.

etag String

ETag identifier for managed_key.

expirationDate String

(String) Last day when the key is active.

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.

instances List<HpcsManagedKeyInstance>

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

keyId String

The unique identifier of the managed_key.

referencedKeystores List<HpcsManagedKeyReferencedKeystore>

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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]+$/.

templates List<HpcsManagedKeyTemplate>

(List) Reference to a key template. Nested scheme for template:

updatedAt String

(String) Date and time when the key was last updated.

updatedBy String

(String) ID of the user that last 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-]+$/.

verificationPatterns List<HpcsManagedKeyVerificationPattern>

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

activationDate string

(String) First day when the key is active.

algorithm string

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

createdAt string

(String) Date and time when the key was created.

createdBy string

(String) ID of the user that created 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-]+$/.

etag string

ETag identifier for managed_key.

expirationDate string

(String) Last day when the key is active.

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.

instances HpcsManagedKeyInstance[]

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

keyId string

The unique identifier of the managed_key.

referencedKeystores HpcsManagedKeyReferencedKeystore[]

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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]+$/.

templates HpcsManagedKeyTemplate[]

(List) Reference to a key template. Nested scheme for template:

updatedAt string

(String) Date and time when the key was last updated.

updatedBy string

(String) ID of the user that last 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-]+$/.

verificationPatterns HpcsManagedKeyVerificationPattern[]

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

activation_date str

(String) First day when the key is active.

algorithm str

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

created_at str

(String) Date and time when the key was created.

created_by str

(String) ID of the user that created 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-]+$/.

etag str

ETag identifier for managed_key.

expiration_date str

(String) Last day when the key is active.

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.

instances Sequence[HpcsManagedKeyInstance]

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

key_id str

The unique identifier of the managed_key.

referenced_keystores Sequence[HpcsManagedKeyReferencedKeystore]

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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]+$/.

templates Sequence[HpcsManagedKeyTemplate]

(List) Reference to a key template. Nested scheme for template:

updated_at str

(String) Date and time when the key was last updated.

updated_by str

(String) ID of the user that last 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-]+$/.

verification_patterns Sequence[HpcsManagedKeyVerificationPattern]

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

activationDate String

(String) First day when the key is active.

algorithm String

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

createdAt String

(String) Date and time when the key was created.

createdBy String

(String) ID of the user that created 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-]+$/.

etag String

ETag identifier for managed_key.

expirationDate String

(String) Last day when the key is active.

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.

instances List<Property Map>

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

keyId String

The unique identifier of the managed_key.

referencedKeystores List<Property Map>

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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]+$/.

templates List<Property Map>

(List) Reference to a key template. Nested scheme for template:

updatedAt String

(String) Date and time when the key was last updated.

updatedBy String

(String) ID of the user that last 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-]+$/.

verificationPatterns List<Property Map>

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

Look up Existing HpcsManagedKey Resource

Get an existing HpcsManagedKey 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?: HpcsManagedKeyState, opts?: CustomResourceOptions): HpcsManagedKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activation_date: Optional[str] = None,
        algorithm: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        description: Optional[str] = None,
        etag: Optional[str] = None,
        expiration_date: Optional[str] = None,
        hpcs_managed_key_id: Optional[str] = None,
        href: Optional[str] = None,
        instance_id: Optional[str] = None,
        instances: Optional[Sequence[HpcsManagedKeyInstanceArgs]] = None,
        key_id: Optional[str] = None,
        label: Optional[str] = None,
        referenced_keystores: Optional[Sequence[HpcsManagedKeyReferencedKeystoreArgs]] = None,
        region: Optional[str] = None,
        size: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Sequence[HpcsManagedKeyTagArgs]] = None,
        template_name: Optional[str] = None,
        templates: Optional[Sequence[HpcsManagedKeyTemplateArgs]] = None,
        uko_vault: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        vault: Optional[HpcsManagedKeyVaultArgs] = None,
        verification_patterns: Optional[Sequence[HpcsManagedKeyVerificationPatternArgs]] = None) -> HpcsManagedKey

func GetHpcsManagedKey(ctx *Context, name string, id IDInput, state *HpcsManagedKeyState, opts ...ResourceOption) (*HpcsManagedKey, error)

public static HpcsManagedKey Get(string name, Input<string> id, HpcsManagedKeyState? state, CustomResourceOptions? opts = null)

public static HpcsManagedKey get(String name, Output<String> id, HpcsManagedKeyState state, CustomResourceOptions options)

resources:  _:    type: ibm:HpcsManagedKey    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ActivationDate string

(String) First day when the key is active.

Algorithm string

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

CreatedAt string

(String) Date and time when the key was created.

CreatedBy string

(String) ID of the user that created 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-]+$/.

Description string

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

Etag string

ETag identifier for managed_key.

ExpirationDate string

(String) Last day when the key is active.

HpcsManagedKeyId 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]+$/.

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.

Instances List<HpcsManagedKeyInstance>

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

KeyId string

The unique identifier of the managed_key.

Label string

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._ \/-]+$/.

ReferencedKeystores List<HpcsManagedKeyReferencedKeystore>

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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.

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 of the key.

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

Tags List<HpcsManagedKeyTag>

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

TemplateName string

Name of the key template to use when creating a key.

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-]+$/.

Templates List<HpcsManagedKeyTemplate>

(List) Reference to a key template. Nested scheme for template:

UkoVault string

The UUID of the Vault in which the update is to take place.

UpdatedAt string

(String) Date and time when the key was last updated.

UpdatedBy string

(String) ID of the user that last 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 HpcsManagedKeyVault

ID of the Vault where the entity is to be created in. Nested scheme for vault:

VerificationPatterns List<HpcsManagedKeyVerificationPattern>

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

ActivationDate string

(String) First day when the key is active.

Algorithm string

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

CreatedAt string

(String) Date and time when the key was created.

CreatedBy string

(String) ID of the user that created 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-]+$/.

Description string

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

Etag string

ETag identifier for managed_key.

ExpirationDate string

(String) Last day when the key is active.

HpcsManagedKeyId 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]+$/.

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.

Instances []HpcsManagedKeyInstanceArgs

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

KeyId string

The unique identifier of the managed_key.

Label string

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._ \/-]+$/.

ReferencedKeystores []HpcsManagedKeyReferencedKeystoreArgs

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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.

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 of the key.

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

Tags []HpcsManagedKeyTagArgs

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

TemplateName string

Name of the key template to use when creating a key.

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-]+$/.

Templates []HpcsManagedKeyTemplateArgs

(List) Reference to a key template. Nested scheme for template:

UkoVault string

The UUID of the Vault in which the update is to take place.

UpdatedAt string

(String) Date and time when the key was last updated.

UpdatedBy string

(String) ID of the user that last 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 HpcsManagedKeyVaultArgs

ID of the Vault where the entity is to be created in. Nested scheme for vault:

VerificationPatterns []HpcsManagedKeyVerificationPatternArgs

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

activationDate String

(String) First day when the key is active.

algorithm String

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

createdAt String

(String) Date and time when the key was created.

createdBy String

(String) ID of the user that created 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-]+$/.

description String

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

etag String

ETag identifier for managed_key.

expirationDate String

(String) Last day when the key is active.

hpcsManagedKeyId 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]+$/.

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.

instances List<HpcsManagedKeyInstance>

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

keyId String

The unique identifier of the managed_key.

label String

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._ \/-]+$/.

referencedKeystores List<HpcsManagedKeyReferencedKeystore>

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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.

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 of the key.

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

tags List<HpcsManagedKeyTag>

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

templateName String

Name of the key template to use when creating a key.

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-]+$/.

templates List<HpcsManagedKeyTemplate>

(List) Reference to a key template. Nested scheme for template:

ukoVault String

The UUID of the Vault in which the update is to take place.

updatedAt String

(String) Date and time when the key was last updated.

updatedBy String

(String) ID of the user that last 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 HpcsManagedKeyVault

ID of the Vault where the entity is to be created in. Nested scheme for vault:

verificationPatterns List<HpcsManagedKeyVerificationPattern>

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

activationDate string

(String) First day when the key is active.

algorithm string

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

createdAt string

(String) Date and time when the key was created.

createdBy string

(String) ID of the user that created 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-]+$/.

description string

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

etag string

ETag identifier for managed_key.

expirationDate string

(String) Last day when the key is active.

hpcsManagedKeyId 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]+$/.

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.

instances HpcsManagedKeyInstance[]

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

keyId string

The unique identifier of the managed_key.

label string

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._ \/-]+$/.

referencedKeystores HpcsManagedKeyReferencedKeystore[]

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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.

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 of the key.

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

tags HpcsManagedKeyTag[]

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

templateName string

Name of the key template to use when creating a key.

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-]+$/.

templates HpcsManagedKeyTemplate[]

(List) Reference to a key template. Nested scheme for template:

ukoVault string

The UUID of the Vault in which the update is to take place.

updatedAt string

(String) Date and time when the key was last updated.

updatedBy string

(String) ID of the user that last 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 HpcsManagedKeyVault

ID of the Vault where the entity is to be created in. Nested scheme for vault:

verificationPatterns HpcsManagedKeyVerificationPattern[]

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

activation_date str

(String) First day when the key is active.

algorithm str

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

created_at str

(String) Date and time when the key was created.

created_by str

(String) ID of the user that created 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-]+$/.

description str

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

etag str

ETag identifier for managed_key.

expiration_date str

(String) Last day when the key is active.

hpcs_managed_key_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]+$/.

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.

instances Sequence[HpcsManagedKeyInstanceArgs]

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

key_id str

The unique identifier of the managed_key.

label str

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._ \/-]+$/.

referenced_keystores Sequence[HpcsManagedKeyReferencedKeystoreArgs]

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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.

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 of the key.

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

tags Sequence[HpcsManagedKeyTagArgs]

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

template_name str

Name of the key template to use when creating a key.

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-]+$/.

templates Sequence[HpcsManagedKeyTemplateArgs]

(List) Reference to a key template. Nested scheme for template:

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 was last updated.

updated_by str

(String) ID of the user that last 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 HpcsManagedKeyVaultArgs

ID of the Vault where the entity is to be created in. Nested scheme for vault:

verification_patterns Sequence[HpcsManagedKeyVerificationPatternArgs]

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

activationDate String

(String) First day when the key is active.

algorithm String

(String) The algorithm of the key.

Constraints: Allowable values are: aes, rsa, hmac, ec.

createdAt String

(String) Date and time when the key was created.

createdBy String

(String) ID of the user that created 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-]+$/.

description String

Description of the managed key.

Constraints: The maximum length is 200 characters. The minimum length is 0 characters. The value must match regular expression /(.|\\n)*/.

etag String

ETag identifier for managed_key.

expirationDate String

(String) Last day when the key is active.

hpcsManagedKeyId 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]+$/.

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.

instances List<Property Map>

(List) key instances.

Constraints: The maximum length is 1 item. The minimum length is 1 item. Nested scheme for instances:

keyId String

The unique identifier of the managed_key.

label String

The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._ \/-]+$/.

referencedKeystores List<Property Map>

(List) referenced keystores.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for referenced_keystores:

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.

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 of the key.

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

tags List<Property Map>

Key-value pairs associated with the key.

Constraints: The maximum length is 128 items. The minimum length is 0 items. Nested scheme for tags:

templateName String

Name of the key template to use when creating a key.

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-]+$/.

templates List<Property Map>

(List) Reference to a key template. Nested scheme for template:

ukoVault String

The UUID of the Vault in which the update is to take place.

updatedAt String

(String) Date and time when the key was last updated.

updatedBy String

(String) ID of the user that last 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:

verificationPatterns List<Property Map>

(List) A list of verification patterns of the key (e.g. public key hash for RSA keys).

Constraints: The maximum length is 16 items. The minimum length is 1 item. Nested scheme for verification_patterns:

Supporting Types

HpcsManagedKeyInstance, HpcsManagedKeyInstanceArgs

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.

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]+$/.

Keystores List<HpcsManagedKeyInstanceKeystore>

(List) Description of properties of a key within the context of keystores. Nested scheme for keystore:

LabelInKeystore string

(String) The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

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]+$/.

Keystores []HpcsManagedKeyInstanceKeystore

(List) Description of properties of a key within the context of keystores. Nested scheme for keystore:

LabelInKeystore string

(String) The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

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]+$/.

keystores List<HpcsManagedKeyInstanceKeystore>

(List) Description of properties of a key within the context of keystores. Nested scheme for keystore:

labelInKeystore String

(String) The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

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]+$/.

keystores HpcsManagedKeyInstanceKeystore[]

(List) Description of properties of a key within the context of keystores. Nested scheme for keystore:

labelInKeystore string

(String) The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

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]+$/.

keystores Sequence[HpcsManagedKeyInstanceKeystore]

(List) Description of properties of a key within the context of keystores. Nested scheme for keystore:

label_in_keystore str

(String) The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[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.

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]+$/.

keystores List<Property Map>

(List) Description of properties of a key within the context of keystores. Nested scheme for keystore:

labelInKeystore String

(String) The label of the key.

Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9._ \/-]+$/.

type String

(String) Type of keystore.

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

HpcsManagedKeyInstanceKeystore, HpcsManagedKeyInstanceKeystoreArgs

Group string

(String)

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_ -]+$/.

Type string

(String) Type of keystore.

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

Group string

(String)

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_ -]+$/.

Type string

(String) Type of keystore.

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

group String

(String)

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_ -]+$/.

type String

(String) Type of keystore.

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

group string

(String)

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_ -]+$/.

type string

(String) Type of keystore.

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

group str

(String)

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_ -]+$/.

type str

(String) Type of keystore.

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

group String

(String)

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_ -]+$/.

type String

(String) Type of keystore.

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

HpcsManagedKeyReferencedKeystore, HpcsManagedKeyReferencedKeystoreArgs

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 key template.

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-]*$/.

Type string

(String) Type of keystore.

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

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 key template.

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-]*$/.

Type string

(String) Type of keystore.

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

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 key template.

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-]*$/.

type String

(String) Type of keystore.

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

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 key template.

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-]*$/.

type string

(String) Type of keystore.

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

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 key template.

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-]*$/.

type str

(String) Type of keystore.

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

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 key template.

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-]*$/.

type String

(String) Type of keystore.

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

HpcsManagedKeyTag, HpcsManagedKeyTagArgs

Name string

Name of a tag.

Constraints: The maximum length is 254 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9 -_]+$/.

Value string

Value of a tag.

Constraints: The maximum length is 8192 characters. The minimum length is 0 characters. The value must match regular expression /^(\\w|\\s)*$/.

Name string

Name of a tag.

Constraints: The maximum length is 254 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9 -_]+$/.

Value string

Value of a tag.

Constraints: The maximum length is 8192 characters. The minimum length is 0 characters. The value must match regular expression /^(\\w|\\s)*$/.

name String

Name of a tag.

Constraints: The maximum length is 254 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9 -_]+$/.

value String

Value of a tag.

Constraints: The maximum length is 8192 characters. The minimum length is 0 characters. The value must match regular expression /^(\\w|\\s)*$/.

name string

Name of a tag.

Constraints: The maximum length is 254 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9 -_]+$/.

value string

Value of a tag.

Constraints: The maximum length is 8192 characters. The minimum length is 0 characters. The value must match regular expression /^(\\w|\\s)*$/.

name str

Name of a tag.

Constraints: The maximum length is 254 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9 -_]+$/.

value str

Value of a tag.

Constraints: The maximum length is 8192 characters. The minimum length is 0 characters. The value must match regular expression /^(\\w|\\s)*$/.

name String

Name of a tag.

Constraints: The maximum length is 254 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9 -_]+$/.

value String

Value of a tag.

Constraints: The maximum length is 8192 characters. The minimum length is 0 characters. The value must match regular expression /^(\\w|\\s)*$/.

HpcsManagedKeyTemplate, HpcsManagedKeyTemplateArgs

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 key template.

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-]*$/.

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 key template.

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-]*$/.

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 key template.

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-]*$/.

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 key template.

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-]*$/.

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 key template.

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-]*$/.

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 key template.

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-]*$/.

HpcsManagedKeyVault, HpcsManagedKeyVaultArgs

Id 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 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 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 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 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 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]+$/.

HpcsManagedKeyVerificationPattern, HpcsManagedKeyVerificationPatternArgs

Method string

(String) The method used for calculating the verification pattern.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9-]+$/.

Value string

(String) The calculated value.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9+\/=]+$/.

Method string

(String) The method used for calculating the verification pattern.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9-]+$/.

Value string

(String) The calculated value.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9+\/=]+$/.

method String

(String) The method used for calculating the verification pattern.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9-]+$/.

value String

(String) The calculated value.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9+\/=]+$/.

method string

(String) The method used for calculating the verification pattern.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9-]+$/.

value string

(String) The calculated value.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9+\/=]+$/.

method str

(String) The method used for calculating the verification pattern.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9-]+$/.

value str

(String) The calculated value.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9+\/=]+$/.

method String

(String) The method used for calculating the verification pattern.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9-]+$/.

value String

(String) The calculated value.

Constraints: The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /^[A-Za-z0-9+\/=]+$/.

Import

You can import the ibm_hpcs_managed_key resource by using region, instance_id, vault_id, and key_id.

Syntax

bash

$ pulumi import ibm:index/hpcsManagedKey:HpcsManagedKey key <region>/<instance_id>/<vault_id>/<key_id>

Example

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

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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.HpcsManagedKey

On this page

On this page

Example Usage

Create HpcsManagedKey Resource

Constructor syntax

Parameters

Constructor example

HpcsManagedKey Resource Properties

Inputs

Outputs

Look up Existing HpcsManagedKey Resource

Supporting Types

HpcsManagedKeyInstance, HpcsManagedKeyInstanceArgs

HpcsManagedKeyInstanceKeystore, HpcsManagedKeyInstanceKeystoreArgs

HpcsManagedKeyReferencedKeystore, HpcsManagedKeyReferencedKeystoreArgs

HpcsManagedKeyTag, HpcsManagedKeyTagArgs

HpcsManagedKeyTemplate, HpcsManagedKeyTemplateArgs

HpcsManagedKeyVault, HpcsManagedKeyVaultArgs

HpcsManagedKeyVerificationPattern, HpcsManagedKeyVerificationPatternArgs

Import

Package Details

On this page

On this page