Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. redis
  5. TairInstance
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.redis.TairInstance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

    Import

    Redis Tair Instance can be imported using the id, e.g.

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

    Create TairInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TairInstance(name: string, args: TairInstanceArgs, opts?: CustomResourceOptions);
    @overload
def TairInstance(resource_name: str,
                 args: TairInstanceArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def TairInstance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance_class: Optional[str] = None,
                 zone_id: Optional[str] = None,
                 vswitch_id: Optional[str] = None,
                 vpc_id: Optional[str] = None,
                 instance_type: Optional[str] = None,
                 port: Optional[int] = None,
                 resource_group_id: Optional[str] = None,
                 engine_version: Optional[str] = None,
                 node_type: Optional[str] = None,
                 password: Optional[str] = None,
                 payment_type: Optional[str] = None,
                 period: Optional[int] = None,
                 auto_renew: Optional[str] = None,
                 read_only_count: Optional[int] = None,
                 force_upgrade: Optional[bool] = None,
                 secondary_zone_id: Optional[str] = None,
                 shard_count: Optional[int] = None,
                 slave_read_only_count: Optional[int] = None,
                 storage_performance_level: Optional[str] = None,
                 storage_size_gb: Optional[int] = None,
                 tags: Optional[Mapping[str, Any]] = None,
                 tair_instance_name: Optional[str] = None,
                 effective_time: Optional[str] = None,
                 cluster_backup_id: Optional[str] = None,
                 auto_renew_period: Optional[str] = None)
    func NewTairInstance(ctx *Context, name string, args TairInstanceArgs, opts ...ResourceOption) (*TairInstance, error)
    public TairInstance(string name, TairInstanceArgs args, CustomResourceOptions? opts = null)
    public TairInstance(String name, TairInstanceArgs args)
public TairInstance(String name, TairInstanceArgs args, CustomResourceOptions options)

    type: alicloud:redis:TairInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TairInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TairInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TairInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TairInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TairInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var tairInstanceResource = new AliCloud.Redis.TairInstance("tairInstanceResource", new()
{
    InstanceClass = "string",
    ZoneId = "string",
    VswitchId = "string",
    VpcId = "string",
    InstanceType = "string",
    Port = 0,
    ResourceGroupId = "string",
    EngineVersion = "string",
    NodeType = "string",
    Password = "string",
    PaymentType = "string",
    Period = 0,
    AutoRenew = "string",
    ReadOnlyCount = 0,
    ForceUpgrade = false,
    SecondaryZoneId = "string",
    ShardCount = 0,
    SlaveReadOnlyCount = 0,
    StoragePerformanceLevel = "string",
    StorageSizeGb = 0,
    Tags = 
    {
        { "string", "any" },
    },
    TairInstanceName = "string",
    EffectiveTime = "string",
    ClusterBackupId = "string",
    AutoRenewPeriod = "string",
});

    example, err := redis.NewTairInstance(ctx, "tairInstanceResource", &redis.TairInstanceArgs{
	InstanceClass:           pulumi.String("string"),
	ZoneId:                  pulumi.String("string"),
	VswitchId:               pulumi.String("string"),
	VpcId:                   pulumi.String("string"),
	InstanceType:            pulumi.String("string"),
	Port:                    pulumi.Int(0),
	ResourceGroupId:         pulumi.String("string"),
	EngineVersion:           pulumi.String("string"),
	NodeType:                pulumi.String("string"),
	Password:                pulumi.String("string"),
	PaymentType:             pulumi.String("string"),
	Period:                  pulumi.Int(0),
	AutoRenew:               pulumi.String("string"),
	ReadOnlyCount:           pulumi.Int(0),
	ForceUpgrade:            pulumi.Bool(false),
	SecondaryZoneId:         pulumi.String("string"),
	ShardCount:              pulumi.Int(0),
	SlaveReadOnlyCount:      pulumi.Int(0),
	StoragePerformanceLevel: pulumi.String("string"),
	StorageSizeGb:           pulumi.Int(0),
	Tags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	TairInstanceName: pulumi.String("string"),
	EffectiveTime:    pulumi.String("string"),
	ClusterBackupId:  pulumi.String("string"),
	AutoRenewPeriod:  pulumi.String("string"),
})

    var tairInstanceResource = new TairInstance("tairInstanceResource", TairInstanceArgs.builder()
    .instanceClass("string")
    .zoneId("string")
    .vswitchId("string")
    .vpcId("string")
    .instanceType("string")
    .port(0)
    .resourceGroupId("string")
    .engineVersion("string")
    .nodeType("string")
    .password("string")
    .paymentType("string")
    .period(0)
    .autoRenew("string")
    .readOnlyCount(0)
    .forceUpgrade(false)
    .secondaryZoneId("string")
    .shardCount(0)
    .slaveReadOnlyCount(0)
    .storagePerformanceLevel("string")
    .storageSizeGb(0)
    .tags(Map.of("string", "any"))
    .tairInstanceName("string")
    .effectiveTime("string")
    .clusterBackupId("string")
    .autoRenewPeriod("string")
    .build());

    tair_instance_resource = alicloud.redis.TairInstance("tairInstanceResource",
    instance_class="string",
    zone_id="string",
    vswitch_id="string",
    vpc_id="string",
    instance_type="string",
    port=0,
    resource_group_id="string",
    engine_version="string",
    node_type="string",
    password="string",
    payment_type="string",
    period=0,
    auto_renew="string",
    read_only_count=0,
    force_upgrade=False,
    secondary_zone_id="string",
    shard_count=0,
    slave_read_only_count=0,
    storage_performance_level="string",
    storage_size_gb=0,
    tags={
        "string": "any",
    },
    tair_instance_name="string",
    effective_time="string",
    cluster_backup_id="string",
    auto_renew_period="string")

    const tairInstanceResource = new alicloud.redis.TairInstance("tairInstanceResource", {
    instanceClass: "string",
    zoneId: "string",
    vswitchId: "string",
    vpcId: "string",
    instanceType: "string",
    port: 0,
    resourceGroupId: "string",
    engineVersion: "string",
    nodeType: "string",
    password: "string",
    paymentType: "string",
    period: 0,
    autoRenew: "string",
    readOnlyCount: 0,
    forceUpgrade: false,
    secondaryZoneId: "string",
    shardCount: 0,
    slaveReadOnlyCount: 0,
    storagePerformanceLevel: "string",
    storageSizeGb: 0,
    tags: {
        string: "any",
    },
    tairInstanceName: "string",
    effectiveTime: "string",
    clusterBackupId: "string",
    autoRenewPeriod: "string",
});

    type: alicloud:redis:TairInstance
properties:
    autoRenew: string
    autoRenewPeriod: string
    clusterBackupId: string
    effectiveTime: string
    engineVersion: string
    forceUpgrade: false
    instanceClass: string
    instanceType: string
    nodeType: string
    password: string
    paymentType: string
    period: 0
    port: 0
    readOnlyCount: 0
    resourceGroupId: string
    secondaryZoneId: string
    shardCount: 0
    slaveReadOnlyCount: 0
    storagePerformanceLevel: string
    storageSizeGb: 0
    tags:
        string: any
    tairInstanceName: string
    vpcId: string
    vswitchId: string
    zoneId: string

    TairInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TairInstance resource accepts the following input properties:

    InstanceClass string
    The instance type of the instance. For more information, see Instance types.
    InstanceType string
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    VpcId string
    The ID of the virtual private cloud (VPC).
    VswitchId string
    The ID of the vSwitch to which the instance is connected.
    ZoneId string
    Zone ID.
    AutoRenew string
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    AutoRenewPeriod string
    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.
    ClusterBackupId string
    The ID of the backup set of the cluster. .
    EffectiveTime string
    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).
    EngineVersion string
    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.
    ForceUpgrade bool
    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).
    NodeType string
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    Password string
    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 ! @ # $ % ^ & * ( ) _ + - =.
    PaymentType string
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    Period int
    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.
    Port int
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    ReadOnlyCount int
    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.
    ResourceGroupId string
    The ID of the resource group to which the instance belongs.
    SecondaryZoneId string
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    ShardCount int
    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.
    SlaveReadOnlyCount int
    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.
    StoragePerformanceLevel string
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    StorageSizeGb int
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    Tags Dictionary<string, object>
    The tag of the resource.
    TairInstanceName string
    The name of the resource.
    InstanceClass string
    The instance type of the instance. For more information, see Instance types.
    InstanceType string
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    VpcId string
    The ID of the virtual private cloud (VPC).
    VswitchId string
    The ID of the vSwitch to which the instance is connected.
    ZoneId string
    Zone ID.
    AutoRenew string
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    AutoRenewPeriod string
    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.
    ClusterBackupId string
    The ID of the backup set of the cluster. .
    EffectiveTime string
    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).
    EngineVersion string
    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.
    ForceUpgrade bool
    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).
    NodeType string
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    Password string
    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 ! @ # $ % ^ & * ( ) _ + - =.
    PaymentType string
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    Period int
    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.
    Port int
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    ReadOnlyCount int
    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.
    ResourceGroupId string
    The ID of the resource group to which the instance belongs.
    SecondaryZoneId string
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    ShardCount int
    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.
    SlaveReadOnlyCount int
    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.
    StoragePerformanceLevel string
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    StorageSizeGb int
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    Tags map[string]interface{}
    The tag of the resource.
    TairInstanceName string
    The name of the resource.
    instanceClass String
    The instance type of the instance. For more information, see Instance types.
    instanceType String
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    vpcId String
    The ID of the virtual private cloud (VPC).
    vswitchId String
    The ID of the vSwitch to which the instance is connected.
    zoneId String
    Zone ID.
    autoRenew String
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    autoRenewPeriod String
    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.
    clusterBackupId String
    The ID of the backup set of the cluster. .
    effectiveTime String
    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).
    engineVersion String
    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.
    forceUpgrade Boolean
    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).
    nodeType String
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    password String
    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 ! @ # $ % ^ & * ( ) _ + - =.
    paymentType String
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    period Integer
    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.
    port Integer
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    readOnlyCount Integer
    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.
    resourceGroupId String
    The ID of the resource group to which the instance belongs.
    secondaryZoneId String
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    shardCount Integer
    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.
    slaveReadOnlyCount Integer
    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.
    storagePerformanceLevel String
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    storageSizeGb Integer
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    tags Map<String,Object>
    The tag of the resource.
    tairInstanceName String
    The name of the resource.
    instanceClass string
    The instance type of the instance. For more information, see Instance types.
    instanceType string
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    vpcId string
    The ID of the virtual private cloud (VPC).
    vswitchId string
    The ID of the vSwitch to which the instance is connected.
    zoneId string
    Zone ID.
    autoRenew string
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    autoRenewPeriod string
    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.
    clusterBackupId string
    The ID of the backup set of the cluster. .
    effectiveTime string
    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).
    engineVersion string
    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.
    forceUpgrade boolean
    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).
    nodeType string
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    password string
    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 ! @ # $ % ^ & * ( ) _ + - =.
    paymentType string
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    period number
    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.
    port number
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    readOnlyCount number
    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.
    resourceGroupId string
    The ID of the resource group to which the instance belongs.
    secondaryZoneId string
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    shardCount number
    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.
    slaveReadOnlyCount number
    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.
    storagePerformanceLevel string
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    storageSizeGb number
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    tags {[key: string]: any}
    The tag of the resource.
    tairInstanceName string
    The name of the resource.
    instance_class str
    The instance type of the instance. For more information, see Instance types.
    instance_type str
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    vpc_id str
    The ID of the virtual private cloud (VPC).
    vswitch_id str
    The ID of the vSwitch to which the instance is connected.
    zone_id str
    Zone ID.
    auto_renew str
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    auto_renew_period str
    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.
    cluster_backup_id str
    The ID of the backup set of the cluster. .
    effective_time str
    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).
    engine_version str
    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.
    force_upgrade bool
    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).
    node_type str
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    password str
    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 ! @ # $ % ^ & * ( ) _ + - =.
    payment_type str
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    period int
    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.
    port int
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    read_only_count int
    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.
    resource_group_id str
    The ID of the resource group to which the instance belongs.
    secondary_zone_id str
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    shard_count int
    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.
    slave_read_only_count int
    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.
    storage_performance_level str
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    storage_size_gb int
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    tags Mapping[str, Any]
    The tag of the resource.
    tair_instance_name str
    The name of the resource.
    instanceClass String
    The instance type of the instance. For more information, see Instance types.
    instanceType String
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    vpcId String
    The ID of the virtual private cloud (VPC).
    vswitchId String
    The ID of the vSwitch to which the instance is connected.
    zoneId String
    Zone ID.
    autoRenew String
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    autoRenewPeriod String
    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.
    clusterBackupId String
    The ID of the backup set of the cluster. .
    effectiveTime String
    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).
    engineVersion String
    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.
    forceUpgrade Boolean
    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).
    nodeType String
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    password String
    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 ! @ # $ % ^ & * ( ) _ + - =.
    paymentType String
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    period Number
    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.
    port Number
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    readOnlyCount Number
    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.
    resourceGroupId String
    The ID of the resource group to which the instance belongs.
    secondaryZoneId String
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    shardCount Number
    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.
    slaveReadOnlyCount Number
    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.
    storagePerformanceLevel String
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    storageSizeGb Number
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    tags Map<Any>
    The tag of the resource.
    tairInstanceName String
    The name of the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TairInstance resource produces the following output properties:

    CreateTime string
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource.
    CreateTime string
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource.
    createTime String
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource.
    createTime string
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the resource.
    create_time str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the resource.
    createTime String
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource.

    Look up Existing TairInstance Resource

    Get an existing TairInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TairInstanceState, opts?: CustomResourceOptions): TairInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew: Optional[str] = None,
        auto_renew_period: Optional[str] = None,
        cluster_backup_id: Optional[str] = None,
        create_time: Optional[str] = None,
        effective_time: Optional[str] = None,
        engine_version: Optional[str] = None,
        force_upgrade: Optional[bool] = None,
        instance_class: Optional[str] = None,
        instance_type: Optional[str] = None,
        node_type: Optional[str] = None,
        password: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[int] = None,
        port: Optional[int] = None,
        read_only_count: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        secondary_zone_id: Optional[str] = None,
        shard_count: Optional[int] = None,
        slave_read_only_count: Optional[int] = None,
        status: Optional[str] = None,
        storage_performance_level: Optional[str] = None,
        storage_size_gb: Optional[int] = None,
        tags: Optional[Mapping[str, Any]] = None,
        tair_instance_name: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> TairInstance
    func GetTairInstance(ctx *Context, name string, id IDInput, state *TairInstanceState, opts ...ResourceOption) (*TairInstance, error)
    public static TairInstance Get(string name, Input<string> id, TairInstanceState? state, CustomResourceOptions? opts = null)
    public static TairInstance get(String name, Output<String> id, TairInstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoRenew string
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    AutoRenewPeriod string
    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.
    ClusterBackupId string
    The ID of the backup set of the cluster. .
    CreateTime string
    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.
    EffectiveTime string
    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).
    EngineVersion string
    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.
    ForceUpgrade bool
    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).
    InstanceClass string
    The instance type of the instance. For more information, see Instance types.
    InstanceType string
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    NodeType string
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    Password string
    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 ! @ # $ % ^ & * ( ) _ + - =.
    PaymentType string
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    Period int
    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.
    Port int
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    ReadOnlyCount int
    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.
    ResourceGroupId string
    The ID of the resource group to which the instance belongs.
    SecondaryZoneId string
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    ShardCount int
    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.
    SlaveReadOnlyCount int
    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.
    Status string
    The status of the resource.
    StoragePerformanceLevel string
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    StorageSizeGb int
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    Tags Dictionary<string, object>
    The tag of the resource.
    TairInstanceName string
    The name of the resource.
    VpcId string
    The ID of the virtual private cloud (VPC).
    VswitchId string
    The ID of the vSwitch to which the instance is connected.
    ZoneId string
    Zone ID.
    AutoRenew string
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    AutoRenewPeriod string
    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.
    ClusterBackupId string
    The ID of the backup set of the cluster. .
    CreateTime string
    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.
    EffectiveTime string
    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).
    EngineVersion string
    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.
    ForceUpgrade bool
    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).
    InstanceClass string
    The instance type of the instance. For more information, see Instance types.
    InstanceType string
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    NodeType string
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    Password string
    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 ! @ # $ % ^ & * ( ) _ + - =.
    PaymentType string
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    Period int
    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.
    Port int
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    ReadOnlyCount int
    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.
    ResourceGroupId string
    The ID of the resource group to which the instance belongs.
    SecondaryZoneId string
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    ShardCount int
    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.
    SlaveReadOnlyCount int
    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.
    Status string
    The status of the resource.
    StoragePerformanceLevel string
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    StorageSizeGb int
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    Tags map[string]interface{}
    The tag of the resource.
    TairInstanceName string
    The name of the resource.
    VpcId string
    The ID of the virtual private cloud (VPC).
    VswitchId string
    The ID of the vSwitch to which the instance is connected.
    ZoneId string
    Zone ID.
    autoRenew String
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    autoRenewPeriod String
    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.
    clusterBackupId String
    The ID of the backup set of the cluster. .
    createTime String
    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.
    effectiveTime String
    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).
    engineVersion String
    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.
    forceUpgrade Boolean
    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).
    instanceClass String
    The instance type of the instance. For more information, see Instance types.
    instanceType String
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    nodeType String
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    password String
    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 ! @ # $ % ^ & * ( ) _ + - =.
    paymentType String
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    period Integer
    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.
    port Integer
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    readOnlyCount Integer
    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.
    resourceGroupId String
    The ID of the resource group to which the instance belongs.
    secondaryZoneId String
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    shardCount Integer
    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.
    slaveReadOnlyCount Integer
    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.
    status String
    The status of the resource.
    storagePerformanceLevel String
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    storageSizeGb Integer
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    tags Map<String,Object>
    The tag of the resource.
    tairInstanceName String
    The name of the resource.
    vpcId String
    The ID of the virtual private cloud (VPC).
    vswitchId String
    The ID of the vSwitch to which the instance is connected.
    zoneId String
    Zone ID.
    autoRenew string
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    autoRenewPeriod string
    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.
    clusterBackupId string
    The ID of the backup set of the cluster. .
    createTime string
    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.
    effectiveTime string
    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).
    engineVersion string
    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.
    forceUpgrade boolean
    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).
    instanceClass string
    The instance type of the instance. For more information, see Instance types.
    instanceType string
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    nodeType string
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    password string
    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 ! @ # $ % ^ & * ( ) _ + - =.
    paymentType string
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    period number
    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.
    port number
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    readOnlyCount number
    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.
    resourceGroupId string
    The ID of the resource group to which the instance belongs.
    secondaryZoneId string
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    shardCount number
    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.
    slaveReadOnlyCount number
    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.
    status string
    The status of the resource.
    storagePerformanceLevel string
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    storageSizeGb number
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    tags {[key: string]: any}
    The tag of the resource.
    tairInstanceName string
    The name of the resource.
    vpcId string
    The ID of the virtual private cloud (VPC).
    vswitchId string
    The ID of the vSwitch to which the instance is connected.
    zoneId string
    Zone ID.
    auto_renew str
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    auto_renew_period str
    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.
    cluster_backup_id str
    The ID of the backup set of the cluster. .
    create_time str
    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.
    effective_time str
    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).
    engine_version str
    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.
    force_upgrade bool
    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).
    instance_class str
    The instance type of the instance. For more information, see Instance types.
    instance_type str
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    node_type str
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    password str
    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 ! @ # $ % ^ & * ( ) _ + - =.
    payment_type str
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    period int
    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.
    port int
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    read_only_count int
    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.
    resource_group_id str
    The ID of the resource group to which the instance belongs.
    secondary_zone_id str
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    shard_count int
    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.
    slave_read_only_count int
    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.
    status str
    The status of the resource.
    storage_performance_level str
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    storage_size_gb int
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    tags Mapping[str, Any]
    The tag of the resource.
    tair_instance_name str
    The name of the resource.
    vpc_id str
    The ID of the virtual private cloud (VPC).
    vswitch_id str
    The ID of the vSwitch to which the instance is connected.
    zone_id str
    Zone ID.
    autoRenew String
    Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
    autoRenewPeriod String
    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.
    clusterBackupId String
    The ID of the backup set of the cluster. .
    createTime String
    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.
    effectiveTime String
    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).
    engineVersion String
    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.
    forceUpgrade Boolean
    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).
    instanceClass String
    The instance type of the instance. For more information, see Instance types.
    instanceType String
    The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
    nodeType String
    Node type, value: MASTER_SLAVE: high availability (dual copy) STAND_ALONE: single copy double: double copy single: single copy Note For Cloud Native instances, select MASTER_SLAVE or STAND_ALONE. For Classic instances, select double or single.
    password String
    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 ! @ # $ % ^ & * ( ) _ + - =.
    paymentType String
    The billing method of the instance. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
    period Number
    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.
    port Number
    The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
    readOnlyCount Number
    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.
    resourceGroupId String
    The ID of the resource group to which the instance belongs.
    secondaryZoneId String
    The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
    shardCount Number
    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.
    slaveReadOnlyCount Number
    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.
    status String
    The status of the resource.
    storagePerformanceLevel String
    The storage type. The value range is [PL1, PL2, and PL3]. The default value is PL1. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    storageSizeGb Number
    The value range of different specifications is different, see ESSD-based instances. When the value of instance_type is "tair_essd", this attribute takes effect and is required.
    tags Map<Any>
    The tag of the resource.
    tairInstanceName String
    The name of the resource.
    vpcId String
    The ID of the virtual private cloud (VPC).
    vswitchId String
    The ID of the vSwitch to which the instance is connected.
    zoneId String
    Zone ID.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-alicloud