com.pulumi.azure.keyvault.kotlin.ManagedHardwareSecurityModuleArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.keyvault.kotlin
import com.pulumi.azure.keyvault.ManagedHardwareSecurityModuleArgs.builder
import com.pulumi.azure.keyvault.kotlin.inputs.ManagedHardwareSecurityModuleNetworkAclsArgs
import com.pulumi.azure.keyvault.kotlin.inputs.ManagedHardwareSecurityModuleNetworkAclsArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Int
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* 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
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const current = azure.core.getClientConfig({});
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleManagedHardwareSecurityModule = new azure.keyvault.ManagedHardwareSecurityModule("example", {
* name: "exampleKVHsm",
* resourceGroupName: example.name,
* location: example.location,
* skuName: "Standard_B1",
* purgeProtectionEnabled: false,
* softDeleteRetentionDays: 90,
* tenantId: current.then(current => current.tenantId),
* adminObjectIds: [current.then(current => current.objectId)],
* tags: {
* Env: "Test",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* current = azure.core.get_client_config()
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_managed_hardware_security_module = azure.keyvault.ManagedHardwareSecurityModule("example",
* name="exampleKVHsm",
* resource_group_name=example.name,
* location=example.location,
* sku_name="Standard_B1",
* purge_protection_enabled=False,
* soft_delete_retention_days=90,
* tenant_id=current.tenant_id,
* admin_object_ids=[current.object_id],
* tags={
* "Env": "Test",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var current = Azure.Core.GetClientConfig.Invoke();
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleManagedHardwareSecurityModule = new Azure.KeyVault.ManagedHardwareSecurityModule("example", new()
* {
* Name = "exampleKVHsm",
* ResourceGroupName = example.Name,
* Location = example.Location,
* SkuName = "Standard_B1",
* PurgeProtectionEnabled = false,
* SoftDeleteRetentionDays = 90,
* TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
* AdminObjectIds = new[]
* {
* current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
* },
* Tags =
* {
* { "Env", "Test" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/keyvault"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* current, err := core.GetClientConfig(ctx, nil, nil)
* if err != nil {
* return err
* }
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* _, err = keyvault.NewManagedHardwareSecurityModule(ctx, "example", &keyvault.ManagedHardwareSecurityModuleArgs{
* Name: pulumi.String("exampleKVHsm"),
* ResourceGroupName: example.Name,
* Location: example.Location,
* SkuName: pulumi.String("Standard_B1"),
* PurgeProtectionEnabled: pulumi.Bool(false),
* SoftDeleteRetentionDays: pulumi.Int(90),
* TenantId: pulumi.String(current.TenantId),
* AdminObjectIds: pulumi.StringArray{
* pulumi.String(current.ObjectId),
* },
* Tags: pulumi.StringMap{
* "Env": pulumi.String("Test"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleManagedHardwareSecurityModule = new ManagedHardwareSecurityModule("exampleManagedHardwareSecurityModule", ManagedHardwareSecurityModuleArgs.builder()
* .name("exampleKVHsm")
* .resourceGroupName(example.name())
* .location(example.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());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleManagedHardwareSecurityModule:
* type: azure:keyvault:ManagedHardwareSecurityModule
* name: example
* properties:
* name: exampleKVHsm
* resourceGroupName: ${example.name}
* location: ${example.location}
* skuName: Standard_B1
* purgeProtectionEnabled: false
* softDeleteRetentionDays: 90
* tenantId: ${current.tenantId}
* adminObjectIds:
* - ${current.objectId}
* tags:
* Env: Test
* variables:
* current:
* fn::invoke:
* Function: azure:core:getClientConfig
* Arguments: {}
* ```
*
* ## Import
* Key Vault Managed Hardware Security Module can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:keyvault/managedHardwareSecurityModule:ManagedHardwareSecurityModule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.KeyVault/managedHSMs/hsm1
* ```
* @property adminObjectIds Specifies a list of administrators object IDs for the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.
* @property location Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
* @property name Specifies the name of the Key Vault Managed Hardware Security Module. Changing this forces a new resource to be created.
* @property networkAcls A `network_acls` block as defined below.
* @property publicNetworkAccessEnabled Whether traffic from public networks is permitted. Defaults to `true`. Changing this forces a new resource to be created.
* @property purgeProtectionEnabled Is Purge Protection enabled for this Key Vault Managed Hardware Security Module? Changing this forces a new resource to be created.
* @property resourceGroupName 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.
* @property securityDomainKeyVaultCertificateIds 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](https://learn.microsoft.com/azure/key-vault/managed-hsm/quick-create-cli#activate-your-managed-hsm)
* @property securityDomainQuorum 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.
* @property skuName 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.
* @property softDeleteRetentionDays 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.
* @property tags A mapping of tags to assign to the resource.
* @property tenantId The Azure Active Directory Tenant ID that should be used for authenticating requests to the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
public data class ManagedHardwareSecurityModuleArgs(
public val adminObjectIds: Output>? = null,
public val location: Output? = null,
public val name: Output? = null,
public val networkAcls: Output? = null,
public val publicNetworkAccessEnabled: Output? = null,
public val purgeProtectionEnabled: Output? = null,
public val resourceGroupName: Output? = null,
public val securityDomainKeyVaultCertificateIds: Output>? = null,
public val securityDomainQuorum: Output? = null,
public val skuName: Output? = null,
public val softDeleteRetentionDays: Output? = null,
public val tags: Output>? = null,
public val tenantId: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.keyvault.ManagedHardwareSecurityModuleArgs =
com.pulumi.azure.keyvault.ManagedHardwareSecurityModuleArgs.builder()
.adminObjectIds(adminObjectIds?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.location(location?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.networkAcls(networkAcls?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.publicNetworkAccessEnabled(publicNetworkAccessEnabled?.applyValue({ args0 -> args0 }))
.purgeProtectionEnabled(purgeProtectionEnabled?.applyValue({ args0 -> args0 }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.securityDomainKeyVaultCertificateIds(
securityDomainKeyVaultCertificateIds?.applyValue({ args0 ->
args0.map({ args0 -> args0 })
}),
)
.securityDomainQuorum(securityDomainQuorum?.applyValue({ args0 -> args0 }))
.skuName(skuName?.applyValue({ args0 -> args0 }))
.softDeleteRetentionDays(softDeleteRetentionDays?.applyValue({ args0 -> args0 }))
.tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.tenantId(tenantId?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ManagedHardwareSecurityModuleArgs].
*/
@PulumiTagMarker
public class ManagedHardwareSecurityModuleArgsBuilder internal constructor() {
private var adminObjectIds: Output>? = null
private var location: Output? = null
private var name: Output? = null
private var networkAcls: Output? = null
private var publicNetworkAccessEnabled: Output? = null
private var purgeProtectionEnabled: Output? = null
private var resourceGroupName: Output? = null
private var securityDomainKeyVaultCertificateIds: Output>? = null
private var securityDomainQuorum: Output? = null
private var skuName: Output? = null
private var softDeleteRetentionDays: Output? = null
private var tags: Output>? = null
private var tenantId: Output? = null
/**
* @param value Specifies a list of administrators object IDs for the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
@JvmName("viyhspsnprdocuqf")
public suspend fun adminObjectIds(`value`: Output>) {
this.adminObjectIds = value
}
@JvmName("ehdsdhtqgnfaedpm")
public suspend fun adminObjectIds(vararg values: Output) {
this.adminObjectIds = Output.all(values.asList())
}
/**
* @param values Specifies a list of administrators object IDs for the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
@JvmName("ecrykcaoavqbdklg")
public suspend fun adminObjectIds(values: List>) {
this.adminObjectIds = Output.all(values)
}
/**
* @param value Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*/
@JvmName("mqyaopurwmtfssqn")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value Specifies the name of the Key Vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
@JvmName("qnupmfnrievwlrkx")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A `network_acls` block as defined below.
*/
@JvmName("eitxnwyfxpvyfvmg")
public suspend fun networkAcls(`value`: Output) {
this.networkAcls = value
}
/**
* @param value Whether traffic from public networks is permitted. Defaults to `true`. Changing this forces a new resource to be created.
*/
@JvmName("lskvfjmtmkdjppmg")
public suspend fun publicNetworkAccessEnabled(`value`: Output) {
this.publicNetworkAccessEnabled = value
}
/**
* @param value Is Purge Protection enabled for this Key Vault Managed Hardware Security Module? Changing this forces a new resource to be created.
*/
@JvmName("epbhcxcflahqjein")
public suspend fun purgeProtectionEnabled(`value`: Output) {
this.purgeProtectionEnabled = value
}
/**
* @param value 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.
*/
@JvmName("qmrcdribmjmlfryo")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value 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](https://learn.microsoft.com/azure/key-vault/managed-hsm/quick-create-cli#activate-your-managed-hsm)
*/
@JvmName("pkpkyvgynfuglyqu")
public suspend fun securityDomainKeyVaultCertificateIds(`value`: Output>) {
this.securityDomainKeyVaultCertificateIds = value
}
@JvmName("wcbqiuwlopsyfefn")
public suspend fun securityDomainKeyVaultCertificateIds(vararg values: Output) {
this.securityDomainKeyVaultCertificateIds = Output.all(values.asList())
}
/**
* @param values 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](https://learn.microsoft.com/azure/key-vault/managed-hsm/quick-create-cli#activate-your-managed-hsm)
*/
@JvmName("xcgxarahaeefgwfk")
public suspend fun securityDomainKeyVaultCertificateIds(values: List>) {
this.securityDomainKeyVaultCertificateIds = Output.all(values)
}
/**
* @param value 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.
*/
@JvmName("evfwxgidvapmdlyd")
public suspend fun securityDomainQuorum(`value`: Output) {
this.securityDomainQuorum = value
}
/**
* @param value 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.
*/
@JvmName("yyvpecoiqbrwoojq")
public suspend fun skuName(`value`: Output) {
this.skuName = value
}
/**
* @param value 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.
*/
@JvmName("xijywwgjywggvkak")
public suspend fun softDeleteRetentionDays(`value`: Output) {
this.softDeleteRetentionDays = value
}
/**
* @param value A mapping of tags to assign to the resource.
*/
@JvmName("hseojlhnipkyexbu")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value The Azure Active Directory Tenant ID that should be used for authenticating requests to the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
@JvmName("kmjmwvgekovxiuld")
public suspend fun tenantId(`value`: Output) {
this.tenantId = value
}
/**
* @param value Specifies a list of administrators object IDs for the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
@JvmName("curircexhynwvppk")
public suspend fun adminObjectIds(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.adminObjectIds = mapped
}
/**
* @param values Specifies a list of administrators object IDs for the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
@JvmName("blxemnkkblxokjil")
public suspend fun adminObjectIds(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.adminObjectIds = mapped
}
/**
* @param value Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*/
@JvmName("xtkbdlrmyfililqv")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value Specifies the name of the Key Vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
@JvmName("ucfpinlaqgykcqns")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value A `network_acls` block as defined below.
*/
@JvmName("voqxwlxvwcugpasn")
public suspend fun networkAcls(`value`: ManagedHardwareSecurityModuleNetworkAclsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.networkAcls = mapped
}
/**
* @param argument A `network_acls` block as defined below.
*/
@JvmName("lfyjrouixqhlrtfq")
public suspend
fun networkAcls(argument: suspend ManagedHardwareSecurityModuleNetworkAclsArgsBuilder.() -> Unit) {
val toBeMapped = ManagedHardwareSecurityModuleNetworkAclsArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.networkAcls = mapped
}
/**
* @param value Whether traffic from public networks is permitted. Defaults to `true`. Changing this forces a new resource to be created.
*/
@JvmName("mftmpkwbvgxqpqob")
public suspend fun publicNetworkAccessEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.publicNetworkAccessEnabled = mapped
}
/**
* @param value Is Purge Protection enabled for this Key Vault Managed Hardware Security Module? Changing this forces a new resource to be created.
*/
@JvmName("jtnwrycshxdslbwl")
public suspend fun purgeProtectionEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.purgeProtectionEnabled = mapped
}
/**
* @param value 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.
*/
@JvmName("ndytieypavxpxdsf")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value 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](https://learn.microsoft.com/azure/key-vault/managed-hsm/quick-create-cli#activate-your-managed-hsm)
*/
@JvmName("ktbwjyctydhcrkuh")
public suspend fun securityDomainKeyVaultCertificateIds(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.securityDomainKeyVaultCertificateIds = mapped
}
/**
* @param values 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](https://learn.microsoft.com/azure/key-vault/managed-hsm/quick-create-cli#activate-your-managed-hsm)
*/
@JvmName("bjoxxbkgommekapj")
public suspend fun securityDomainKeyVaultCertificateIds(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.securityDomainKeyVaultCertificateIds = mapped
}
/**
* @param value 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.
*/
@JvmName("etnmcofoukroufnq")
public suspend fun securityDomainQuorum(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.securityDomainQuorum = mapped
}
/**
* @param value 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.
*/
@JvmName("qjxenuawismgxwlo")
public suspend fun skuName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.skuName = mapped
}
/**
* @param value 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.
*/
@JvmName("hwbwehnmrseciwui")
public suspend fun softDeleteRetentionDays(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.softDeleteRetentionDays = mapped
}
/**
* @param value A mapping of tags to assign to the resource.
*/
@JvmName("mjltgjuytekbfxkk")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values A mapping of tags to assign to the resource.
*/
@JvmName("rkeivxxwwtexdiao")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value The Azure Active Directory Tenant ID that should be used for authenticating requests to the key vault Managed Hardware Security Module. Changing this forces a new resource to be created.
*/
@JvmName("mfxtldbwjfearsps")
public suspend fun tenantId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tenantId = mapped
}
internal fun build(): ManagedHardwareSecurityModuleArgs = ManagedHardwareSecurityModuleArgs(
adminObjectIds = adminObjectIds,
location = location,
name = name,
networkAcls = networkAcls,
publicNetworkAccessEnabled = publicNetworkAccessEnabled,
purgeProtectionEnabled = purgeProtectionEnabled,
resourceGroupName = resourceGroupName,
securityDomainKeyVaultCertificateIds = securityDomainKeyVaultCertificateIds,
securityDomainQuorum = securityDomainQuorum,
skuName = skuName,
softDeleteRetentionDays = softDeleteRetentionDays,
tags = tags,
tenantId = tenantId,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy