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

tencentcloud.RedisConnectionConfig

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 connection config

    Example Usage

    Create RedisConnectionConfig Resource

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

    Constructor syntax

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

@overload
def RedisConnectionConfig(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          instance_id: Optional[str] = None,
                          add_bandwidth: Optional[float] = None,
                          client_limit: Optional[float] = None,
                          redis_connection_config_id: Optional[str] = None)
    func NewRedisConnectionConfig(ctx *Context, name string, args RedisConnectionConfigArgs, opts ...ResourceOption) (*RedisConnectionConfig, error)
    public RedisConnectionConfig(string name, RedisConnectionConfigArgs args, CustomResourceOptions? opts = null)
    public RedisConnectionConfig(String name, RedisConnectionConfigArgs args)
public RedisConnectionConfig(String name, RedisConnectionConfigArgs args, CustomResourceOptions options)

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

    RedisConnectionConfig 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 RedisConnectionConfig resource accepts the following input properties:

    InstanceId string
    The ID of instance.
    AddBandwidth double
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    ClientLimit double
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    RedisConnectionConfigId string
    ID of the resource.
    InstanceId string
    The ID of instance.
    AddBandwidth float64
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    ClientLimit float64
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    RedisConnectionConfigId string
    ID of the resource.
    instanceId String
    The ID of instance.
    addBandwidth Double
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    clientLimit Double
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    redisConnectionConfigId String
    ID of the resource.
    instanceId string
    The ID of instance.
    addBandwidth number
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    clientLimit number
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    redisConnectionConfigId string
    ID of the resource.
    instance_id str
    The ID of instance.
    add_bandwidth float
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    client_limit float
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    redis_connection_config_id str
    ID of the resource.
    instanceId String
    The ID of instance.
    addBandwidth Number
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    clientLimit Number
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    redisConnectionConfigId String
    ID of the resource.

    Outputs

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

    BaseBandwidth double
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxAddBandwidth double
    Additional bandwidth is capped.
    MinAddBandwidth double
    Additional bandwidth sets the lower limit.
    TotalBandwidth double
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    BaseBandwidth float64
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxAddBandwidth float64
    Additional bandwidth is capped.
    MinAddBandwidth float64
    Additional bandwidth sets the lower limit.
    TotalBandwidth float64
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    baseBandwidth Double
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    id String
    The provider-assigned unique ID for this managed resource.
    maxAddBandwidth Double
    Additional bandwidth is capped.
    minAddBandwidth Double
    Additional bandwidth sets the lower limit.
    totalBandwidth Double
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    baseBandwidth number
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    id string
    The provider-assigned unique ID for this managed resource.
    maxAddBandwidth number
    Additional bandwidth is capped.
    minAddBandwidth number
    Additional bandwidth sets the lower limit.
    totalBandwidth number
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    base_bandwidth float
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    id str
    The provider-assigned unique ID for this managed resource.
    max_add_bandwidth float
    Additional bandwidth is capped.
    min_add_bandwidth float
    Additional bandwidth sets the lower limit.
    total_bandwidth float
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    baseBandwidth Number
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    id String
    The provider-assigned unique ID for this managed resource.
    maxAddBandwidth Number
    Additional bandwidth is capped.
    minAddBandwidth Number
    Additional bandwidth sets the lower limit.
    totalBandwidth Number
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.

    Look up Existing RedisConnectionConfig Resource

    Get an existing RedisConnectionConfig 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?: RedisConnectionConfigState, opts?: CustomResourceOptions): RedisConnectionConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        add_bandwidth: Optional[float] = None,
        base_bandwidth: Optional[float] = None,
        client_limit: Optional[float] = None,
        instance_id: Optional[str] = None,
        max_add_bandwidth: Optional[float] = None,
        min_add_bandwidth: Optional[float] = None,
        redis_connection_config_id: Optional[str] = None,
        total_bandwidth: Optional[float] = None) -> RedisConnectionConfig
    func GetRedisConnectionConfig(ctx *Context, name string, id IDInput, state *RedisConnectionConfigState, opts ...ResourceOption) (*RedisConnectionConfig, error)
    public static RedisConnectionConfig Get(string name, Input<string> id, RedisConnectionConfigState? state, CustomResourceOptions? opts = null)
    public static RedisConnectionConfig get(String name, Output<String> id, RedisConnectionConfigState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:RedisConnectionConfig    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:
    AddBandwidth double
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    BaseBandwidth double
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    ClientLimit double
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    InstanceId string
    The ID of instance.
    MaxAddBandwidth double
    Additional bandwidth is capped.
    MinAddBandwidth double
    Additional bandwidth sets the lower limit.
    RedisConnectionConfigId string
    ID of the resource.
    TotalBandwidth double
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    AddBandwidth float64
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    BaseBandwidth float64
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    ClientLimit float64
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    InstanceId string
    The ID of instance.
    MaxAddBandwidth float64
    Additional bandwidth is capped.
    MinAddBandwidth float64
    Additional bandwidth sets the lower limit.
    RedisConnectionConfigId string
    ID of the resource.
    TotalBandwidth float64
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    addBandwidth Double
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    baseBandwidth Double
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    clientLimit Double
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    instanceId String
    The ID of instance.
    maxAddBandwidth Double
    Additional bandwidth is capped.
    minAddBandwidth Double
    Additional bandwidth sets the lower limit.
    redisConnectionConfigId String
    ID of the resource.
    totalBandwidth Double
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    addBandwidth number
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    baseBandwidth number
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    clientLimit number
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    instanceId string
    The ID of instance.
    maxAddBandwidth number
    Additional bandwidth is capped.
    minAddBandwidth number
    Additional bandwidth sets the lower limit.
    redisConnectionConfigId string
    ID of the resource.
    totalBandwidth number
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    add_bandwidth float
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    base_bandwidth float
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    client_limit float
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    instance_id str
    The ID of instance.
    max_add_bandwidth float
    Additional bandwidth is capped.
    min_add_bandwidth float
    Additional bandwidth sets the lower limit.
    redis_connection_config_id str
    ID of the resource.
    total_bandwidth float
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.
    addBandwidth Number
    Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1.
    baseBandwidth Number
    standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased.
    clientLimit Number
    The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3).
    instanceId String
    The ID of instance.
    maxAddBandwidth Number
    Additional bandwidth is capped.
    minAddBandwidth Number
    Additional bandwidth sets the lower limit.
    redisConnectionConfigId String
    ID of the resource.
    totalBandwidth Number
    Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s.

    Import

    redis connection config can be imported, e.g.

    $ pulumi import tencentcloud:index/redisConnectionConfig:RedisConnectionConfig example crs-cqdfdzvt

    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