CryptoKeyArgs class

The set of arguments for CryptoKey. The set of arguments for CryptoKey.

Constructors

CryptoKeyArgs({Input<String?>? cryptoKeyBackend, Input<String?>? deletionPolicy, Input<String?>? destroyScheduledDuration, Input<bool?>? importOnly, Input<CryptoKeyKeyAccessJustificationsPolicy?>? keyAccessJustificationsPolicy, required Input<String> keyRing, Input<Map<String, String>?>? labels, Input<String?>? name, Input<String?>? purpose, Input<String?>? rotationPeriod, Input<bool?>? skipInitialVersionCreation, Input<CryptoKeyVersionTemplate?>? versionTemplate})
Creates a new CryptoKeyArgs. cryptoKeyBackend The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. destroyScheduledDuration The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. importOnly Whether this key may contain imported versions only. keyAccessJustificationsPolicy (Optional, Beta) keyRing The KeyRing that this key belongs to. labels Labels with user-defined metadata to apply to this resource. name The resource name for the CryptoKey. purpose The immutable purpose of this CryptoKey. See the rotationPeriod Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. skipInitialVersionCreation If set to true, the request will create a CryptoKey without any CryptoKeyVersions. versionTemplate A template describing settings for new crypto key versions.
const
CryptoKeyArgs.fromMap(Map<String, dynamic> map)
factory

Properties

cryptoKeyBackend → Input<String?>?
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.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
destroyScheduledDuration → Input<String?>?
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 30 days.
final
hashCode → int
The hash code for this object.
no setterinherited
importOnly → Input<bool?>?
Whether this key may contain imported versions only.
final
keyAccessJustificationsPolicy → Input<CryptoKeyKeyAccessJustificationsPolicy?>?
(Optional, Beta) The policy used for Key Access Justifications Policy Enforcement. If this field is present and this key is enrolled in Key Access Justifications Policy Enforcement, the policy will be evaluated in encrypt, decrypt, and sign operations, and the operation will fail if rejected by the policy. The policy is defined by specifying zero or more allowed justification codes. https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes By default, this field is absent, and all justification codes are allowed. This field is currently in beta and is subject to change. Structure is documented below.
final
keyRing → Input<String>
The KeyRing that this key belongs to. Format: 'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'.
final
labels → Input<Map<String, String>?>?
Labels with user-defined metadata to apply to this resource.
final
name → Input<String?>?
The resource name for the CryptoKey.
final
purpose → Input<String?>?
The immutable purpose of this CryptoKey. See the purpose reference for possible inputs. Default value is "ENCRYPT_DECRYPT".
final
rotationPeriod → Input<String?>?
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).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipInitialVersionCreation → Input<bool?>?
If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must use the gcp.kms.CryptoKeyVersion resource to create a new CryptoKeyVersion or gcp.kms.KeyRingImportJob resource to import the CryptoKeyVersion. This field is only applicable during initial CryptoKey creation.
final
versionTemplate → Input<CryptoKeyVersionTemplate?>?
A template describing settings for new crypto key versions. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited