Package com.pulumi.alicloud.kvstore

Class Instance

  • public class Instance
extends com.pulumi.resources.CustomResource
    ## Import KVStore instance can be imported using the id, e.g. ```sh $ pulumi import alicloud:kvstore/instance:Instance example r-abc12345678 ```

    • Nested Class Summary

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

        com.pulumi.resources.CustomResource.CustomResourceInternal

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

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Instance​(java.lang.String name)  
      Instance​(java.lang.String name, InstanceArgs args)  
      Instance​(java.lang.String name, InstanceArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoRenew()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> autoRenewPeriod()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoUseCoupon()  
      com.pulumi.core.Output<java.lang.String> availabilityZone()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> backupId()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> backupPeriods()  
      com.pulumi.core.Output<java.lang.String> backupTime()  
      com.pulumi.core.Output<java.lang.Integer> bandwidth()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> businessInfo()  
      com.pulumi.core.Output<java.lang.Integer> capacity()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>> config()  
      com.pulumi.core.Output<java.lang.String> connectionDomain()  
      com.pulumi.core.Output<java.lang.String> connectionString()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> connectionStringPrefix()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> couponNo()  
      com.pulumi.core.Output<java.lang.String> dbInstanceName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> dedicatedHostGroupId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> dryRun()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> effectiveTime()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> enableBackupLog()  
      com.pulumi.core.Output<java.lang.Boolean> enablePublic()  
      com.pulumi.core.Output<java.lang.String> encryptionKey()  
      com.pulumi.core.Output<java.lang.String> encryptionName()  
      com.pulumi.core.Output<java.lang.String> endTime()  
      com.pulumi.core.Output<java.lang.String> engineVersion()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceUpgrade()  
      static Instance get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, InstanceState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> globalInstance()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> globalInstanceId()  
      com.pulumi.core.Output<java.lang.String> instanceChargeType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceClass()  
      com.pulumi.core.Output<java.lang.String> instanceName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> instanceReleaseProtection()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsEncryptedPassword()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> kmsEncryptionContext()  
      com.pulumi.core.Output<java.lang.String> maintainEndTime()  
      com.pulumi.core.Output<java.lang.String> maintainStartTime()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> modifyMode()  
      com.pulumi.core.Output<java.lang.String> nodeType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> orderType()  
      com.pulumi.core.Output<java.util.List<InstanceParameter>> parameters()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> password()  
      com.pulumi.core.Output<java.lang.String> paymentType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> period()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> port()  
      com.pulumi.core.Output<java.lang.String> privateConnectionPort()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> privateConnectionPrefix()  
      com.pulumi.core.Output<java.lang.String> privateIp()  
      com.pulumi.core.Output<java.lang.Integer> qps()  
      com.pulumi.core.Output<java.lang.String> resourceGroupId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> restoreTime()  
      com.pulumi.core.Output<java.lang.String> roleArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> secondaryZoneId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> securityGroupId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> securityIpGroupAttribute()  
      com.pulumi.core.Output<java.lang.String> securityIpGroupName()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> securityIps()  
      com.pulumi.core.Output<java.lang.Integer> shardCount()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> srcdbInstanceId()  
      com.pulumi.core.Output<java.lang.String> sslEnable()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> tags()  
      com.pulumi.core.Output<java.lang.String> tdeStatus()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> vpcAuthMode()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> vswitchId()  
      com.pulumi.core.Output<java.lang.String> zoneId()  

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

        getId, id, idFuture

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

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Instance

        public Instance​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Instance

        public Instance​(java.lang.String name,
                @Nullable
                InstanceArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Instance

        public Instance​(java.lang.String name,
                @Nullable
                InstanceArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • autoRenew

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoRenew()
        Returns:
        Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is `PrePaid`. Default value: `false`.

      • autoRenewPeriod

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> autoRenewPeriod()
        Returns:
        Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is `PrePaid`. Valid values: [1~12]. Default value: `1`.

      • autoUseCoupon

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoUseCoupon()
        Returns:
        Specifies whether to use a coupon. Default value: `false`.

      • availabilityZone

        public com.pulumi.core.Output<java.lang.String> availabilityZone()
        Returns:
        It has been deprecated from provider version 1.101.0 and `zone_id` instead.

      • backupId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> backupId()
        Returns:
        The ID of the backup file of the source instance.

      • backupPeriods

        public com.pulumi.core.Output<java.util.List<java.lang.String>> backupPeriods()
        Returns:
        Backup period.

      • backupTime

        public com.pulumi.core.Output<java.lang.String> backupTime()
        Returns:
        Backup time, the format is HH:mmZ-HH:mmZ (UTC time).

      • bandwidth

        public com.pulumi.core.Output<java.lang.Integer> bandwidth()
        Returns:
        The bandwidth.

      • businessInfo

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> businessInfo()
        Returns:
        The ID of the event or the business information.

      • capacity

        public com.pulumi.core.Output<java.lang.Integer> capacity()
        Returns:
        The storage capacity of the KVStore DBInstance. Unit: MB.

      • config

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>> config()
        Returns:
        The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs [Instance configurations table](https://www.alibabacloud.com/help/doc-detail/61209.htm) .

      • connectionDomain

        public com.pulumi.core.Output<java.lang.String> connectionDomain()
        Returns:
        Intranet connection address of the KVStore instance.

      • connectionString

        public com.pulumi.core.Output<java.lang.String> connectionString()
        Returns:
        Indicates whether the address is a private endpoint. > **NOTE:** The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z. > **NOTE:** You must specify at least one of the `capacity` and `instance_class` parameters when you call create instance operation. > **NOTE:** The `private_ip` must be in the Classless Inter-Domain Routing (CIDR) block of the VSwitch to which the instance belongs. > **NOTE:** If you specify the `srcdb_instance_id` parameter, you must specify the `backup_id` or `restore_time` parameter.

      • connectionStringPrefix

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> connectionStringPrefix()
        Returns:
        It has been deprecated from provider version 1.101.0 and resource `alicloud.kvstore.Connection` instead.

      • couponNo

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> couponNo()
        Returns:
        The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.

      • dbInstanceName

        public com.pulumi.core.Output<java.lang.String> dbInstanceName()
        Returns:
        The name of KVStore DBInstance. It is a string of 2 to 256 characters.

      • dedicatedHostGroupId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> dedicatedHostGroupId()
        Returns:
        The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.

      • dryRun

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> dryRun()
        Returns:
        Specifies whether to precheck the request. Valid values:

      • effectiveTime

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> effectiveTime()
        Returns:
        The time when the database is switched after the instance is migrated, or when the major version is upgraded, or when the instance class is upgraded. Valid values:

      • enableBackupLog

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> enableBackupLog()
        Returns:
        Turn on or off incremental backup. Valid values: `1`, `0`. Default value: `0`

      • enablePublic

        public com.pulumi.core.Output<java.lang.Boolean> enablePublic()
        Returns:
        It has been deprecated from provider version 1.101.0 and resource `alicloud.kvstore.Connection` instead.

      • encryptionKey

        public com.pulumi.core.Output<java.lang.String> encryptionKey()
        Returns:
        The Custom key ID, which you can get by calling DescribeEncryptionKeyList.If this parameter is not passed, the key is automatically generated by the key management service. To create a custom key, you can call the CreateKey interface of the key management service.

      • encryptionName

        public com.pulumi.core.Output<java.lang.String> encryptionName()
        Returns:
        The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.

      • endTime

        public com.pulumi.core.Output<java.lang.String> endTime()
        Returns:
        The expiration time of the prepaid instance.

      • engineVersion

        public com.pulumi.core.Output<java.lang.String> engineVersion()
        Returns:
        The engine version of the KVStore DBInstance. Valid values: ["2.8", "4.0", "5.0", "6.0", "7.0"]. Default value: `5.0`. **NOTE:** When `instance_type = Memcache`, the `engine_version` only supports "4.0".

      • forceUpgrade

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceUpgrade()
        Returns:
        Specifies whether to forcibly change the type. Default value: `true`.

      • globalInstance

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> globalInstance()
        Returns:
        Whether to create a distributed cache. Default value: `false`.

      • globalInstanceId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> globalInstanceId()
        Returns:
        The ID of distributed cache.

      • instanceChargeType

        public com.pulumi.core.Output<java.lang.String> instanceChargeType()
        Returns:
        It has been deprecated from provider version 1.101.0 and `payment_type` instead.

      • instanceClass

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceClass()
        Returns:
        Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source `alicloud.kvstore.getInstanceClasses` or referring to help-docs [Instance type table](https://www.alibabacloud.com/help/doc-detail/26350.htm).

      • instanceName

        public com.pulumi.core.Output<java.lang.String> instanceName()
        Returns:
        It has been deprecated from provider version 1.101.0 and `db_instance_name` instead.

      • instanceReleaseProtection

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> instanceReleaseProtection()
        Returns:
        Whether to open the release protection.

      • instanceType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceType()
        Returns:
        The engine type of the KVStore DBInstance. Valid values: `Redis` or `Memcache`. Default value: `Redis`.

      • kmsEncryptedPassword

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsEncryptedPassword()
        Returns:
        An KMS encrypts password used to an instance. If the `password` is filled in, this field will be ignored.

      • kmsEncryptionContext

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> kmsEncryptionContext()
        Returns:
        An KMS encryption context used to decrypt `kms_encrypted_password` before creating or updating instance with `kms_encrypted_password`. See [Encryption Context](https://www.alibabacloud.com/help/doc-detail/42975.htm). It is valid when `kms_encrypted_password` is set.

      • maintainEndTime

        public com.pulumi.core.Output<java.lang.String> maintainEndTime()
        Returns:
        The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).

      • maintainStartTime

        public com.pulumi.core.Output<java.lang.String> maintainStartTime()
        Returns:
        The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).

      • modifyMode

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> modifyMode()
        Returns:
        The method of modifying the whitelist. Valid values: `0`, `1` and `2`. Default value: `0`. `0` means overwrites the original whitelist. `1` means adds the IP addresses to the whitelist. `2` means deletes the IP addresses from the whitelist.

      • nodeType

        public com.pulumi.core.Output<java.lang.String> nodeType()
        Returns:
        "Field `node_type` has been deprecated from version 1.120.1". This parameter is determined by the `instance_class`.

      • orderType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> orderType()
        Returns:
        Specifies a change type when you change the configuration of a subscription instance. Valid values: `UPGRADE`, `DOWNGRADE`. Default value: `UPGRADE`. `UPGRADE` means upgrades the configuration of a subscription instance. `DOWNGRADE` means downgrades the configuration of a subscription instance.

      • parameters

        public com.pulumi.core.Output<java.util.List<InstanceParameter>> parameters()
        Returns:
        It has been deprecated from provider version 1.101.0 and `config` instead. See `parameters` below.

      • password

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> password()
        Returns:
        The password of the KVStore DBInstance. The password that is used to connect to the instance. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, special characters, and digits. Special characters include: `! @ # $ % ^ & * ( ) _ + - =`

      • paymentType

        public com.pulumi.core.Output<java.lang.String> paymentType()
        Returns:
        The billing method of the KVStore DBInstance. Valid values: `PrePaid`, `PostPaid`. Default value: `PostPaid`.

      • period

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> period()
        Returns:
        The duration that you will buy KVStore DBInstance (in month). It is valid when payment_type is `PrePaid`. Valid values: `[1~9]`, `12`, `24`, `36`.

      • port

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> port()
        Returns:
        It has been deprecated from provider version 1.101.0 and resource `alicloud.kvstore.Connection` instead.

      • privateConnectionPort

        public com.pulumi.core.Output<java.lang.String> privateConnectionPort()
        Returns:
        Private network connection port, used to modify the private network connection port.

      • privateConnectionPrefix

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> privateConnectionPrefix()
        Returns:
        Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.

      • privateIp

        public com.pulumi.core.Output<java.lang.String> privateIp()
        Returns:
        The internal IP address of the instance.

      • qps

        public com.pulumi.core.Output<java.lang.Integer> qps()
        Returns:
        Theoretical maximum QPS value.

      • resourceGroupId

        public com.pulumi.core.Output<java.lang.String> resourceGroupId()
        Returns:
        The ID of resource group which the resource belongs.

      • restoreTime

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> restoreTime()
        Returns:
        The point in time of a backup file.

      • roleArn

        public com.pulumi.core.Output<java.lang.String> roleArn()
        Returns:
        The Specify the global resource descriptor ARN (Alibaba Cloud Resource Name) information of the role to be authorized, and use the related key management services after the authorization is completed, in the format: `acs:ram::$accountID:role/$roleName`.

      • secondaryZoneId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> secondaryZoneId()
        Returns:
        The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance. > **NOTE:** If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

      • securityGroupId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> securityGroupId()
        Returns:
        The ID of security groups.

      • securityIpGroupAttribute

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> securityIpGroupAttribute()
        Returns:
        The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.

      • securityIpGroupName

        public com.pulumi.core.Output<java.lang.String> securityIpGroupName()
        Returns:
        The name of the whitelist group.

      • securityIps

        public com.pulumi.core.Output<java.util.List<java.lang.String>> securityIps()
        Returns:
        The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.

      • shardCount

        public com.pulumi.core.Output<java.lang.Integer> shardCount()
        Returns:
        The number of data shards. This parameter is available only if you create a cluster instance that uses cloud disks. You can use this parameter to specify a custom number of data shards.

      • srcdbInstanceId

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

      • sslEnable

        public com.pulumi.core.Output<java.lang.String> sslEnable()
        Returns:
        Modifies the SSL status. Valid values: `Disable`, `Enable` and `Update`. **NOTE:** This functionality is supported by Cluster mode (Redis 2.8, 4.0, 5.0) and Standard mode( Redis 2.8 only).

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        The status of KVStore DBInstance.

      • tags

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

      • tdeStatus

        public com.pulumi.core.Output<java.lang.String> tdeStatus()
        Returns:
        Specifies whether to enable TDE. Valid values: `Enabled`. **NOTE:**: TDE cannot be disabled after it is enabled. Before you enable it, evaluate whether this feature affects your business. For more information, see [Enable TDE](https://www.alibabacloud.com/help/en/redis/user-guide/enable-tde).

      • vpcAuthMode

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> vpcAuthMode()
        Returns:
        Only meaningful if instance_type is `Redis` and network type is VPC. Valid values: `Close`, `Open`. Default value: `Open`. `Close` means the redis instance can be accessed without authentication. `Open` means authentication is required.

      • vswitchId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> vswitchId()
        Returns:
        The ID of VSwitch.

      • zoneId

        public com.pulumi.core.Output<java.lang.String> zoneId()
        Returns:
        The ID of the zone.

      • get

        public static Instance get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           InstanceState state,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.