Class GetKeyResult


  • public final class GetKeyResult
    extends java.lang.Object
    • Method Detail

      • arn

        public java.lang.String arn()
        Returns:
        Key ARN of a primary or replica key of a multi-Region key.
      • awsAccountId

        public java.lang.String awsAccountId()
        Returns:
        Twelve-digit account ID of the AWS account that owns the key.
      • cloudHsmClusterId

        public java.lang.String cloudHsmClusterId()
        Returns:
        Cluster ID of the AWS CloudHSM cluster that contains the key material for the KMS key.
      • creationDate

        public java.lang.String creationDate()
        Returns:
        Date and time when the key was created.
      • customKeyStoreId

        public java.lang.String customKeyStoreId()
        Returns:
        Unique identifier for the custom key store that contains the KMS key.
      • customerMasterKeySpec

        public java.lang.String customerMasterKeySpec()
        Returns:
        See `keySpec`.
      • deletionDate

        public java.lang.String deletionDate()
        Returns:
        Date and time after which AWS KMS deletes the key. This value is present only when `keyState` is `PendingDeletion`, otherwise this value is 0.
      • description

        public java.lang.String description()
        Returns:
        Description of the key.
      • enabled

        public java.lang.Boolean enabled()
        Returns:
        Whether the key is enabled. When `keyState` is `Enabled` this value is true, otherwise it is false.
      • expirationModel

        public java.lang.String expirationModel()
        Returns:
        Whether the key's key material expires. This value is present only when `origin` is `EXTERNAL`, otherwise this value is empty.
      • grantTokens

        public java.util.List<java.lang.String> grantTokens()
      • id

        public java.lang.String id()
        Returns:
        The provider-assigned unique ID for this managed resource.
      • keyId

        public java.lang.String keyId()
      • keyManager

        public java.lang.String keyManager()
        Returns:
        Manager of the key.
      • keySpec

        public java.lang.String keySpec()
        Returns:
        Type of key material in the KMS key.
      • keyState

        public java.lang.String keyState()
        Returns:
        State of the key.
      • keyUsage

        public java.lang.String keyUsage()
        Returns:
        Intended use of the key.
      • multiRegion

        public java.lang.Boolean multiRegion()
        Returns:
        Whether the KMS key is a multi-Region (`true`) or regional (`false`) key.
      • multiRegionConfigurations

        public java.util.List<GetKeyMultiRegionConfiguration> multiRegionConfigurations()
        Returns:
        Primary and replica keys in same multi-Region key. Present only when the value of `multiRegion` is `true`. See `multiRegionConfiguration` Block below.
      • origin

        public java.lang.String origin()
        Returns:
        Source of the key material. When this value is `AWS_KMS`, AWS KMS created the key material. When this value is `EXTERNAL`, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
      • pendingDeletionWindowInDays

        public java.lang.Integer pendingDeletionWindowInDays()
        Returns:
        Waiting period before the primary key in a multi-Region key is deleted.
      • region

        public java.lang.String region()
        Returns:
        AWS Region of a primary or replica key in a multi-Region key.
      • validTo

        public java.lang.String validTo()
        Returns:
        Time at which the imported key material expires. This value is present only when `origin` is `EXTERNAL` and whose `expirationModel` is `KEY_MATERIAL_EXPIRES`, otherwise this value is 0.
      • xksKeyConfigurations

        public java.util.List<GetKeyXksKeyConfiguration> xksKeyConfigurations()
        Returns:
        Information about the external key that is associated with a KMS key in an external key store. See `xksKeyConfiguration` Block below.