Package com.pulumi.aws.kms

Class ExternalKeyArgs

  • public final class ExternalKeyArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExternalKeyArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ExternalKeyArgs.Builder builder()  
      static ExternalKeyArgs.Builder builder​(ExternalKeyArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> bypassPolicyLockoutSafetyCheck()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> deletionWindowInDays()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enabled()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyMaterialBase64()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> keySpec()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyUsage()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> multiRegion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> policy()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> validTo()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • bypassPolicyLockoutSafetyCheck

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> bypassPolicyLockoutSafetyCheck()
        Returns:
        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](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section in the KMS Developer Guide. Defaults to `false`.

      • deletionWindowInDays

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> deletionWindowInDays()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the key.

      • enabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enabled()
        Returns:
        Whether the key is enabled. Keys pending import can only be `false`. Imported keys default to `true` unless expired.

      • keyMaterialBase64

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyMaterialBase64()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keySpec()
        Returns:
        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](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html).

      • keyUsage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyUsage()
        Returns:
        Intended use of the key. Valid values: `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `GENERATE_VERIFY_MAC`. Defaults to `ENCRYPT_DECRYPT`.

      • multiRegion

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> multiRegion()
        Returns:
        Whether the KMS key is a multi-Region (`true`) or regional (`false`) key. Defaults to `false`.

      • policy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> policy()
        Returns:
        Key policy JSON document. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> validTo()
        Returns:
        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](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`)