Package com.pulumi.aws.kms

Class KeyArgs

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

    • Nested Class Summary

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

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

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static KeyArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static KeyArgs.Builder builder()  
      static KeyArgs.Builder builder​(KeyArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> bypassPolicyLockoutSafetyCheck()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerMasterKeySpec()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> customKeyStoreId()  
      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>> enableKeyRotation()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> isEnabled()  
      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.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> xksKeyId()  

      • 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

    • Field Detail

      • Empty

        public static final KeyArgs Empty

    • Method Detail

      • bypassPolicyLockoutSafetyCheck

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

      • customKeyStoreId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customKeyStoreId()
        Returns:
        ID of the KMS [Custom Key Store](https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html) where the key will be stored instead of KMS (eg CloudHSM).

      • customerMasterKeySpec

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerMasterKeySpec()
        Returns:
        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_256`, `ECC_NIST_P256`, `ECC_NIST_P384`, `ECC_NIST_P521`, or `ECC_SECG_P256K1`. 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).

      • deletionWindowInDays

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

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        The description of the key as viewed in AWS console.

      • enableKeyRotation

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableKeyRotation()
        Returns:
        Specifies whether [key rotation](http://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) is enabled. Defaults to `false`.

      • isEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> isEnabled()
        Returns:
        Specifies whether the key is enabled. Defaults to `true`.

      • keyUsage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyUsage()
        Returns:
        Specifies the 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:
        Indicates 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:
        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. > **NOTE:** Note: All KMS keys must have a key policy. If a key policy is not specified, AWS gives the KMS key a [default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) that gives all principals in the owning account unlimited access to all KMS operations for the key. This default key policy effectively delegates all access control to IAM policies and KMS grants.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the object. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • xksKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> xksKeyId()
        Returns:
        Identifies the external key that serves as key material for the KMS key in an external key store.