TairInstanceArgs

data class TairInstanceArgs(val autoRenew: Output<String>? = null, val autoRenewPeriod: Output<String>? = null, val backupId: Output<String>? = null, val clusterBackupId: Output<String>? = null, val connectionStringPrefix: Output<String>? = null, val effectiveTime: Output<String>? = null, val engineVersion: Output<String>? = null, val forceUpgrade: Output<Boolean>? = null, val globalInstanceId: Output<String>? = null, val instanceClass: Output<String>? = null, val instanceType: Output<String>? = null, val intranetBandwidth: Output<Int>? = null, val modifyMode: Output<String>? = null, val nodeType: Output<String>? = null, val paramNoLooseSentinelEnabled: Output<String>? = null, val paramNoLooseSentinelPasswordFreeAccess: Output<String>? = null, val paramNoLooseSentinelPasswordFreeCommands: Output<String>? = null, val paramReplMode: Output<String>? = null, val paramSemisyncReplTimeout: Output<String>? = null, val paramSentinelCompatEnable: Output<String>? = null, val password: Output<String>? = null, val paymentType: Output<String>? = null, val period: Output<Int>? = null, val port: Output<Int>? = null, val readOnlyCount: Output<Int>? = null, val recoverConfigMode: Output<String>? = null, val resourceGroupId: Output<String>? = null, val secondaryZoneId: Output<String>? = null, val securityGroupId: Output<String>? = null, val securityIpGroupName: Output<String>? = null, val securityIps: Output<String>? = null, val shardCount: Output<Int>? = null, val slaveReadOnlyCount: Output<Int>? = null, val srcDbInstanceId: Output<String>? = null, val sslEnabled: Output<String>? = null, val storagePerformanceLevel: Output<String>? = null, val storageSizeGb: Output<Int>? = null, val tags: Output<Map<String, String>>? = null, val tairInstanceName: Output<String>? = null, val vpcAuthMode: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<TairInstanceArgs>

Import

Tair (Redis OSS-Compatible) And Memcache (KVStore) Tair Instance can be imported using the id, e.g.

$ pulumi import alicloud:redis/tairInstance:TairInstance example <id>

Constructors

Link copied to clipboard
constructor(autoRenew: Output<String>? = null, autoRenewPeriod: Output<String>? = null, backupId: Output<String>? = null, clusterBackupId: Output<String>? = null, connectionStringPrefix: Output<String>? = null, effectiveTime: Output<String>? = null, engineVersion: Output<String>? = null, forceUpgrade: Output<Boolean>? = null, globalInstanceId: Output<String>? = null, instanceClass: Output<String>? = null, instanceType: Output<String>? = null, intranetBandwidth: Output<Int>? = null, modifyMode: Output<String>? = null, nodeType: Output<String>? = null, paramNoLooseSentinelEnabled: Output<String>? = null, paramNoLooseSentinelPasswordFreeAccess: Output<String>? = null, paramNoLooseSentinelPasswordFreeCommands: Output<String>? = null, paramReplMode: Output<String>? = null, paramSemisyncReplTimeout: Output<String>? = null, paramSentinelCompatEnable: Output<String>? = null, password: Output<String>? = null, paymentType: Output<String>? = null, period: Output<Int>? = null, port: Output<Int>? = null, readOnlyCount: Output<Int>? = null, recoverConfigMode: Output<String>? = null, resourceGroupId: Output<String>? = null, secondaryZoneId: Output<String>? = null, securityGroupId: Output<String>? = null, securityIpGroupName: Output<String>? = null, securityIps: Output<String>? = null, shardCount: Output<Int>? = null, slaveReadOnlyCount: Output<Int>? = null, srcDbInstanceId: Output<String>? = null, sslEnabled: Output<String>? = null, storagePerformanceLevel: Output<String>? = null, storageSizeGb: Output<Int>? = null, tags: Output<Map<String, String>>? = null, tairInstanceName: Output<String>? = null, vpcAuthMode: Output<String>? = null, vpcId: Output<String>? = null, vswitchId: Output<String>? = null, zoneId: Output<String>? = null)

Properties

Link copied to clipboard
val autoRenew: Output<String>? = null

Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).

Link copied to clipboard
val autoRenewPeriod: Output<String>? = null

The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.

Link copied to clipboard
val backupId: Output<String>? = null

You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,). If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.

Link copied to clipboard
val clusterBackupId: Output<String>? = null

This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).

Link copied to clipboard
val connectionStringPrefix: Output<String>? = null

The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.

Link copied to clipboard
val effectiveTime: Output<String>? = null

The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).

Link copied to clipboard
val engineVersion: Output<String>? = null

Database version. Default value: 1.0. Rules for transferring parameters of different tair product types: tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0. tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0. tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.

Link copied to clipboard
val forceUpgrade: Output<Boolean>? = null

Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).

Link copied to clipboard
val globalInstanceId: Output<String>? = null

The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.

Link copied to clipboard
val instanceClass: Output<String>? = null

The instance type of the instance. For more information, see Instance types.

Link copied to clipboard
val instanceType: Output<String>? = null

The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.

Link copied to clipboard
val intranetBandwidth: Output<Int>? = null

Instance intranet bandwidth

Link copied to clipboard
val modifyMode: Output<String>? = null

The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.

Link copied to clipboard
val nodeType: Output<String>? = null

The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).

Link copied to clipboard
val paramNoLooseSentinelEnabled: Output<String>? = null

sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.

Link copied to clipboard

Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance

Link copied to clipboard

After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details

Link copied to clipboard
val paramReplMode: Output<String>? = null

The value is semisync or async. The default value is async. The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.

Link copied to clipboard
val paramSemisyncReplTimeout: Output<String>? = null

The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.

Link copied to clipboard
val paramSentinelCompatEnable: Output<String>? = null

sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.

Link copied to clipboard
val password: Output<String>? = null

The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =

Link copied to clipboard
val paymentType: Output<String>? = null

Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.

Link copied to clipboard
val period: Output<Int>? = null

The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.

Link copied to clipboard
val port: Output<Int>? = null

The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.

Link copied to clipboard
val readOnlyCount: Output<Int>? = null

Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions: If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture. If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.

Link copied to clipboard
val recoverConfigMode: Output<String>? = null

Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.

Link copied to clipboard
val resourceGroupId: Output<String>? = null

The ID of the resource group to which the instance belongs.

Link copied to clipboard
val secondaryZoneId: Output<String>? = null

The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.

Link copied to clipboard
val securityGroupId: Output<String>? = null

Security group id

Link copied to clipboard
val securityIpGroupName: Output<String>? = null

The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.

Link copied to clipboard
val securityIps: Output<String>? = null

The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.

Link copied to clipboard
val shardCount: Output<Int>? = null

The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.

Link copied to clipboard
val slaveReadOnlyCount: Output<Int>? = null

Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance. Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.

Link copied to clipboard
val srcDbInstanceId: Output<String>? = null

If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.

Link copied to clipboard
val sslEnabled: Output<String>? = null

Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)

Link copied to clipboard
val storagePerformanceLevel: Output<String>? = null

The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected. If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1. If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2. If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.

Link copied to clipboard
val storageSizeGb: Output<Int>? = null

Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

The tag of the resource

Link copied to clipboard
val tairInstanceName: Output<String>? = null

The name of the resource.

Link copied to clipboard
val vpcAuthMode: Output<String>? = null

The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).

Link copied to clipboard
val vpcId: Output<String>? = null

The ID of the virtual private cloud (VPC).

Link copied to clipboard
val vswitchId: Output<String>? = null

The ID of the vSwitch to which the instance is connected.

Link copied to clipboard
val zoneId: Output<String>? = null

Zone ID

Functions

Link copied to clipboard
open override fun toJava(): TairInstanceArgs