redis

package
v3.75.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 7, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type TairInstance 

type TairInstance struct {
	pulumi.CustomResourceState

	// The architecture of the instance.  cluster, standard, rwsplit.
	ArchitectureType pulumi.StringOutput `pulumi:"architectureType"`
	// Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
	AutoRenew pulumi.StringPtrOutput `pulumi:"autoRenew"`
	// 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.
	AutoRenewPeriod pulumi.StringPtrOutput `pulumi:"autoRenewPeriod"`
	// 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.
	BackupId pulumi.StringPtrOutput `pulumi:"backupId"`
	// 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 (,).
	ClusterBackupId pulumi.StringPtrOutput `pulumi:"clusterBackupId"`
	// The internal endpoint of the instance.
	ConnectionDomain pulumi.StringOutput `pulumi:"connectionDomain"`
	// The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
	ConnectionStringPrefix pulumi.StringPtrOutput `pulumi:"connectionStringPrefix"`
	// The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// 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).
	EffectiveTime pulumi.StringPtrOutput `pulumi:"effectiveTime"`
	// 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.
	EngineVersion pulumi.StringOutput `pulumi:"engineVersion"`
	// 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).
	ForceUpgrade pulumi.BoolPtrOutput `pulumi:"forceUpgrade"`
	// 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.
	//
	// 1. Enter true if you want the new instance to be the first child instance.
	//
	// 2. If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
	//
	// 3. Not as a distributed instance, you do not need to enter any values.
	GlobalInstanceId pulumi.StringPtrOutput `pulumi:"globalInstanceId"`
	// The instance type of the instance. For more information, see [Instance types](https://www.alibabacloud.com/help/en/apsaradb-for-redis/latest/instance-types).
	InstanceClass pulumi.StringOutput `pulumi:"instanceClass"`
	// The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
	InstanceType pulumi.StringOutput `pulumi:"instanceType"`
	// Instance intranet bandwidth
	IntranetBandwidth pulumi.IntOutput `pulumi:"intranetBandwidth"`
	// The maximum number of connections supported by the instance.
	MaxConnections pulumi.IntOutput `pulumi:"maxConnections"`
	// 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.
	ModifyMode pulumi.StringPtrOutput `pulumi:"modifyMode"`
	// The network type of the instance.  CLASSIC(classic network), VPC.
	NetworkType pulumi.StringOutput `pulumi:"networkType"`
	// 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).
	NodeType pulumi.StringOutput `pulumi:"nodeType"`
	// 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.
	ParamNoLooseSentinelEnabled pulumi.StringOutput `pulumi:"paramNoLooseSentinelEnabled"`
	// 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
	ParamNoLooseSentinelPasswordFreeAccess pulumi.StringOutput `pulumi:"paramNoLooseSentinelPasswordFreeAccess"`
	// 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
	ParamNoLooseSentinelPasswordFreeCommands pulumi.StringOutput `pulumi:"paramNoLooseSentinelPasswordFreeCommands"`
	// 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 。
	ParamReplMode pulumi.StringOutput `pulumi:"paramReplMode"`
	// 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。
	ParamSemisyncReplTimeout pulumi.StringOutput `pulumi:"paramSemisyncReplTimeout"`
	// 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.
	ParamSentinelCompatEnable pulumi.StringOutput `pulumi:"paramSentinelCompatEnable"`
	// 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 ! @ # $ % ^ & * ( ) _ + - =
	Password pulumi.StringPtrOutput `pulumi:"password"`
	// Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
	PaymentType pulumi.StringOutput `pulumi:"paymentType"`
	// 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.
	Period pulumi.IntPtrOutput `pulumi:"period"`
	// The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
	Port pulumi.IntOutput `pulumi:"port"`
	// 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.
	ReadOnlyCount pulumi.IntPtrOutput `pulumi:"readOnlyCount"`
	// 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.
	RecoverConfigMode pulumi.StringPtrOutput `pulumi:"recoverConfigMode"`
	// Region Id
	RegionId pulumi.StringOutput `pulumi:"regionId"`
	// The ID of the resource group to which the instance belongs.
	ResourceGroupId pulumi.StringOutput `pulumi:"resourceGroupId"`
	// The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
	SecondaryZoneId pulumi.StringPtrOutput `pulumi:"secondaryZoneId"`
	// Security group id
	SecurityGroupId pulumi.StringPtrOutput `pulumi:"securityGroupId"`
	// 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.
	SecurityIpGroupName pulumi.StringOutput `pulumi:"securityIpGroupName"`
	// 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.
	SecurityIps pulumi.StringOutput `pulumi:"securityIps"`
	// 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.
	ShardCount pulumi.IntOutput `pulumi:"shardCount"`
	// 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.
	SlaveReadOnlyCount pulumi.IntPtrOutput `pulumi:"slaveReadOnlyCount"`
	// 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.
	SrcDbInstanceId pulumi.StringPtrOutput `pulumi:"srcDbInstanceId"`
	// 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)
	SslEnabled pulumi.StringOutput `pulumi:"sslEnabled"`
	// The status of the resource
	Status pulumi.StringOutput `pulumi:"status"`
	// 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.
	StoragePerformanceLevel pulumi.StringPtrOutput `pulumi:"storagePerformanceLevel"`
	// Different specifications have different value ranges. When the instanceType value is tairEssd 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.
	StorageSizeGb pulumi.IntOutput `pulumi:"storageSizeGb"`
	// The tag of the resource
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// The ID of the resource.
	TairInstanceId pulumi.StringOutput `pulumi:"tairInstanceId"`
	// The name of the resource.
	TairInstanceName pulumi.StringPtrOutput `pulumi:"tairInstanceName"`
	// The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables [password-free access](https://www.alibabacloud.com/help/en/apsaradb-for-redis/latest/enable-password-free-access)).
	VpcAuthMode pulumi.StringOutput `pulumi:"vpcAuthMode"`
	// The ID of the virtual private cloud (VPC).
	VpcId pulumi.StringOutput `pulumi:"vpcId"`
	// The ID of the vSwitch to which the instance is connected.
	VswitchId pulumi.StringOutput `pulumi:"vswitchId"`
	// Zone ID
	ZoneId pulumi.StringOutput `pulumi:"zoneId"`
}

## Import

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

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

func GetTairInstance 

func GetTairInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TairInstanceState, opts ...pulumi.ResourceOption) (*TairInstance, error)

GetTairInstance gets an existing TairInstance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTairInstance 

func NewTairInstance(ctx *pulumi.Context,
	name string, args *TairInstanceArgs, opts ...pulumi.ResourceOption) (*TairInstance, error)

NewTairInstance registers a new resource with the given unique name, arguments, and options.

func (*TairInstance) ElementType 

func (*TairInstance) ElementType() reflect.Type

func (*TairInstance) ToTairInstanceOutput 

func (i *TairInstance) ToTairInstanceOutput() TairInstanceOutput

func (*TairInstance) ToTairInstanceOutputWithContext 

func (i *TairInstance) ToTairInstanceOutputWithContext(ctx context.Context) TairInstanceOutput

type TairInstanceArgs 

type TairInstanceArgs struct {
	// Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
	AutoRenew pulumi.StringPtrInput
	// 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.
	AutoRenewPeriod pulumi.StringPtrInput
	// 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.
	BackupId pulumi.StringPtrInput
	// 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 (,).
	ClusterBackupId pulumi.StringPtrInput
	// The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
	ConnectionStringPrefix pulumi.StringPtrInput
	// 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).
	EffectiveTime pulumi.StringPtrInput
	// 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.
	EngineVersion pulumi.StringPtrInput
	// 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).
	ForceUpgrade pulumi.BoolPtrInput
	// 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.
	//
	// 1. Enter true if you want the new instance to be the first child instance.
	//
	// 2. If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
	//
	// 3. Not as a distributed instance, you do not need to enter any values.
	GlobalInstanceId pulumi.StringPtrInput
	// The instance type of the instance. For more information, see [Instance types](https://www.alibabacloud.com/help/en/apsaradb-for-redis/latest/instance-types).
	InstanceClass pulumi.StringInput
	// The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
	InstanceType pulumi.StringInput
	// Instance intranet bandwidth
	IntranetBandwidth pulumi.IntPtrInput
	// 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.
	ModifyMode pulumi.StringPtrInput
	// 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).
	NodeType pulumi.StringPtrInput
	// 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.
	ParamNoLooseSentinelEnabled pulumi.StringPtrInput
	// 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
	ParamNoLooseSentinelPasswordFreeAccess pulumi.StringPtrInput
	// 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
	ParamNoLooseSentinelPasswordFreeCommands pulumi.StringPtrInput
	// 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 。
	ParamReplMode pulumi.StringPtrInput
	// 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。
	ParamSemisyncReplTimeout pulumi.StringPtrInput
	// 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.
	ParamSentinelCompatEnable pulumi.StringPtrInput
	// 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 ! @ # $ % ^ & * ( ) _ + - =
	Password pulumi.StringPtrInput
	// Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
	PaymentType pulumi.StringPtrInput
	// 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.
	Period pulumi.IntPtrInput
	// The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
	Port pulumi.IntPtrInput
	// 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.
	ReadOnlyCount pulumi.IntPtrInput
	// 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.
	RecoverConfigMode pulumi.StringPtrInput
	// The ID of the resource group to which the instance belongs.
	ResourceGroupId pulumi.StringPtrInput
	// The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
	SecondaryZoneId pulumi.StringPtrInput
	// Security group id
	SecurityGroupId pulumi.StringPtrInput
	// 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.
	SecurityIpGroupName pulumi.StringPtrInput
	// 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.
	SecurityIps pulumi.StringPtrInput
	// 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.
	ShardCount pulumi.IntPtrInput
	// 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.
	SlaveReadOnlyCount pulumi.IntPtrInput
	// 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.
	SrcDbInstanceId pulumi.StringPtrInput
	// 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)
	SslEnabled pulumi.StringPtrInput
	// 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.
	StoragePerformanceLevel pulumi.StringPtrInput
	// Different specifications have different value ranges. When the instanceType value is tairEssd 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.
	StorageSizeGb pulumi.IntPtrInput
	// The tag of the resource
	Tags pulumi.StringMapInput
	// The name of the resource.
	TairInstanceName pulumi.StringPtrInput
	// The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables [password-free access](https://www.alibabacloud.com/help/en/apsaradb-for-redis/latest/enable-password-free-access)).
	VpcAuthMode pulumi.StringPtrInput
	// The ID of the virtual private cloud (VPC).
	VpcId pulumi.StringInput
	// The ID of the vSwitch to which the instance is connected.
	VswitchId pulumi.StringInput
	// Zone ID
	ZoneId pulumi.StringInput
}

The set of arguments for constructing a TairInstance resource.

func (TairInstanceArgs) ElementType 

func (TairInstanceArgs) ElementType() reflect.Type

type TairInstanceArray 

type TairInstanceArray []TairInstanceInput

func (TairInstanceArray) ElementType 

func (TairInstanceArray) ElementType() reflect.Type

func (TairInstanceArray) ToTairInstanceArrayOutput 

func (i TairInstanceArray) ToTairInstanceArrayOutput() TairInstanceArrayOutput

func (TairInstanceArray) ToTairInstanceArrayOutputWithContext 

func (i TairInstanceArray) ToTairInstanceArrayOutputWithContext(ctx context.Context) TairInstanceArrayOutput

type TairInstanceArrayInput 

type TairInstanceArrayInput interface {
	pulumi.Input

	ToTairInstanceArrayOutput() TairInstanceArrayOutput
	ToTairInstanceArrayOutputWithContext(context.Context) TairInstanceArrayOutput
}

TairInstanceArrayInput is an input type that accepts TairInstanceArray and TairInstanceArrayOutput values. You can construct a concrete instance of `TairInstanceArrayInput` via: 

TairInstanceArray{ TairInstanceArgs{...} }

type TairInstanceArrayOutput 

type TairInstanceArrayOutput struct{ *pulumi.OutputState }

func (TairInstanceArrayOutput) ElementType 

func (TairInstanceArrayOutput) ElementType() reflect.Type

func (TairInstanceArrayOutput) Index 

func (o TairInstanceArrayOutput) Index(i pulumi.IntInput) TairInstanceOutput

func (TairInstanceArrayOutput) ToTairInstanceArrayOutput 

func (o TairInstanceArrayOutput) ToTairInstanceArrayOutput() TairInstanceArrayOutput

func (TairInstanceArrayOutput) ToTairInstanceArrayOutputWithContext 

func (o TairInstanceArrayOutput) ToTairInstanceArrayOutputWithContext(ctx context.Context) TairInstanceArrayOutput

type TairInstanceInput 

type TairInstanceInput interface {
	pulumi.Input

	ToTairInstanceOutput() TairInstanceOutput
	ToTairInstanceOutputWithContext(ctx context.Context) TairInstanceOutput
}

type TairInstanceMap 

type TairInstanceMap map[string]TairInstanceInput

func (TairInstanceMap) ElementType 

func (TairInstanceMap) ElementType() reflect.Type

func (TairInstanceMap) ToTairInstanceMapOutput 

func (i TairInstanceMap) ToTairInstanceMapOutput() TairInstanceMapOutput

func (TairInstanceMap) ToTairInstanceMapOutputWithContext 

func (i TairInstanceMap) ToTairInstanceMapOutputWithContext(ctx context.Context) TairInstanceMapOutput

type TairInstanceMapInput 

type TairInstanceMapInput interface {
	pulumi.Input

	ToTairInstanceMapOutput() TairInstanceMapOutput
	ToTairInstanceMapOutputWithContext(context.Context) TairInstanceMapOutput
}

TairInstanceMapInput is an input type that accepts TairInstanceMap and TairInstanceMapOutput values. You can construct a concrete instance of `TairInstanceMapInput` via: 

TairInstanceMap{ "key": TairInstanceArgs{...} }

type TairInstanceMapOutput 

type TairInstanceMapOutput struct{ *pulumi.OutputState }

func (TairInstanceMapOutput) ElementType 

func (TairInstanceMapOutput) ElementType() reflect.Type

func (TairInstanceMapOutput) MapIndex 

func (o TairInstanceMapOutput) MapIndex(k pulumi.StringInput) TairInstanceOutput

func (TairInstanceMapOutput) ToTairInstanceMapOutput 

func (o TairInstanceMapOutput) ToTairInstanceMapOutput() TairInstanceMapOutput

func (TairInstanceMapOutput) ToTairInstanceMapOutputWithContext 

func (o TairInstanceMapOutput) ToTairInstanceMapOutputWithContext(ctx context.Context) TairInstanceMapOutput

type TairInstanceOutput 

type TairInstanceOutput struct{ *pulumi.OutputState }

func (TairInstanceOutput) ArchitectureType added in v3.65.1 

func (o TairInstanceOutput) ArchitectureType() pulumi.StringOutput

The architecture of the instance. cluster, standard, rwsplit.

func (TairInstanceOutput) AutoRenew 

func (o TairInstanceOutput) AutoRenew() pulumi.StringPtrOutput

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

func (TairInstanceOutput) AutoRenewPeriod 

func (o TairInstanceOutput) AutoRenewPeriod() pulumi.StringPtrOutput

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.

func (TairInstanceOutput) BackupId added in v3.65.1 

func (o TairInstanceOutput) BackupId() pulumi.StringPtrOutput

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.

func (TairInstanceOutput) ClusterBackupId added in v3.56.0 

func (o TairInstanceOutput) ClusterBackupId() pulumi.StringPtrOutput

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 (,).

func (TairInstanceOutput) ConnectionDomain added in v3.65.1 

func (o TairInstanceOutput) ConnectionDomain() pulumi.StringOutput

The internal endpoint of the instance.

func (TairInstanceOutput) ConnectionStringPrefix added in v3.67.0 

func (o TairInstanceOutput) ConnectionStringPrefix() pulumi.StringPtrOutput

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

func (TairInstanceOutput) CreateTime 

func (o TairInstanceOutput) CreateTime() pulumi.StringOutput

The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

func (TairInstanceOutput) EffectiveTime 

func (o TairInstanceOutput) EffectiveTime() pulumi.StringPtrOutput

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).

func (TairInstanceOutput) ElementType 

func (TairInstanceOutput) ElementType() reflect.Type

func (TairInstanceOutput) EngineVersion 

func (o TairInstanceOutput) EngineVersion() pulumi.StringOutput

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.

func (TairInstanceOutput) ForceUpgrade 

func (o TairInstanceOutput) ForceUpgrade() pulumi.BoolPtrOutput

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).

func (TairInstanceOutput) GlobalInstanceId added in v3.65.1 

func (o TairInstanceOutput) GlobalInstanceId() pulumi.StringPtrOutput

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.

1. Enter true if you want the new instance to be the first child instance.

2. If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.

3. Not as a distributed instance, you do not need to enter any values.

func (TairInstanceOutput) InstanceClass 

func (o TairInstanceOutput) InstanceClass() pulumi.StringOutput

The instance type of the instance. For more information, see [Instance types](https://www.alibabacloud.com/help/en/apsaradb-for-redis/latest/instance-types).

func (TairInstanceOutput) InstanceType 

func (o TairInstanceOutput) InstanceType() pulumi.StringOutput

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

func (TairInstanceOutput) IntranetBandwidth added in v3.65.1 

func (o TairInstanceOutput) IntranetBandwidth() pulumi.IntOutput

Instance intranet bandwidth

func (TairInstanceOutput) MaxConnections added in v3.65.1 

func (o TairInstanceOutput) MaxConnections() pulumi.IntOutput

The maximum number of connections supported by the instance.

func (TairInstanceOutput) ModifyMode added in v3.65.1 

func (o TairInstanceOutput) ModifyMode() pulumi.StringPtrOutput

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.

func (TairInstanceOutput) NetworkType added in v3.65.1 

func (o TairInstanceOutput) NetworkType() pulumi.StringOutput

The network type of the instance. CLASSIC(classic network), VPC.

func (TairInstanceOutput) NodeType added in v3.56.0 

func (o TairInstanceOutput) NodeType() pulumi.StringOutput

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).

func (TairInstanceOutput) ParamNoLooseSentinelEnabled added in v3.65.1 

func (o TairInstanceOutput) ParamNoLooseSentinelEnabled() pulumi.StringOutput

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.

func (TairInstanceOutput) ParamNoLooseSentinelPasswordFreeAccess added in v3.69.0 

func (o TairInstanceOutput) ParamNoLooseSentinelPasswordFreeAccess() pulumi.StringOutput

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

func (TairInstanceOutput) ParamNoLooseSentinelPasswordFreeCommands added in v3.71.0 

func (o TairInstanceOutput) ParamNoLooseSentinelPasswordFreeCommands() pulumi.StringOutput

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

func (TairInstanceOutput) ParamReplMode added in v3.65.1 

func (o TairInstanceOutput) ParamReplMode() pulumi.StringOutput

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 。

func (TairInstanceOutput) ParamSemisyncReplTimeout added in v3.65.1 

func (o TairInstanceOutput) ParamSemisyncReplTimeout() pulumi.StringOutput

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。

func (TairInstanceOutput) ParamSentinelCompatEnable added in v3.65.1 

func (o TairInstanceOutput) ParamSentinelCompatEnable() pulumi.StringOutput

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.

func (TairInstanceOutput) Password 

func (o TairInstanceOutput) Password() pulumi.StringPtrOutput

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 ! @ # $ % ^ & * ( ) _ + - =

func (TairInstanceOutput) PaymentType 

func (o TairInstanceOutput) PaymentType() pulumi.StringOutput

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

func (TairInstanceOutput) Period 

func (o TairInstanceOutput) Period() pulumi.IntPtrOutput

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.

func (TairInstanceOutput) Port 

func (o TairInstanceOutput) Port() pulumi.IntOutput

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

func (TairInstanceOutput) ReadOnlyCount added in v3.56.0 

func (o TairInstanceOutput) ReadOnlyCount() pulumi.IntPtrOutput

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.

func (TairInstanceOutput) RecoverConfigMode added in v3.65.1 

func (o TairInstanceOutput) RecoverConfigMode() pulumi.StringPtrOutput

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.

func (TairInstanceOutput) RegionId added in v3.67.0 

func (o TairInstanceOutput) RegionId() pulumi.StringOutput

Region Id

func (TairInstanceOutput) ResourceGroupId 

func (o TairInstanceOutput) ResourceGroupId() pulumi.StringOutput

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

func (TairInstanceOutput) SecondaryZoneId 

func (o TairInstanceOutput) SecondaryZoneId() pulumi.StringPtrOutput

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

func (TairInstanceOutput) SecurityGroupId added in v3.59.0 

func (o TairInstanceOutput) SecurityGroupId() pulumi.StringPtrOutput

Security group id

func (TairInstanceOutput) SecurityIpGroupName added in v3.65.1 

func (o TairInstanceOutput) SecurityIpGroupName() pulumi.StringOutput

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.

func (TairInstanceOutput) SecurityIps added in v3.65.1 

func (o TairInstanceOutput) SecurityIps() pulumi.StringOutput

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.

func (TairInstanceOutput) ShardCount 

func (o TairInstanceOutput) ShardCount() pulumi.IntOutput

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.

func (TairInstanceOutput) SlaveReadOnlyCount added in v3.56.0 

func (o TairInstanceOutput) SlaveReadOnlyCount() pulumi.IntPtrOutput

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.

func (TairInstanceOutput) SrcDbInstanceId added in v3.65.1 

func (o TairInstanceOutput) SrcDbInstanceId() pulumi.StringPtrOutput

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.

func (TairInstanceOutput) SslEnabled added in v3.59.0 

func (o TairInstanceOutput) SslEnabled() pulumi.StringOutput

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)

func (TairInstanceOutput) Status 

func (o TairInstanceOutput) Status() pulumi.StringOutput

The status of the resource

func (TairInstanceOutput) StoragePerformanceLevel added in v3.44.1 

func (o TairInstanceOutput) StoragePerformanceLevel() pulumi.StringPtrOutput

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.

func (TairInstanceOutput) StorageSizeGb added in v3.44.1 

func (o TairInstanceOutput) StorageSizeGb() pulumi.IntOutput

Different specifications have different value ranges. When the instanceType value is tairEssd 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.

func (TairInstanceOutput) Tags added in v3.44.1 

func (o TairInstanceOutput) Tags() pulumi.StringMapOutput

The tag of the resource

func (TairInstanceOutput) TairInstanceId added in v3.65.1 

func (o TairInstanceOutput) TairInstanceId() pulumi.StringOutput

The ID of the resource.

func (TairInstanceOutput) TairInstanceName 

func (o TairInstanceOutput) TairInstanceName() pulumi.StringPtrOutput

The name of the resource.

func (TairInstanceOutput) ToTairInstanceOutput 

func (o TairInstanceOutput) ToTairInstanceOutput() TairInstanceOutput

func (TairInstanceOutput) ToTairInstanceOutputWithContext 

func (o TairInstanceOutput) ToTairInstanceOutputWithContext(ctx context.Context) TairInstanceOutput

func (TairInstanceOutput) VpcAuthMode added in v3.65.1 

func (o TairInstanceOutput) VpcAuthMode() pulumi.StringOutput

The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables [password-free access](https://www.alibabacloud.com/help/en/apsaradb-for-redis/latest/enable-password-free-access)).

func (TairInstanceOutput) VpcId 

func (o TairInstanceOutput) VpcId() pulumi.StringOutput

The ID of the virtual private cloud (VPC).

func (TairInstanceOutput) VswitchId 

func (o TairInstanceOutput) VswitchId() pulumi.StringOutput

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

func (TairInstanceOutput) ZoneId 

func (o TairInstanceOutput) ZoneId() pulumi.StringOutput

Zone ID

type TairInstanceState 

type TairInstanceState struct {
	// The architecture of the instance.  cluster, standard, rwsplit.
	ArchitectureType pulumi.StringPtrInput
	// Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
	AutoRenew pulumi.StringPtrInput
	// 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.
	AutoRenewPeriod pulumi.StringPtrInput
	// 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.
	BackupId pulumi.StringPtrInput
	// 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 (,).
	ClusterBackupId pulumi.StringPtrInput
	// The internal endpoint of the instance.
	ConnectionDomain pulumi.StringPtrInput
	// The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
	ConnectionStringPrefix pulumi.StringPtrInput
	// The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	CreateTime pulumi.StringPtrInput
	// 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).
	EffectiveTime pulumi.StringPtrInput
	// 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.
	EngineVersion pulumi.StringPtrInput
	// 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).
	ForceUpgrade pulumi.BoolPtrInput
	// 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.
	//
	// 1. Enter true if you want the new instance to be the first child instance.
	//
	// 2. If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
	//
	// 3. Not as a distributed instance, you do not need to enter any values.
	GlobalInstanceId pulumi.StringPtrInput
	// The instance type of the instance. For more information, see [Instance types](https://www.alibabacloud.com/help/en/apsaradb-for-redis/latest/instance-types).
	InstanceClass pulumi.StringPtrInput
	// The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
	InstanceType pulumi.StringPtrInput
	// Instance intranet bandwidth
	IntranetBandwidth pulumi.IntPtrInput
	// The maximum number of connections supported by the instance.
	MaxConnections pulumi.IntPtrInput
	// 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.
	ModifyMode pulumi.StringPtrInput
	// The network type of the instance.  CLASSIC(classic network), VPC.
	NetworkType pulumi.StringPtrInput
	// 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).
	NodeType pulumi.StringPtrInput
	// 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.
	ParamNoLooseSentinelEnabled pulumi.StringPtrInput
	// 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
	ParamNoLooseSentinelPasswordFreeAccess pulumi.StringPtrInput
	// 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
	ParamNoLooseSentinelPasswordFreeCommands pulumi.StringPtrInput
	// 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 。
	ParamReplMode pulumi.StringPtrInput
	// 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。
	ParamSemisyncReplTimeout pulumi.StringPtrInput
	// 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.
	ParamSentinelCompatEnable pulumi.StringPtrInput
	// 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 ! @ # $ % ^ & * ( ) _ + - =
	Password pulumi.StringPtrInput
	// Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
	PaymentType pulumi.StringPtrInput
	// 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.
	Period pulumi.IntPtrInput
	// The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
	Port pulumi.IntPtrInput
	// 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.
	ReadOnlyCount pulumi.IntPtrInput
	// 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.
	RecoverConfigMode pulumi.StringPtrInput
	// Region Id
	RegionId pulumi.StringPtrInput
	// The ID of the resource group to which the instance belongs.
	ResourceGroupId pulumi.StringPtrInput
	// The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
	SecondaryZoneId pulumi.StringPtrInput
	// Security group id
	SecurityGroupId pulumi.StringPtrInput
	// 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.
	SecurityIpGroupName pulumi.StringPtrInput
	// 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.
	SecurityIps pulumi.StringPtrInput
	// 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.
	ShardCount pulumi.IntPtrInput
	// 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.
	SlaveReadOnlyCount pulumi.IntPtrInput
	// 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.
	SrcDbInstanceId pulumi.StringPtrInput
	// 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)
	SslEnabled pulumi.StringPtrInput
	// The status of the resource
	Status pulumi.StringPtrInput
	// 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.
	StoragePerformanceLevel pulumi.StringPtrInput
	// Different specifications have different value ranges. When the instanceType value is tairEssd 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.
	StorageSizeGb pulumi.IntPtrInput
	// The tag of the resource
	Tags pulumi.StringMapInput
	// The ID of the resource.
	TairInstanceId pulumi.StringPtrInput
	// The name of the resource.
	TairInstanceName pulumi.StringPtrInput
	// The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables [password-free access](https://www.alibabacloud.com/help/en/apsaradb-for-redis/latest/enable-password-free-access)).
	VpcAuthMode pulumi.StringPtrInput
	// The ID of the virtual private cloud (VPC).
	VpcId pulumi.StringPtrInput
	// The ID of the vSwitch to which the instance is connected.
	VswitchId pulumi.StringPtrInput
	// Zone ID
	ZoneId pulumi.StringPtrInput
}

func (TairInstanceState) ElementType 

func (TairInstanceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.