com.pulumi.gcp.kms.kotlin.CryptoKeyArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.kms.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.kms.CryptoKeyArgs.builder
import com.pulumi.gcp.kms.kotlin.inputs.CryptoKeyVersionTemplateArgs
import com.pulumi.gcp.kms.kotlin.inputs.CryptoKeyVersionTemplateArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* A `CryptoKey` represents a logical key that can be used for cryptographic operations.
* > **Note:** CryptoKeys cannot be deleted from Google Cloud Platform.
* Destroying a provider-managed CryptoKey will remove it from state
* and delete all CryptoKeyVersions, rendering the key unusable, but *will
* not delete the resource from the project.* When the provider destroys these keys,
* any data previously encrypted with these keys will be irrecoverable.
* For this reason, it is strongly recommended that you add
* lifecycle
* hooks to the resource to prevent accidental destruction.
* To get more information about CryptoKey, see:
* * [API documentation](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys)
* * How-to Guides
* * [Creating a key](https://cloud.google.com/kms/docs/creating-keys#create_a_key)
* ## Example Usage
* ### Kms Crypto Key Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const keyring = new gcp.kms.KeyRing("keyring", {
* name: "keyring-example",
* location: "global",
* });
* const example_key = new gcp.kms.CryptoKey("example-key", {
* name: "crypto-key-example",
* keyRing: keyring.id,
* rotationPeriod: "7776000s",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* keyring = gcp.kms.KeyRing("keyring",
* name="keyring-example",
* location="global")
* example_key = gcp.kms.CryptoKey("example-key",
* name="crypto-key-example",
* key_ring=keyring.id,
* rotation_period="7776000s")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var keyring = new Gcp.Kms.KeyRing("keyring", new()
* {
* Name = "keyring-example",
* Location = "global",
* });
* var example_key = new Gcp.Kms.CryptoKey("example-key", new()
* {
* Name = "crypto-key-example",
* KeyRing = keyring.Id,
* RotationPeriod = "7776000s",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* keyring, err := kms.NewKeyRing(ctx, "keyring", &kms.KeyRingArgs{
* Name: pulumi.String("keyring-example"),
* Location: pulumi.String("global"),
* })
* if err != nil {
* return err
* }
* _, err = kms.NewCryptoKey(ctx, "example-key", &kms.CryptoKeyArgs{
* Name: pulumi.String("crypto-key-example"),
* KeyRing: keyring.ID(),
* RotationPeriod: pulumi.String("7776000s"),
* })
* 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.gcp.kms.KeyRing;
* import com.pulumi.gcp.kms.KeyRingArgs;
* import com.pulumi.gcp.kms.CryptoKey;
* import com.pulumi.gcp.kms.CryptoKeyArgs;
* 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 keyring = new KeyRing("keyring", KeyRingArgs.builder()
* .name("keyring-example")
* .location("global")
* .build());
* var example_key = new CryptoKey("example-key", CryptoKeyArgs.builder()
* .name("crypto-key-example")
* .keyRing(keyring.id())
* .rotationPeriod("7776000s")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* keyring:
* type: gcp:kms:KeyRing
* properties:
* name: keyring-example
* location: global
* example-key:
* type: gcp:kms:CryptoKey
* properties:
* name: crypto-key-example
* keyRing: ${keyring.id}
* rotationPeriod: 7776000s
* ```
*
* ### Kms Crypto Key Asymmetric Sign
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const keyring = new gcp.kms.KeyRing("keyring", {
* name: "keyring-example",
* location: "global",
* });
* const example_asymmetric_sign_key = new gcp.kms.CryptoKey("example-asymmetric-sign-key", {
* name: "crypto-key-example",
* keyRing: keyring.id,
* purpose: "ASYMMETRIC_SIGN",
* versionTemplate: {
* algorithm: "EC_SIGN_P384_SHA384",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* keyring = gcp.kms.KeyRing("keyring",
* name="keyring-example",
* location="global")
* example_asymmetric_sign_key = gcp.kms.CryptoKey("example-asymmetric-sign-key",
* name="crypto-key-example",
* key_ring=keyring.id,
* purpose="ASYMMETRIC_SIGN",
* version_template=gcp.kms.CryptoKeyVersionTemplateArgs(
* algorithm="EC_SIGN_P384_SHA384",
* ))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var keyring = new Gcp.Kms.KeyRing("keyring", new()
* {
* Name = "keyring-example",
* Location = "global",
* });
* var example_asymmetric_sign_key = new Gcp.Kms.CryptoKey("example-asymmetric-sign-key", new()
* {
* Name = "crypto-key-example",
* KeyRing = keyring.Id,
* Purpose = "ASYMMETRIC_SIGN",
* VersionTemplate = new Gcp.Kms.Inputs.CryptoKeyVersionTemplateArgs
* {
* Algorithm = "EC_SIGN_P384_SHA384",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* keyring, err := kms.NewKeyRing(ctx, "keyring", &kms.KeyRingArgs{
* Name: pulumi.String("keyring-example"),
* Location: pulumi.String("global"),
* })
* if err != nil {
* return err
* }
* _, err = kms.NewCryptoKey(ctx, "example-asymmetric-sign-key", &kms.CryptoKeyArgs{
* Name: pulumi.String("crypto-key-example"),
* KeyRing: keyring.ID(),
* Purpose: pulumi.String("ASYMMETRIC_SIGN"),
* VersionTemplate: &kms.CryptoKeyVersionTemplateArgs{
* Algorithm: pulumi.String("EC_SIGN_P384_SHA384"),
* },
* })
* 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.gcp.kms.KeyRing;
* import com.pulumi.gcp.kms.KeyRingArgs;
* import com.pulumi.gcp.kms.CryptoKey;
* import com.pulumi.gcp.kms.CryptoKeyArgs;
* import com.pulumi.gcp.kms.inputs.CryptoKeyVersionTemplateArgs;
* 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 keyring = new KeyRing("keyring", KeyRingArgs.builder()
* .name("keyring-example")
* .location("global")
* .build());
* var example_asymmetric_sign_key = new CryptoKey("example-asymmetric-sign-key", CryptoKeyArgs.builder()
* .name("crypto-key-example")
* .keyRing(keyring.id())
* .purpose("ASYMMETRIC_SIGN")
* .versionTemplate(CryptoKeyVersionTemplateArgs.builder()
* .algorithm("EC_SIGN_P384_SHA384")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* keyring:
* type: gcp:kms:KeyRing
* properties:
* name: keyring-example
* location: global
* example-asymmetric-sign-key:
* type: gcp:kms:CryptoKey
* properties:
* name: crypto-key-example
* keyRing: ${keyring.id}
* purpose: ASYMMETRIC_SIGN
* versionTemplate:
* algorithm: EC_SIGN_P384_SHA384
* ```
*
* ## Import
* CryptoKey can be imported using any of these accepted formats:
* * `{{key_ring}}/cryptoKeys/{{name}}`
* * `{{key_ring}}/{{name}}`
* When using the `pulumi import` command, CryptoKey can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:kms/cryptoKey:CryptoKey default {{key_ring}}/cryptoKeys/{{name}}
* ```
* ```sh
* $ pulumi import gcp:kms/cryptoKey:CryptoKey default {{key_ring}}/{{name}}
* ```
* @property cryptoKeyBackend The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey.
* The resource name is in the format "projects/*/locations/*/ekmConnections/*" and only applies to "EXTERNAL_VPC" keys.
* @property destroyScheduledDuration The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.
* If not specified at creation time, the default duration is 24 hours.
* @property importOnly Whether this key may contain imported versions only.
* @property keyRing The KeyRing that this key belongs to.
* Format: `'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'`.
* - - -
* @property labels Labels with user-defined metadata to apply to this resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
* @property name The resource name for the CryptoKey.
* @property purpose The immutable purpose of this CryptoKey. See the
* [purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose)
* for possible inputs.
* Default value is "ENCRYPT_DECRYPT".
* @property rotationPeriod Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.
* The first rotation will take place after the specified period. The rotation period has
* the format of a decimal number with up to 9 fractional digits, followed by the
* letter `s` (seconds). It must be greater than a day (ie, 86400).
* @property skipInitialVersionCreation If set to true, the request will create a CryptoKey without any CryptoKeyVersions.
* You must use the `gcp.kms.KeyRingImportJob` resource to import the CryptoKeyVersion.
* @property versionTemplate A template describing settings for new crypto key versions.
* Structure is documented below.
* */*/*/
*/
public data class CryptoKeyArgs(
public val cryptoKeyBackend: Output? = null,
public val destroyScheduledDuration: Output? = null,
public val importOnly: Output? = null,
public val keyRing: Output? = null,
public val labels: Output>? = null,
public val name: Output? = null,
public val purpose: Output? = null,
public val rotationPeriod: Output? = null,
public val skipInitialVersionCreation: Output? = null,
public val versionTemplate: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.kms.CryptoKeyArgs =
com.pulumi.gcp.kms.CryptoKeyArgs.builder()
.cryptoKeyBackend(cryptoKeyBackend?.applyValue({ args0 -> args0 }))
.destroyScheduledDuration(destroyScheduledDuration?.applyValue({ args0 -> args0 }))
.importOnly(importOnly?.applyValue({ args0 -> args0 }))
.keyRing(keyRing?.applyValue({ args0 -> args0 }))
.labels(labels?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.name(name?.applyValue({ args0 -> args0 }))
.purpose(purpose?.applyValue({ args0 -> args0 }))
.rotationPeriod(rotationPeriod?.applyValue({ args0 -> args0 }))
.skipInitialVersionCreation(skipInitialVersionCreation?.applyValue({ args0 -> args0 }))
.versionTemplate(
versionTemplate?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
).build()
}
/**
* Builder for [CryptoKeyArgs].
*/
@PulumiTagMarker
public class CryptoKeyArgsBuilder internal constructor() {
private var cryptoKeyBackend: Output? = null
private var destroyScheduledDuration: Output? = null
private var importOnly: Output? = null
private var keyRing: Output? = null
private var labels: Output>? = null
private var name: Output? = null
private var purpose: Output? = null
private var rotationPeriod: Output? = null
private var skipInitialVersionCreation: Output? = null
private var versionTemplate: Output? = null
/**
* @param value The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey.
* The resource name is in the format "projects/*/locations/*/ekmConnections/*" and only applies to "EXTERNAL_VPC" keys.
* */*/*/
*/
@JvmName("opgjjgomxeqxumqh")
public suspend fun cryptoKeyBackend(`value`: Output) {
this.cryptoKeyBackend = value
}
/**
* @param value The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.
* If not specified at creation time, the default duration is 24 hours.
*/
@JvmName("oyciynmnnyybgkug")
public suspend fun destroyScheduledDuration(`value`: Output) {
this.destroyScheduledDuration = value
}
/**
* @param value Whether this key may contain imported versions only.
*/
@JvmName("vexxcpjdowaljdlw")
public suspend fun importOnly(`value`: Output) {
this.importOnly = value
}
/**
* @param value The KeyRing that this key belongs to.
* Format: `'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'`.
* - - -
*/
@JvmName("uvavspikpajsjiwg")
public suspend fun keyRing(`value`: Output) {
this.keyRing = value
}
/**
* @param value Labels with user-defined metadata to apply to this resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
@JvmName("awusaceynbraoisk")
public suspend fun labels(`value`: Output>) {
this.labels = value
}
/**
* @param value The resource name for the CryptoKey.
*/
@JvmName("rhsghmjmeedfhnam")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The immutable purpose of this CryptoKey. See the
* [purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose)
* for possible inputs.
* Default value is "ENCRYPT_DECRYPT".
*/
@JvmName("cfvdwfgxomawhbew")
public suspend fun purpose(`value`: Output) {
this.purpose = value
}
/**
* @param value Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.
* The first rotation will take place after the specified period. The rotation period has
* the format of a decimal number with up to 9 fractional digits, followed by the
* letter `s` (seconds). It must be greater than a day (ie, 86400).
*/
@JvmName("bjggkdvdsahcgdbv")
public suspend fun rotationPeriod(`value`: Output) {
this.rotationPeriod = value
}
/**
* @param value If set to true, the request will create a CryptoKey without any CryptoKeyVersions.
* You must use the `gcp.kms.KeyRingImportJob` resource to import the CryptoKeyVersion.
*/
@JvmName("jvlsrqxqqvkaykbk")
public suspend fun skipInitialVersionCreation(`value`: Output) {
this.skipInitialVersionCreation = value
}
/**
* @param value A template describing settings for new crypto key versions.
* Structure is documented below.
*/
@JvmName("fcmuegvcbfpmpypw")
public suspend fun versionTemplate(`value`: Output) {
this.versionTemplate = value
}
/**
* @param value The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey.
* The resource name is in the format "projects/*/locations/*/ekmConnections/*" and only applies to "EXTERNAL_VPC" keys.
* */*/*/
*/
@JvmName("vcoyoxngswmpgisl")
public suspend fun cryptoKeyBackend(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.cryptoKeyBackend = mapped
}
/**
* @param value The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.
* If not specified at creation time, the default duration is 24 hours.
*/
@JvmName("khqmudtmraehrecg")
public suspend fun destroyScheduledDuration(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.destroyScheduledDuration = mapped
}
/**
* @param value Whether this key may contain imported versions only.
*/
@JvmName("nalaekqsnyvhnmxt")
public suspend fun importOnly(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.importOnly = mapped
}
/**
* @param value The KeyRing that this key belongs to.
* Format: `'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'`.
* - - -
*/
@JvmName("fxkvaqrxfddqmnaa")
public suspend fun keyRing(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.keyRing = mapped
}
/**
* @param value Labels with user-defined metadata to apply to this resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
@JvmName("jlfejqivnwomwisr")
public suspend fun labels(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param values Labels with user-defined metadata to apply to this resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
@JvmName("ywecmmcfytnyhhsj")
public fun labels(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param value The resource name for the CryptoKey.
*/
@JvmName("wtpwybbcigogoujh")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The immutable purpose of this CryptoKey. See the
* [purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose)
* for possible inputs.
* Default value is "ENCRYPT_DECRYPT".
*/
@JvmName("djiumarlschlaojb")
public suspend fun purpose(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.purpose = mapped
}
/**
* @param value Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.
* The first rotation will take place after the specified period. The rotation period has
* the format of a decimal number with up to 9 fractional digits, followed by the
* letter `s` (seconds). It must be greater than a day (ie, 86400).
*/
@JvmName("vesrxoidhbpacegr")
public suspend fun rotationPeriod(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.rotationPeriod = mapped
}
/**
* @param value If set to true, the request will create a CryptoKey without any CryptoKeyVersions.
* You must use the `gcp.kms.KeyRingImportJob` resource to import the CryptoKeyVersion.
*/
@JvmName("tfrybpcpgoyukjcv")
public suspend fun skipInitialVersionCreation(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.skipInitialVersionCreation = mapped
}
/**
* @param value A template describing settings for new crypto key versions.
* Structure is documented below.
*/
@JvmName("neymmjfxpbguxjwq")
public suspend fun versionTemplate(`value`: CryptoKeyVersionTemplateArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.versionTemplate = mapped
}
/**
* @param argument A template describing settings for new crypto key versions.
* Structure is documented below.
*/
@JvmName("cydjoonbwxntmlck")
public suspend fun versionTemplate(argument: suspend CryptoKeyVersionTemplateArgsBuilder.() -> Unit) {
val toBeMapped = CryptoKeyVersionTemplateArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.versionTemplate = mapped
}
internal fun build(): CryptoKeyArgs = CryptoKeyArgs(
cryptoKeyBackend = cryptoKeyBackend,
destroyScheduledDuration = destroyScheduledDuration,
importOnly = importOnly,
keyRing = keyRing,
labels = labels,
name = name,
purpose = purpose,
rotationPeriod = rotationPeriod,
skipInitialVersionCreation = skipInitialVersionCreation,
versionTemplate = versionTemplate,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy