ReplicaExternalKeyState class

Input properties used for looking up and filtering ReplicaExternalKey resources.

Constructors

ReplicaExternalKeyState({Input<String?>? arn, Input<bool?>? bypassPolicyLockoutSafetyCheck, Input<int?>? deletionWindowInDays, Input<String?>? description, Input<bool?>? enabled, Input<String?>? expirationModel, Input<String?>? keyId, Input<String?>? keyMaterialBase64, Input<String?>? keyState, Input<String?>? keyUsage, Input<String?>? policy, Input<String?>? primaryKeyArn, Input<String?>? region, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? validTo})
Creates a new ReplicaExternalKeyState. arn ARN of the replica key. The key ARNs of related multi-Region keys differ only in the Region value. bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. deletionWindowInDays The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the KMS key. description A description of the KMS key. enabled Specifies whether the replica key is enabled. Disabled KMS keys cannot be used in cryptographic operations. Keys pending import can only be false. Imported keys default to true unless expired. expirationModel Whether the key material expires. Empty when pending key material import, otherwise KEY_MATERIAL_EXPIRES or KEY_MATERIAL_DOES_NOT_EXPIRE. keyId The key ID of the replica key. Related multi-Region keys have the same key ID. keyMaterialBase64 Base64 encoded 256-bit symmetric encryption key material to import. The KMS key is permanently associated with this key material. The same key material can be reimported, but you cannot import different key material. keyState The state of the replica key. keyUsage The cryptographic operations for which you can use the KMS key. This is a shared property of multi-Region keys. policy The key policy to attach to the KMS key. If you do not specify a key policy, AWS KMS attaches the default key policy to the KMS key. primaryKeyArn The ARN of the multi-Region primary key to replicate. The primary key must be in a different AWS Region of the same AWS Partition. You can create only one replica of a given primary key in each AWS Region. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tags A map of tags to assign to the replica key. 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. validTo Time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the key becomes unusable. If not specified, key material does not expire. Valid values: RFC3339 time string (YYYY-MM-DDTHH:MM:SSZ)
const
ReplicaExternalKeyState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the replica key. The key ARNs of related multi-Region keys differ only in the Region value.
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
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.
final
description → Input<String?>?
A description of the KMS key.
final
enabled → Input<bool?>?
Specifies whether the replica key is enabled. Disabled KMS keys cannot be used in cryptographic operations. Keys pending import can only be false. Imported keys default to true unless expired.
final
expirationModel → Input<String?>?
Whether the key material expires. Empty when pending key material import, otherwise KEY_MATERIAL_EXPIRES or KEY_MATERIAL_DOES_NOT_EXPIRE.
final
hashCode → int
The hash code for this object.
no setterinherited
keyId → Input<String?>?
The key ID of the replica key. Related multi-Region keys have the same key ID.
final
keyMaterialBase64 → Input<String?>?
Base64 encoded 256-bit symmetric encryption key material to import. The KMS key is permanently associated with this key material. The same key material can be reimported, but you cannot import different key material.
final
keyState → Input<String?>?
The state of the replica key.
final
keyUsage → Input<String?>?
The cryptographic operations for which you can use the KMS key. This is a shared property of multi-Region keys.
final
policy → Input<String?>?
The key policy to attach to the KMS key. If you do not specify a key policy, AWS KMS attaches the default key policy to the KMS key.
final
primaryKeyArn → Input<String?>?
The ARN of the multi-Region primary key to replicate. The primary key must be in a different AWS Region of the same AWS Partition. You can create only one replica of a given primary key in each AWS Region.
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 map of tags to assign to the replica key. 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
validTo → Input<String?>?
Time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the key 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