KeyState class

Input properties used for looking up and filtering Key resources.

Constructors

KeyState({Input<String?>? arn, Input<bool?>? bypassPolicyLockoutSafetyCheck, Input<String?>? customKeyStoreId, Input<String?>? customerMasterKeySpec, Input<int?>? deletionWindowInDays, Input<String?>? description, Input<bool?>? enableKeyRotation, Input<bool?>? isEnabled, Input<String?>? keyId, Input<String?>? keyUsage, Input<bool?>? multiRegion, Input<String?>? policy, Input<String?>? region, Input<int?>? rotationPeriodInDays, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? xksKeyId})
Creates a new KeyState. arn ARN of the key. bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. customKeyStoreId ID of the KMS Custom Key Store where the key will be stored instead of KMS (eg CloudHSM). customerMasterKeySpec Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. deletionWindowInDays The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the KMS key. description The description of the key as viewed in AWS console. enableKeyRotation Specifies whether key rotation is enabled. Defaults to false. isEnabled Specifies whether the key is enabled. Defaults to true. keyId The globally unique identifier for the key. keyUsage Specifies the intended use of the key. Valid values: ENCRYPT_DECRYPT, SIGN_VERIFY, or GENERATE_VERIFY_MAC. multiRegion Indicates whether the KMS key is a multi-Region (true) or regional (false) key. Defaults to false. policy A valid policy JSON document. Although this is a key policy, not an IAM policy, an aws.iam.getPolicyDocument, in the form that designates a principal, can be used. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. rotationPeriodInDays Custom period of time between each rotation date. Must be a number between 90 and 2560 (inclusive). tags A map of tags to assign to the object. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. xksKeyId Identifies the external key that serves as key material for the KMS key in an external key store.
const
KeyState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the key.
final
bypassPolicyLockoutSafetyCheck → Input<bool?>?
A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS KMS Developer Guide. The default value is false.
final
customerMasterKeySpec → 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, SM2 (China Regions only), or ECC_NIST_EDWARDS25519. Defaults to SYMMETRIC_DEFAULT. For help with choosing a key spec, see the AWS KMS Developer Guide.
final
customKeyStoreId → Input<String?>?
ID of the KMS Custom Key Store where the key will be stored instead of KMS (eg CloudHSM).
final
deletionWindowInDays → Input<int?>?
The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the KMS key. If you specify a value, it must be between 7 and 30, inclusive. If you do not specify a value, it defaults to 30. If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
final
description → Input<String?>?
The description of the key as viewed in AWS console.
final
enableKeyRotation → Input<bool?>?
Specifies whether key rotation is enabled. Defaults to false.
final
hashCode → int
The hash code for this object.
no setterinherited
isEnabled → Input<bool?>?
Specifies whether the key is enabled. Defaults to true.
final
keyId → Input<String?>?
The globally unique identifier for the key.
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 valid policy JSON document. Although this is a key policy, not an IAM policy, an aws.iam.getPolicyDocument, in the form that designates a principal, can be used.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
rotationPeriodInDays → Input<int?>?
Custom period of time between each rotation date. Must be a number between 90 and 2560 (inclusive).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
A map of tags to assign to the object. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
xksKeyId → Input<String?>?
Identifies the external key that serves as key material for the KMS key in an external key store.
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