Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. RedisInstance
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.RedisInstance

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create a Redis instance and set its attributes.

    NOTE: The argument vpc_id and subnet_id is now required because Basic Network Instance is no longer supported.

    NOTE: Both adding and removing replications in one change is supported but not recommend.

    Example Usage

    Create RedisInstance Resource

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

    Constructor syntax

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

@overload
def RedisInstance(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  mem_size: Optional[float] = None,
                  availability_zone: Optional[str] = None,
                  project_id: Optional[float] = None,
                  type: Optional[str] = None,
                  ip: Optional[str] = None,
                  charge_type: Optional[str] = None,
                  redis_cluster_id: Optional[str] = None,
                  no_auth: Optional[bool] = None,
                  operation_network: Optional[str] = None,
                  params_template_id: Optional[str] = None,
                  password: Optional[str] = None,
                  port: Optional[float] = None,
                  prepaid_period: Optional[float] = None,
                  product_version: Optional[str] = None,
                  force_delete: Optional[bool] = None,
                  auto_renew_flag: Optional[float] = None,
                  name: Optional[str] = None,
                  redis_instance_id: Optional[str] = None,
                  redis_replicas_num: Optional[float] = None,
                  redis_shard_num: Optional[float] = None,
                  replica_zone_ids: Optional[Sequence[float]] = None,
                  replicas_read_only: Optional[bool] = None,
                  security_groups: Optional[Sequence[str]] = None,
                  subnet_id: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  recycle: Optional[float] = None,
                  type_id: Optional[float] = None,
                  vpc_id: Optional[str] = None,
                  wait_switch: Optional[float] = None,
                  wan_address_switch: Optional[str] = None)
    func NewRedisInstance(ctx *Context, name string, args RedisInstanceArgs, opts ...ResourceOption) (*RedisInstance, error)
    public RedisInstance(string name, RedisInstanceArgs args, CustomResourceOptions? opts = null)
    public RedisInstance(String name, RedisInstanceArgs args)
public RedisInstance(String name, RedisInstanceArgs args, CustomResourceOptions options)

    type: tencentcloud:RedisInstance
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 RedisInstanceArgs
    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 RedisInstanceArgs
    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 RedisInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RedisInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RedisInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RedisInstance Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RedisInstance resource accepts the following input properties:

    AvailabilityZone string
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    MemSize double
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    AutoRenewFlag double
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    ChargeType string
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    ForceDelete bool
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    Ip string
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    Name string
    Instance name.
    NoAuth bool
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    OperationNetwork string
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    ParamsTemplateId string
    Specify params template id. If not set, will use default template.
    Password string
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    Port double
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    PrepaidPeriod double
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    ProductVersion string
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    ProjectId double
    Specifies which project the instance should belong to.
    Recycle double
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    RedisClusterId string
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    RedisInstanceId string
    ID of the master or replica node.
    RedisReplicasNum double
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    RedisShardNum double
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    ReplicaZoneIds List<double>
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    ReplicasReadOnly bool
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    SecurityGroups List<string>
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    SubnetId string
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    Tags Dictionary<string, string>
    Instance tags.
    Type string
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    TypeId double
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    VpcId string
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    WaitSwitch double
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    WanAddressSwitch string
    Wan address switch, default close, values: open, close.
    AvailabilityZone string
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    MemSize float64
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    AutoRenewFlag float64
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    ChargeType string
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    ForceDelete bool
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    Ip string
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    Name string
    Instance name.
    NoAuth bool
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    OperationNetwork string
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    ParamsTemplateId string
    Specify params template id. If not set, will use default template.
    Password string
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    Port float64
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    PrepaidPeriod float64
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    ProductVersion string
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    ProjectId float64
    Specifies which project the instance should belong to.
    Recycle float64
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    RedisClusterId string
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    RedisInstanceId string
    ID of the master or replica node.
    RedisReplicasNum float64
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    RedisShardNum float64
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    ReplicaZoneIds []float64
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    ReplicasReadOnly bool
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    SecurityGroups []string
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    SubnetId string
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    Tags map[string]string
    Instance tags.
    Type string
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    TypeId float64
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    VpcId string
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    WaitSwitch float64
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    WanAddressSwitch string
    Wan address switch, default close, values: open, close.
    availabilityZone String
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    memSize Double
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    autoRenewFlag Double
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    chargeType String
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    forceDelete Boolean
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    ip String
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    name String
    Instance name.
    noAuth Boolean
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    operationNetwork String
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    paramsTemplateId String
    Specify params template id. If not set, will use default template.
    password String
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    port Double
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    prepaidPeriod Double
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    productVersion String
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    projectId Double
    Specifies which project the instance should belong to.
    recycle Double
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    redisClusterId String
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    redisInstanceId String
    ID of the master or replica node.
    redisReplicasNum Double
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    redisShardNum Double
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    replicaZoneIds List<Double>
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    replicasReadOnly Boolean
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    securityGroups List<String>
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    subnetId String
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    tags Map<String,String>
    Instance tags.
    type String
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    typeId Double
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    vpcId String
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    waitSwitch Double
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    wanAddressSwitch String
    Wan address switch, default close, values: open, close.
    availabilityZone string
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    memSize number
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    autoRenewFlag number
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    chargeType string
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    forceDelete boolean
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    ip string
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    name string
    Instance name.
    noAuth boolean
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    operationNetwork string
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    paramsTemplateId string
    Specify params template id. If not set, will use default template.
    password string
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    port number
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    prepaidPeriod number
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    productVersion string
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    projectId number
    Specifies which project the instance should belong to.
    recycle number
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    redisClusterId string
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    redisInstanceId string
    ID of the master or replica node.
    redisReplicasNum number
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    redisShardNum number
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    replicaZoneIds number[]
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    replicasReadOnly boolean
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    securityGroups string[]
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    subnetId string
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    tags {[key: string]: string}
    Instance tags.
    type string
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    typeId number
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    vpcId string
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    waitSwitch number
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    wanAddressSwitch string
    Wan address switch, default close, values: open, close.
    availability_zone str
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    mem_size float
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    auto_renew_flag float
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    charge_type str
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    force_delete bool
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    ip str
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    name str
    Instance name.
    no_auth bool
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    operation_network str
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    params_template_id str
    Specify params template id. If not set, will use default template.
    password str
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    port float
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    prepaid_period float
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    product_version str
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    project_id float
    Specifies which project the instance should belong to.
    recycle float
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    redis_cluster_id str
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    redis_instance_id str
    ID of the master or replica node.
    redis_replicas_num float
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    redis_shard_num float
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    replica_zone_ids Sequence[float]
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    replicas_read_only bool
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    security_groups Sequence[str]
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    subnet_id str
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    tags Mapping[str, str]
    Instance tags.
    type str
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    type_id float
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    vpc_id str
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    wait_switch float
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    wan_address_switch str
    Wan address switch, default close, values: open, close.
    availabilityZone String
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    memSize Number
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    autoRenewFlag Number
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    chargeType String
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    forceDelete Boolean
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    ip String
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    name String
    Instance name.
    noAuth Boolean
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    operationNetwork String
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    paramsTemplateId String
    Specify params template id. If not set, will use default template.
    password String
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    port Number
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    prepaidPeriod Number
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    productVersion String
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    projectId Number
    Specifies which project the instance should belong to.
    recycle Number
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    redisClusterId String
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    redisInstanceId String
    ID of the master or replica node.
    redisReplicasNum Number
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    redisShardNum Number
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    replicaZoneIds List<Number>
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    replicasReadOnly Boolean
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    securityGroups List<String>
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    subnetId String
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    tags Map<String>
    Instance tags.
    type String
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    typeId Number
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    vpcId String
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    waitSwitch Number
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    wanAddressSwitch String
    Wan address switch, default close, values: open, close.

    Outputs

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

    CreateTime string
    The time when the instance was created.
    DedicatedClusterId string
    Dedicated Cluster ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeInfos List<RedisInstanceNodeInfo>
    Readonly Primary/Replica nodes.
    Status string
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    WanAddress string
    Allocate Wan Address.
    CreateTime string
    The time when the instance was created.
    DedicatedClusterId string
    Dedicated Cluster ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeInfos []RedisInstanceNodeInfo
    Readonly Primary/Replica nodes.
    Status string
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    WanAddress string
    Allocate Wan Address.
    createTime String
    The time when the instance was created.
    dedicatedClusterId String
    Dedicated Cluster ID.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeInfos List<RedisInstanceNodeInfo>
    Readonly Primary/Replica nodes.
    status String
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    wanAddress String
    Allocate Wan Address.
    createTime string
    The time when the instance was created.
    dedicatedClusterId string
    Dedicated Cluster ID.
    id string
    The provider-assigned unique ID for this managed resource.
    nodeInfos RedisInstanceNodeInfo[]
    Readonly Primary/Replica nodes.
    status string
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    wanAddress string
    Allocate Wan Address.
    create_time str
    The time when the instance was created.
    dedicated_cluster_id str
    Dedicated Cluster ID.
    id str
    The provider-assigned unique ID for this managed resource.
    node_infos Sequence[RedisInstanceNodeInfo]
    Readonly Primary/Replica nodes.
    status str
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    wan_address str
    Allocate Wan Address.
    createTime String
    The time when the instance was created.
    dedicatedClusterId String
    Dedicated Cluster ID.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeInfos List<Property Map>
    Readonly Primary/Replica nodes.
    status String
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    wanAddress String
    Allocate Wan Address.

    Look up Existing RedisInstance Resource

    Get an existing RedisInstance 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?: RedisInstanceState, opts?: CustomResourceOptions): RedisInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew_flag: Optional[float] = None,
        availability_zone: Optional[str] = None,
        charge_type: Optional[str] = None,
        create_time: Optional[str] = None,
        dedicated_cluster_id: Optional[str] = None,
        force_delete: Optional[bool] = None,
        ip: Optional[str] = None,
        mem_size: Optional[float] = None,
        name: Optional[str] = None,
        no_auth: Optional[bool] = None,
        node_infos: Optional[Sequence[RedisInstanceNodeInfoArgs]] = None,
        operation_network: Optional[str] = None,
        params_template_id: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[float] = None,
        prepaid_period: Optional[float] = None,
        product_version: Optional[str] = None,
        project_id: Optional[float] = None,
        recycle: Optional[float] = None,
        redis_cluster_id: Optional[str] = None,
        redis_instance_id: Optional[str] = None,
        redis_replicas_num: Optional[float] = None,
        redis_shard_num: Optional[float] = None,
        replica_zone_ids: Optional[Sequence[float]] = None,
        replicas_read_only: Optional[bool] = None,
        security_groups: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None,
        type_id: Optional[float] = None,
        vpc_id: Optional[str] = None,
        wait_switch: Optional[float] = None,
        wan_address: Optional[str] = None,
        wan_address_switch: Optional[str] = None) -> RedisInstance
    func GetRedisInstance(ctx *Context, name string, id IDInput, state *RedisInstanceState, opts ...ResourceOption) (*RedisInstance, error)
    public static RedisInstance Get(string name, Input<string> id, RedisInstanceState? state, CustomResourceOptions? opts = null)
    public static RedisInstance get(String name, Output<String> id, RedisInstanceState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:RedisInstance    get:      id: ${id}
    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:
    AutoRenewFlag double
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    AvailabilityZone string
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    ChargeType string
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    CreateTime string
    The time when the instance was created.
    DedicatedClusterId string
    Dedicated Cluster ID.
    ForceDelete bool
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    Ip string
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    MemSize double
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    Name string
    Instance name.
    NoAuth bool
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    NodeInfos List<RedisInstanceNodeInfo>
    Readonly Primary/Replica nodes.
    OperationNetwork string
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    ParamsTemplateId string
    Specify params template id. If not set, will use default template.
    Password string
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    Port double
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    PrepaidPeriod double
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    ProductVersion string
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    ProjectId double
    Specifies which project the instance should belong to.
    Recycle double
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    RedisClusterId string
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    RedisInstanceId string
    ID of the master or replica node.
    RedisReplicasNum double
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    RedisShardNum double
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    ReplicaZoneIds List<double>
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    ReplicasReadOnly bool
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    SecurityGroups List<string>
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    Status string
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    SubnetId string
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    Tags Dictionary<string, string>
    Instance tags.
    Type string
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    TypeId double
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    VpcId string
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    WaitSwitch double
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    WanAddress string
    Allocate Wan Address.
    WanAddressSwitch string
    Wan address switch, default close, values: open, close.
    AutoRenewFlag float64
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    AvailabilityZone string
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    ChargeType string
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    CreateTime string
    The time when the instance was created.
    DedicatedClusterId string
    Dedicated Cluster ID.
    ForceDelete bool
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    Ip string
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    MemSize float64
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    Name string
    Instance name.
    NoAuth bool
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    NodeInfos []RedisInstanceNodeInfoArgs
    Readonly Primary/Replica nodes.
    OperationNetwork string
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    ParamsTemplateId string
    Specify params template id. If not set, will use default template.
    Password string
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    Port float64
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    PrepaidPeriod float64
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    ProductVersion string
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    ProjectId float64
    Specifies which project the instance should belong to.
    Recycle float64
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    RedisClusterId string
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    RedisInstanceId string
    ID of the master or replica node.
    RedisReplicasNum float64
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    RedisShardNum float64
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    ReplicaZoneIds []float64
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    ReplicasReadOnly bool
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    SecurityGroups []string
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    Status string
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    SubnetId string
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    Tags map[string]string
    Instance tags.
    Type string
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    TypeId float64
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    VpcId string
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    WaitSwitch float64
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    WanAddress string
    Allocate Wan Address.
    WanAddressSwitch string
    Wan address switch, default close, values: open, close.
    autoRenewFlag Double
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    availabilityZone String
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    chargeType String
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    createTime String
    The time when the instance was created.
    dedicatedClusterId String
    Dedicated Cluster ID.
    forceDelete Boolean
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    ip String
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    memSize Double
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    name String
    Instance name.
    noAuth Boolean
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    nodeInfos List<RedisInstanceNodeInfo>
    Readonly Primary/Replica nodes.
    operationNetwork String
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    paramsTemplateId String
    Specify params template id. If not set, will use default template.
    password String
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    port Double
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    prepaidPeriod Double
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    productVersion String
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    projectId Double
    Specifies which project the instance should belong to.
    recycle Double
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    redisClusterId String
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    redisInstanceId String
    ID of the master or replica node.
    redisReplicasNum Double
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    redisShardNum Double
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    replicaZoneIds List<Double>
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    replicasReadOnly Boolean
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    securityGroups List<String>
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    status String
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    subnetId String
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    tags Map<String,String>
    Instance tags.
    type String
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    typeId Double
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    vpcId String
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    waitSwitch Double
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    wanAddress String
    Allocate Wan Address.
    wanAddressSwitch String
    Wan address switch, default close, values: open, close.
    autoRenewFlag number
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    availabilityZone string
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    chargeType string
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    createTime string
    The time when the instance was created.
    dedicatedClusterId string
    Dedicated Cluster ID.
    forceDelete boolean
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    ip string
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    memSize number
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    name string
    Instance name.
    noAuth boolean
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    nodeInfos RedisInstanceNodeInfo[]
    Readonly Primary/Replica nodes.
    operationNetwork string
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    paramsTemplateId string
    Specify params template id. If not set, will use default template.
    password string
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    port number
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    prepaidPeriod number
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    productVersion string
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    projectId number
    Specifies which project the instance should belong to.
    recycle number
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    redisClusterId string
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    redisInstanceId string
    ID of the master or replica node.
    redisReplicasNum number
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    redisShardNum number
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    replicaZoneIds number[]
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    replicasReadOnly boolean
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    securityGroups string[]
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    status string
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    subnetId string
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    tags {[key: string]: string}
    Instance tags.
    type string
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    typeId number
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    vpcId string
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    waitSwitch number
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    wanAddress string
    Allocate Wan Address.
    wanAddressSwitch string
    Wan address switch, default close, values: open, close.
    auto_renew_flag float
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    availability_zone str
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    charge_type str
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    create_time str
    The time when the instance was created.
    dedicated_cluster_id str
    Dedicated Cluster ID.
    force_delete bool
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    ip str
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    mem_size float
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    name str
    Instance name.
    no_auth bool
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    node_infos Sequence[RedisInstanceNodeInfoArgs]
    Readonly Primary/Replica nodes.
    operation_network str
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    params_template_id str
    Specify params template id. If not set, will use default template.
    password str
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    port float
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    prepaid_period float
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    product_version str
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    project_id float
    Specifies which project the instance should belong to.
    recycle float
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    redis_cluster_id str
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    redis_instance_id str
    ID of the master or replica node.
    redis_replicas_num float
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    redis_shard_num float
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    replica_zone_ids Sequence[float]
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    replicas_read_only bool
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    security_groups Sequence[str]
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    status str
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    subnet_id str
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    tags Mapping[str, str]
    Instance tags.
    type str
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    type_id float
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    vpc_id str
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    wait_switch float
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    wan_address str
    Allocate Wan Address.
    wan_address_switch str
    Wan address switch, default close, values: open, close.
    autoRenewFlag Number
    Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal.
    availabilityZone String
    The available zone of an instance to be created, like ap-beijing-7, please refer to tencentcloud_redis_zone_config.list.
    chargeType String
    The charge type of instance. Valid values: PREPAID and POSTPAID. Default value is POSTPAID. Note: TencentCloud International only supports POSTPAID. Caution that update operation on this field will delete old instances and create new with new charge type.
    createTime String
    The time when the instance was created.
    dedicatedClusterId String
    Dedicated Cluster ID.
    forceDelete Boolean
    Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    ip String
    IP address of an instance. When the operation_network is changeVip, this parameter needs to be configured.
    memSize Number
    The memory volume of an available instance(in MB), please refer to tencentcloud_redis_zone_config.list[zone].shard_memories. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. 512MB is supported only in master-slave instance.
    name String
    Instance name.
    noAuth Boolean
    Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment.
    nodeInfos List<Property Map>
    Readonly Primary/Replica nodes.
    operationNetwork String
    Refers to the category of the pre-modified network, including: changeVip: refers to switching the private network, including its intranet IPv4 address and port; changeVpc: refers to switching the subnet to which the private network belongs; changeBaseToVpc: refers to switching the basic network to a private network; changeVPort: refers to only modifying the instance network port.
    paramsTemplateId String
    Specify params template id. If not set, will use default template.
    password String
    Password for a Redis user, which should be 8 to 16 characters. NOTE: Only no_auth=true specified can make password empty.
    port Number
    The port used to access a redis instance. The default value is 6379. When the operation_network is changeVPort or changeVip, this parameter needs to be configured.
    prepaidPeriod Number
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    productVersion String
    Specify the product version of the instance. local: Local disk version, cloud: Cloud disk version, cdc: Exclusive cluster version. Default is local.
    projectId Number
    Specifies which project the instance should belong to.
    recycle Number
    Original intranet IPv4 address retention time: unit: day, value range: 0, 1, 2, 3, 7, 15.
    redisClusterId String
    Exclusive cluster ID. When the product_version is set to cdc, this parameter must be set.
    redisInstanceId String
    ID of the master or replica node.
    redisReplicasNum Number
    The number of instance copies. This is not required for standalone and master slave versions and must equal to count of replica_zone_ids, Non-multi-AZ does not require replica_zone_ids; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy.
    redisShardNum Number
    The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [1, 3, 5, 8, 12, 16, 24 , 32, 40, 48, 64, 80, 96, 128].
    replicaZoneIds List<Number>
    ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove.
    replicasReadOnly Boolean
    Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2.
    securityGroups List<String>
    ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either.
    status String
    Current status of an instance, maybe: init, processing, online, isolate and todelete.
    subnetId String
    Specifies which subnet the instance should belong to. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    tags Map<String>
    Instance tags.
    type String
    It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: cluster_ckv,cluster_redis5.0,cluster_redis,master_slave_ckv,master_slave_redis4.0,master_slave_redis5.0,master_slave_redis,standalone_redis, specific region support specific types, need to refer data tencentcloud.getRedisZoneConfig.

    Deprecated: Deprecated

    typeId Number
    Instance type. Available values reference data source tencentcloud.getRedisZoneConfig or document, toggle immediately when modified.
    vpcId String
    ID of the vpc with which the instance is to be associated. When the operation_network is changeVpc or changeBaseToVpc, this parameter needs to be configured.
    waitSwitch Number
    Switching mode: 1-maintenance time window switching, 2-immediate switching, default value 2.
    wanAddress String
    Allocate Wan Address.
    wanAddressSwitch String
    Wan address switch, default close, values: open, close.

    Supporting Types

    RedisInstanceNodeInfo, RedisInstanceNodeInfoArgs

    Id double
    ID of the master or replica node.
    Master bool
    Indicates whether the node is master.
    ZoneId double
    ID of the availability zone of the master or replica node.
    Id float64
    ID of the master or replica node.
    Master bool
    Indicates whether the node is master.
    ZoneId float64
    ID of the availability zone of the master or replica node.
    id Double
    ID of the master or replica node.
    master Boolean
    Indicates whether the node is master.
    zoneId Double
    ID of the availability zone of the master or replica node.
    id number
    ID of the master or replica node.
    master boolean
    Indicates whether the node is master.
    zoneId number
    ID of the availability zone of the master or replica node.
    id float
    ID of the master or replica node.
    master bool
    Indicates whether the node is master.
    zone_id float
    ID of the availability zone of the master or replica node.
    id Number
    ID of the master or replica node.
    master Boolean
    Indicates whether the node is master.
    zoneId Number
    ID of the availability zone of the master or replica node.

    Import

    Redis instance can be imported, e.g.

    $ pulumi import tencentcloud:index/redisInstance:RedisInstance example crs-iu22tdrf

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud