pulumi-azure-kotlin/com.pulumi.azure.keyvault.kotlin/ManagedHardwareSecurityModule

ManagedHardwareSecurityModule

class ManagedHardwareSecurityModule : KotlinCustomResource

Manages a Key Vault Managed Hardware Security Module.

Note: The Azure Provider includes a Feature Toggle which will purge a Key Vault Managed Hardware Security Module resource on destroy, rather than the default soft-delete. See purge_soft_deleted_hardware_security_modules_on_destroy for more information.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.keyvault.ManagedHardwareSecurityModule;
import com.pulumi.azure.keyvault.ManagedHardwareSecurityModuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var current = CoreFunctions.getClientConfig();
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleManagedHardwareSecurityModule = new ManagedHardwareSecurityModule("exampleManagedHardwareSecurityModule", ManagedHardwareSecurityModuleArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .skuName("Standard_B1")
            .purgeProtectionEnabled(false)
            .softDeleteRetentionDays(90)
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .adminObjectIds(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .tags(Map.of("Env", "Test"))
            .build());
    }
}

Import

Key Vault Managed Hardware Security Module can be imported using the resource id, e.g.

$ pulumi import azure:keyvault/managedHardwareSecurityModule:ManagedHardwareSecurityModule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.KeyVault/managedHSMs/hsm1

Properties

adminObjectIds

val adminObjectIds: Output<List<String>>

Specifies a list of administrators object IDs for the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.

hsmUri

val hsmUri: Output<String>

The URI of the Key Vault Managed Hardware Security Module, used for performing operations on keys.

val id: Output<String>

location

val location: Output<String>

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name

val name: Output<String>

Specifies the name of the Key Vault Managed Hardware Security Module. Changing this forces a new resource to be created.

networkAcls

val networkAcls: Output<ManagedHardwareSecurityModuleNetworkAcls>

A network_acls block as defined below.

publicNetworkAccessEnabled

val publicNetworkAccessEnabled: Output<Boolean>?

Whether traffic from public networks is permitted. Defaults to true. Changing this forces a new resource to be created.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

purgeProtectionEnabled

val purgeProtectionEnabled: Output<Boolean>?

Is Purge Protection enabled for this Key Vault Managed Hardware Security Module? Changing this forces a new resource to be created.

resourceGroupName

val resourceGroupName: Output<String>

The name of the resource group in which to create the Key Vault Managed Hardware Security Module. Changing this forces a new resource to be created.

securityDomainEncryptedData

val securityDomainEncryptedData: Output<String>

This attribute can be used for disaster recovery or when creating another Managed HSM that shares the same security domain.

securityDomainKeyVaultCertificateIds

val securityDomainKeyVaultCertificateIds: Output<List<String>>?

A list of KeyVault certificates resource IDs (minimum of three and up to a maximum of 10) to activate this Managed HSM. More information see activate-your-managed-hsm

securityDomainQuorum

val securityDomainQuorum: Output<Int>?

Specifies the minimum number of shares required to decrypt the security domain for recovery. This is required when security_domain_key_vault_certificate_ids is specified. Valid values are between 2 and 10.

skuName

val skuName: Output<String>

The Name of the SKU used for this Key Vault Managed Hardware Security Module. Possible value is Standard_B1. Changing this forces a new resource to be created.

softDeleteRetentionDays

val softDeleteRetentionDays: Output<Int>?

The number of days that items should be retained for once soft-deleted. This value can be between 7 and 90 days. Defaults to 90. Changing this forces a new resource to be created.