Package com.pulumi.aws.kms

Class ExternalKeyArgs.Builder

  • Enclosing class:
    ExternalKeyArgs
    public static final class ExternalKeyArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • bypassPolicyLockoutSafetyCheck

        public ExternalKeyArgs.Builder bypassPolicyLockoutSafetyCheck​(@Nullable
                                                              com.pulumi.core.Output<java.lang.Boolean> bypassPolicyLockoutSafetyCheck)
        Parameters:
        bypassPolicyLockoutSafetyCheck - 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`.
        Returns:
        builder

      • bypassPolicyLockoutSafetyCheck

        public ExternalKeyArgs.Builder bypassPolicyLockoutSafetyCheck​(java.lang.Boolean bypassPolicyLockoutSafetyCheck)
        Parameters:
        bypassPolicyLockoutSafetyCheck - 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`.
        Returns:
        builder

      • deletionWindowInDays

        public ExternalKeyArgs.Builder deletionWindowInDays​(@Nullable
                                                    com.pulumi.core.Output<java.lang.Integer> deletionWindowInDays)
        Parameters:
        deletionWindowInDays - Duration in days after which the key is deleted after destruction of the resource. Must be between `7` and `30` days. Defaults to `30`.
        Returns:
        builder

      • deletionWindowInDays

        public ExternalKeyArgs.Builder deletionWindowInDays​(java.lang.Integer deletionWindowInDays)
        Parameters:
        deletionWindowInDays - Duration in days after which the key is deleted after destruction of the resource. Must be between `7` and `30` days. Defaults to `30`.
        Returns:
        builder

      • description

        public ExternalKeyArgs.Builder description​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> description)
        Parameters:
        description - Description of the key.
        Returns:
        builder

      • description

        public ExternalKeyArgs.Builder description​(java.lang.String description)
        Parameters:
        description - Description of the key.
        Returns:
        builder

      • enabled

        public ExternalKeyArgs.Builder enabled​(@Nullable
                                       com.pulumi.core.Output<java.lang.Boolean> enabled)
        Parameters:
        enabled - Whether the key is enabled. Keys pending import can only be `false`. Imported keys default to `true` unless expired.
        Returns:
        builder

      • enabled

        public ExternalKeyArgs.Builder enabled​(java.lang.Boolean enabled)
        Parameters:
        enabled - Whether the key is enabled. Keys pending import can only be `false`. Imported keys default to `true` unless expired.
        Returns:
        builder

      • keyMaterialBase64

        public ExternalKeyArgs.Builder keyMaterialBase64​(@Nullable
                                                 com.pulumi.core.Output<java.lang.String> keyMaterialBase64)
        Parameters:
        keyMaterialBase64 - 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.
        Returns:
        builder

      • keyMaterialBase64

        public ExternalKeyArgs.Builder keyMaterialBase64​(java.lang.String keyMaterialBase64)
        Parameters:
        keyMaterialBase64 - 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.
        Returns:
        builder

      • keySpec

        public ExternalKeyArgs.Builder keySpec​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> keySpec)
        Parameters:
        keySpec - 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).
        Returns:
        builder

      • keySpec

        public ExternalKeyArgs.Builder keySpec​(java.lang.String keySpec)
        Parameters:
        keySpec - 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).
        Returns:
        builder

      • keyUsage

        public ExternalKeyArgs.Builder keyUsage​(@Nullable
                                        com.pulumi.core.Output<java.lang.String> keyUsage)
        Parameters:
        keyUsage - Intended use of the key. Valid values: `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `GENERATE_VERIFY_MAC`. Defaults to `ENCRYPT_DECRYPT`.
        Returns:
        builder

      • keyUsage

        public ExternalKeyArgs.Builder keyUsage​(java.lang.String keyUsage)
        Parameters:
        keyUsage - Intended use of the key. Valid values: `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `GENERATE_VERIFY_MAC`. Defaults to `ENCRYPT_DECRYPT`.
        Returns:
        builder

      • multiRegion

        public ExternalKeyArgs.Builder multiRegion​(@Nullable
                                           com.pulumi.core.Output<java.lang.Boolean> multiRegion)
        Parameters:
        multiRegion - Whether the KMS key is a multi-Region (`true`) or regional (`false`) key. Defaults to `false`.
        Returns:
        builder

      • multiRegion

        public ExternalKeyArgs.Builder multiRegion​(java.lang.Boolean multiRegion)
        Parameters:
        multiRegion - Whether the KMS key is a multi-Region (`true`) or regional (`false`) key. Defaults to `false`.
        Returns:
        builder

      • policy

        public ExternalKeyArgs.Builder policy​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> policy)
        Parameters:
        policy - Key policy JSON document. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK.
        Returns:
        builder

      • policy

        public ExternalKeyArgs.Builder policy​(java.lang.String policy)
        Parameters:
        policy - Key policy JSON document. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK.
        Returns:
        builder

      • region

        public ExternalKeyArgs.Builder region​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public ExternalKeyArgs.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • tags

        public ExternalKeyArgs.Builder tags​(@Nullable
                                    com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public ExternalKeyArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • validTo

        public ExternalKeyArgs.Builder validTo​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> validTo)
        Parameters:
        validTo - 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`)
        Returns:
        builder

      • validTo

        public ExternalKeyArgs.Builder validTo​(java.lang.String validTo)
        Parameters:
        validTo - 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`)
        Returns:
        builder