GetKeyResult class
Result data returned by getKey.
Constructors
-
GetKeyResult({String? arn, String? awsAccountId, String? cloudHsmClusterId, String? creationDate, String? customKeyStoreId, String? customerMasterKeySpec, String? deletionDate, String? description, bool? enabled, String? expirationModel, List<
String> ? grantTokens, String? id, String? keyId, String? keyManager, String? keySpec, String? keyState, String? keyUsage, bool? multiRegion, List<GetKeyMultiRegionConfiguration> ? multiRegionConfigurations, String? origin, int? pendingDeletionWindowInDays, String? region, String? validTo, List<GetKeyXksKeyConfiguration> ? xksKeyConfigurations}) -
Creates a new GetKeyResult.
arnThe key ARN of a primary or replica key of a multi-Region key.awsAccountIdThe twelve-digit account ID of the AWS account that owns the keycloudHsmClusterIdThe cluster ID of the AWS CloudHSM cluster that contains the key material for the KMS key.creationDateThe date and time when the key was createdcustomKeyStoreIdA unique identifier for the custom key store that contains the KMS key.customerMasterKeySpecSeekeySpec.deletionDateThe date and time after which AWS KMS deletes the key. This value is present only whenkeyStateisPendingDeletion, otherwise this value is 0descriptionThe description of the key.enabledSpecifies whether the key is enabled. WhenkeyStateisEnabledthis value is true, otherwise it is falseexpirationModelSpecifies whether the Key's key material expires. This value is present only whenoriginisEXTERNAL, otherwise this value is emptygrantTokensOptional.idThe provider-assigned unique ID for this managed resource.keyIdOptional.keyManagerThe key's managerkeySpecDescribes the type of key material in the KMS key.keyStateThe state of the keykeyUsageSpecifies the intended use of the keymultiRegionIndicates whether the KMS key is a multi-Region (true) or regional (false) key.multiRegionConfigurationsLists the primary and replica keys in same multi-Region key. Present only when the value ofmultiRegionistrue.originWhen this value isAWS_KMS, AWS KMS created the key material. When this value isEXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key materialpendingDeletionWindowInDaysThe waiting period before the primary key in a multi-Region key is deleted.regionThe AWS Region of a primary or replica key in a multi-Region key.validToThe time at which the imported key material expires. This value is present only whenoriginisEXTERNALand whoseexpirationModelisKEY_MATERIAL_EXPIRES, otherwise this value is 0xksKeyConfigurationsInformation about the external key that is associated with a KMS key in an external key store.const -
GetKeyResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- arn → String?
-
The key ARN of a primary or replica key of a multi-Region key.
final
- awsAccountId → String?
-
The twelve-digit account ID of the AWS account that owns the key
final
- cloudHsmClusterId → String?
-
The cluster ID of the AWS CloudHSM cluster that contains the key material for the KMS key.
final
- creationDate → String?
-
The date and time when the key was created
final
- customerMasterKeySpec → String?
-
See
keySpec.final - customKeyStoreId → String?
-
A unique identifier for the custom key store that contains the KMS key.
final
- deletionDate → String?
-
The date and time after which AWS KMS deletes the key. This value is present only when
keyStateisPendingDeletion, otherwise this value is 0final - description → String?
-
The description of the key.
final
- enabled → bool?
-
Specifies whether the key is enabled. When
keyStateisEnabledthis value is true, otherwise it is falsefinal - expirationModel → String?
-
Specifies whether the Key's key material expires. This value is present only when
originisEXTERNAL, otherwise this value is emptyfinal -
grantTokens
→ List<
String> ? -
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String?
-
The provider-assigned unique ID for this managed resource.
final
- keyId → String?
-
final
- keyManager → String?
-
The key's manager
final
- keySpec → String?
-
Describes the type of key material in the KMS key.
final
- keyState → String?
-
The state of the key
final
- keyUsage → String?
-
Specifies the intended use of the key
final
- multiRegion → bool?
-
Indicates whether the KMS key is a multi-Region (
true) or regional (false) key.final -
multiRegionConfigurations
→ List<
GetKeyMultiRegionConfiguration> ? -
Lists the primary and replica keys in same multi-Region key. Present only when the value of
multiRegionistrue.final - origin → String?
-
When this value is
AWS_KMS, AWS KMS created the key material. When this value isEXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key materialfinal - pendingDeletionWindowInDays → int?
-
The waiting period before the primary key in a multi-Region key is deleted.
final
- region → String?
-
The AWS Region of a primary or replica key in a multi-Region key.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- validTo → String?
-
The time at which the imported key material expires. This value is present only when
originisEXTERNALand whoseexpirationModelisKEY_MATERIAL_EXPIRES, otherwise this value is 0final -
xksKeyConfigurations
→ List<
GetKeyXksKeyConfiguration> ? -
Information about the external key that is associated with a 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