CryptoKeyArgs class

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

Constructors

CryptoKeyArgs({Input<String>? cryptoKeyBackend, Input<String>? cryptoKeyId, Input<String>? destroyScheduledDuration, Input<bool>? importOnly, required Input<String> keyRingId, Input<Map<String, String>>? labels, Input<String>? location, Input<String>? nextRotationTime, Input<String>? project, Input<CryptoKeyPurpose>? purpose, Input<String>? rotationPeriod, Input<bool>? skipInitialVersionCreation, Input<CryptoKeyVersionTemplate>? versionTemplate})
Creates a new CryptoKeyArgs. cryptoKeyBackend Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format projects/*/locations/*/ekmConnections/*. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. cryptoKeyId Required. It must be unique within a KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63} destroyScheduledDuration Immutable. 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. importOnly Immutable. Whether this key may contain imported versions only. keyRingId Required. labels Labels with user-defined metadata. For more information, see Labeling Keys. location Optional. nextRotationTime At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. project Optional. purpose Immutable. The immutable purpose of this CryptoKey. rotationPeriod next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. skipInitialVersionCreation If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey. versionTemplate A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.
const
CryptoKeyArgs.fromMap(Map<String, dynamic> map)
factory

Properties

cryptoKeyBackend → Input<String>?
Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format projects/*/locations/*/ekmConnections/*. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.
final
cryptoKeyId → Input<String>?
Required. It must be unique within a KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}
final
destroyScheduledDuration → Input<String>?
Immutable. 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.
final
hashCode → int
The hash code for this object.
no setterinherited
importOnly → Input<bool>?
Immutable. Whether this key may contain imported versions only.
final
keyRingId → Input<String>
final
labels → Input<Map<String, String>>?
Labels with user-defined metadata. For more information, see Labeling Keys.
final
location → Input<String>?
final
nextRotationTime → Input<String>?
At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
final
project → Input<String>?
final
purpose → Input<CryptoKeyPurpose>?
Immutable. The immutable purpose of this CryptoKey.
final
rotationPeriod → Input<String>?
next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
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 manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey.
final
versionTemplate → Input<CryptoKeyVersionTemplate>?
A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.
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