Package com.pulumi.alicloud.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 Deprecated Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> automaticRotation()  
      static KeyArgs.Builder builder()  
      static KeyArgs.Builder builder​(KeyArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> deletionWindowInDays()
      Deprecated.
      Field 'deletion_window_in_days' has been deprecated from provider version 1.85.0.
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dkmsInstanceId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> isEnabled()
      Deprecated.
      Field 'is_enabled' has been deprecated from provider version 1.85.0.
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> keySpec()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyState()
      Deprecated.
      Field 'key_state' has been deprecated from provider version 1.123.1.
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyUsage()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> origin()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> pendingWindowInDays()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> protectionLevel()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> rotationInterval()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>>> tags()  

      • 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

      • automaticRotation

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> automaticRotation()
        Returns:
        Specifies whether to enable automatic key rotation. Default value: `Disabled`. Valid values:

      • deletionWindowInDays

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> deletionWindowInDays()
        Deprecated.
        Field 'deletion_window_in_days' has been deprecated from provider version 1.85.0. New field 'pending_window_in_days' instead.
        Returns:
        Field `deletion_window_in_days` has been deprecated from provider version 1.85.0. New field `pending_window_in_days` instead.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        The description of the CMK. The description can be 0 to 8,192 characters in length.

      • dkmsInstanceId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dkmsInstanceId()
        Returns:
        The instance ID of the exclusive KMS instance.

      • isEnabled

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> isEnabled()
        Deprecated.
        Field 'is_enabled' has been deprecated from provider version 1.85.0. New field 'key_state' instead.
        Returns:
        Field `is_enabled` has been deprecated from provider version 1.85.0. New field `status` instead.

      • keySpec

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keySpec()
        Returns:
        The type of the CMK. Default value: `Aliyun_AES_256`. Valid values: `Aliyun_AES_256`, `Aliyun_AES_128`, `Aliyun_AES_192`, `Aliyun_SM4`, `RSA_2048`, `RSA_3072`, `EC_P256`, `EC_P256K`, `EC_SM2`. Note: The default type of the CMK is `Aliyun_AES_256`. Only Dedicated KMS supports `Aliyun_AES_128` and `Aliyun_AES_192`.

      • keyState

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyState()
        Deprecated.
        Field 'key_state' has been deprecated from provider version 1.123.1. New field 'status' instead.
        Returns:
        Field `key_state` has been deprecated from provider version 1.123.1. New field `status` instead.

      • keyUsage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyUsage()
        Returns:
        The usage of the CMK. Default value: `ENCRYPT/DECRYPT`. Valid values: - `ENCRYPT/DECRYPT`: encrypts or decrypts data. - `SIGN/VERIFY`: generates or verifies a digital signature.

      • origin

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> origin()
        Returns:
        The source of key material. Default value: `Aliyun_KMS`. Valid values:

      • pendingWindowInDays

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> pendingWindowInDays()
        Returns:
        The number of days before the CMK is deleted. During this period, the CMK is in the PendingDeletion state. After this period ends, you cannot cancel the deletion. Valid values: 7 to 366. Unit: days. **NOTE:** From version 1.184.0, `pending_window_in_days` can be set to `366`.

      • protectionLevel

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> protectionLevel()
        Returns:
        The protection level of the CMK. Default value: `SOFTWARE`. Valid values:

      • rotationInterval

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> rotationInterval()
        Returns:
        The interval for automatic key rotation. Specify the value in the integer[unit] format. The following units are supported: d (day), h (hour), m (minute), and s (second). For example, you can use either 7d or 604800s to specify a seven-day interval. The interval can range from 7 days to 730 days. **NOTE**: It is Required when `automatic_rotation = "Enabled"` > **NOTE:** When the pre-deletion days elapses, the key is permanently deleted and cannot be recovered.

      • status

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()
        Returns:
        The status of CMK. Default value: `Enabled`. Valid Values:

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>>> tags()
        Returns:
        A mapping of tags to assign to the resource.