ExternalKeyArgs class

The set of arguments for ExternalKey. The set of arguments for ExternalKey.

Constructors

ExternalKeyArgs({Input<bool?>? bypassPolicyLockoutSafetyCheck, Input<int?>? deletionWindowInDays, Input<String?>? description, Input<bool?>? enabled, Input<String?>? keyMaterialBase64, Input<String?>? keySpec, Input<String?>? keyUsage, Input<bool?>? multiRegion, Input<String?>? policy, Input<String?>? region, Input<Map<String, String>?>? tags, Input<String?>? validTo})
Creates a new ExternalKeyArgs. bypassPolicyLockoutSafetyCheck Whether to disable the policy lockout check performed when creating or updating the key's policy. Setting this value to true increases the risk that the key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the KMS Developer Guide. Defaults to false. deletionWindowInDays Duration in days after which the key is deleted after destruction of the resource. Must be between 7 and 30 days. Defaults to 30. description Description of the key. enabled Specifies whether the key is enabled. Keys pending import can only be false. Imported keys default to true unless expired. keyMaterialBase64 Base64 encoded 256-bit symmetric encryption key material to import. The CMK is permanently associated with this key material. The same key material can be reimported, but you cannot import different key material. keySpec Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: SYMMETRIC_DEFAULT, RSA_2048, RSA_3072, RSA_4096, HMAC_224, HMAC_256, HMAC_384, HMAC_512, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, ML_DSA_44, ML_DSA_65, ML_DSA_87, or SM2 (China Regions only). Defaults to SYMMETRIC_DEFAULT. For help with choosing a key spec, see the AWS KMS Developer Guide. keyUsage Specifies the intended use of the key. Valid values: ENCRYPT_DECRYPT, SIGN_VERIFY, or GENERATE_VERIFY_MAC. Defaults to ENCRYPT_DECRYPT. multiRegion Indicates whether the KMS key is a multi-Region (true) or regional (false) key. Defaults to false. policy A key policy JSON document. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tags A key-value map of tags to assign to the key. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. validTo Time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. If not specified, key material does not expire. Valid values: RFC3339 time string (YYYY-MM-DDTHH:MM:SSZ)
const
ExternalKeyArgs.fromMap(Map<String, dynamic> map)
factory

Properties

bypassPolicyLockoutSafetyCheck → Input<bool?>?
Whether to disable the policy lockout check performed when creating or updating the key's policy. Setting this value to true increases the risk that the key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the KMS Developer Guide. Defaults to false.
final
deletionWindowInDays → Input<int?>?
Duration in days after which the key is deleted after destruction of the resource. Must be between 7 and 30 days. Defaults to 30.
final
description → Input<String?>?
Description of the key.
final
enabled → Input<bool?>?
Specifies whether the key is enabled. Keys pending import can only be false. Imported keys default to true unless expired.
final
hashCode → int
The hash code for this object.
no setterinherited
keyMaterialBase64 → Input<String?>?
Base64 encoded 256-bit symmetric encryption key material to import. The CMK is permanently associated with this key material. The same key material can be reimported, but you cannot import different key material.
final
keySpec → Input<String?>?
Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: SYMMETRIC_DEFAULT, RSA_2048, RSA_3072, RSA_4096, HMAC_224, HMAC_256, HMAC_384, HMAC_512, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, ML_DSA_44, ML_DSA_65, ML_DSA_87, or SM2 (China Regions only). Defaults to SYMMETRIC_DEFAULT. For help with choosing a key spec, see the AWS KMS Developer Guide.
final
keyUsage → Input<String?>?
Specifies the intended use of the key. Valid values: ENCRYPT_DECRYPT, SIGN_VERIFY, or GENERATE_VERIFY_MAC. Defaults to ENCRYPT_DECRYPT.
final
multiRegion → Input<bool?>?
Indicates whether the KMS key is a multi-Region (true) or regional (false) key. Defaults to false.
final
policy → Input<String?>?
A key policy JSON document. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
A key-value map of tags to assign to the key. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
validTo → Input<String?>?
Time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. If not specified, key material does not expire. Valid values: RFC3339 time string (YYYY-MM-DDTHH:MM:SSZ)
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