1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. InstanceSpecs
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine

volcengine.redis.InstanceSpecs

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
    Deprecated: volcengine.redis.InstanceSpecs has been deprecated in favor of volcengine.redis.getInstanceSpecs

    Use this data source to query detailed information of redis instance specs

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.ecs.EcsFunctions;
    import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
    import com.pulumi.volcengine.vpc.Vpc;
    import com.pulumi.volcengine.vpc.VpcArgs;
    import com.pulumi.volcengine.vpc.Subnet;
    import com.pulumi.volcengine.vpc.SubnetArgs;
    import com.pulumi.volcengine.redis.Instance;
    import com.pulumi.volcengine.redis.InstanceArgs;
    import com.pulumi.volcengine.redis.RedisFunctions;
    import com.pulumi.volcengine.redis.inputs.GetInstanceSpecsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var fooZones = EcsFunctions.getZones();
    
            var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
                .vpcName("acc-test-vpc")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
                .subnetName("acc-test-subnet")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .vpcId(fooVpc.id())
                .build());
    
            var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
                .zoneIds(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .instanceName("acc-test-tf-redis")
                .shardedCluster(1)
                .password("1qaz!QAZ12")
                .nodeNumber(2)
                .shardCapacity(1024)
                .shardNumber(2)
                .engineVersion("5.0")
                .subnetId(fooSubnet.id())
                .deletionProtection("disabled")
                .vpcAuthMode("close")
                .chargeType("PostPaid")
                .port(6381)
                .projectName("default")
                .build());
    
            final var fooInstanceSpecs = RedisFunctions.getInstanceSpecs(GetInstanceSpecsArgs.builder()
                .instanceId(fooInstance.id())
                .build());
    
        }
    }
    
    resources:
      fooVpc:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-vpc
          cidrBlock: 172.16.0.0/16
      fooSubnet:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-test-subnet
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[0].id}
          vpcId: ${fooVpc.id}
      fooInstance:
        type: volcengine:redis:Instance
        properties:
          zoneIds:
            - ${fooZones.zones[0].id}
          instanceName: acc-test-tf-redis
          shardedCluster: 1
          password: 1qaz!QAZ12
          nodeNumber: 2
          shardCapacity: 1024
          shardNumber: 2
          engineVersion: '5.0'
          subnetId: ${fooSubnet.id}
          deletionProtection: disabled
          vpcAuthMode: close
          chargeType: PostPaid
          port: 6381
          projectName: default
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:getZones
          Arguments: {}
      fooInstanceSpecs:
        fn::invoke:
          Function: volcengine:redis:getInstanceSpecs
          Arguments:
            instanceId: ${fooInstance.id}
    

    Using InstanceSpecs

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function instanceSpecs(args: InstanceSpecsArgs, opts?: InvokeOptions): Promise<InstanceSpecsResult>
    function instanceSpecsOutput(args: InstanceSpecsOutputArgs, opts?: InvokeOptions): Output<InstanceSpecsResult>
    def instance_specs(arch_type: Optional[str] = None,
                       instance_class: Optional[str] = None,
                       name_regex: Optional[str] = None,
                       output_file: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> InstanceSpecsResult
    def instance_specs_output(arch_type: Optional[pulumi.Input[str]] = None,
                       instance_class: Optional[pulumi.Input[str]] = None,
                       name_regex: Optional[pulumi.Input[str]] = None,
                       output_file: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[InstanceSpecsResult]
    func InstanceSpecs(ctx *Context, args *InstanceSpecsArgs, opts ...InvokeOption) (*InstanceSpecsResult, error)
    func InstanceSpecsOutput(ctx *Context, args *InstanceSpecsOutputArgs, opts ...InvokeOption) InstanceSpecsResultOutput
    public static class InstanceSpecs 
    {
        public static Task<InstanceSpecsResult> InvokeAsync(InstanceSpecsArgs args, InvokeOptions? opts = null)
        public static Output<InstanceSpecsResult> Invoke(InstanceSpecsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<InstanceSpecsResult> instanceSpecs(InstanceSpecsArgs args, InvokeOptions options)
    public static Output<InstanceSpecsResult> instanceSpecs(InstanceSpecsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:redis:InstanceSpecs
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ArchType string
    The architecture type of the Redis instance.
    InstanceClass string
    The type of Redis instance.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ArchType string
    The architecture type of the Redis instance.
    InstanceClass string
    The type of Redis instance.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    archType String
    The architecture type of the Redis instance.
    instanceClass String
    The type of Redis instance.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    archType string
    The architecture type of the Redis instance.
    instanceClass string
    The type of Redis instance.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    arch_type str
    The architecture type of the Redis instance.
    instance_class str
    The type of Redis instance.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    archType String
    The architecture type of the Redis instance.
    instanceClass String
    The type of Redis instance.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.

    InstanceSpecs Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceSpecs List<InstanceSpecsInstanceSpec>
    The List of Redis instance specifications.
    TotalCount int
    The total count of query.
    ArchType string
    The architecture type of the Redis instance.
    InstanceClass string
    NameRegex string
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceSpecs []InstanceSpecsInstanceSpec
    The List of Redis instance specifications.
    TotalCount int
    The total count of query.
    ArchType string
    The architecture type of the Redis instance.
    InstanceClass string
    NameRegex string
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    instanceSpecs List<InstanceSpecsInstanceSpec>
    The List of Redis instance specifications.
    totalCount Integer
    The total count of query.
    archType String
    The architecture type of the Redis instance.
    instanceClass String
    nameRegex String
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    instanceSpecs InstanceSpecsInstanceSpec[]
    The List of Redis instance specifications.
    totalCount number
    The total count of query.
    archType string
    The architecture type of the Redis instance.
    instanceClass string
    nameRegex string
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    instance_specs Sequence[InstanceSpecsInstanceSpec]
    The List of Redis instance specifications.
    total_count int
    The total count of query.
    arch_type str
    The architecture type of the Redis instance.
    instance_class str
    name_regex str
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    instanceSpecs List<Property Map>
    The List of Redis instance specifications.
    totalCount Number
    The total count of query.
    archType String
    The architecture type of the Redis instance.
    instanceClass String
    nameRegex String
    outputFile String

    Supporting Types

    InstanceSpecsInstanceSpec

    ArchType string
    The architecture type of the Redis instance.
    NodeNumbers List<int>
    The list of the number of nodes allowed to be used per shard. The number of nodes allowed for different instance types varies.
    ShardCapacitySpecs List<InstanceSpecsInstanceSpecShardCapacitySpec>
    The List of capacity specifications for a single shard.
    ShardNumbers List<int>
    The list of shards that the instance is allowed to use. The number of shards allowed for use varies among different instance architecture types.
    InstanceClass string
    The type of Redis instance.
    ArchType string
    The architecture type of the Redis instance.
    NodeNumbers []int
    The list of the number of nodes allowed to be used per shard. The number of nodes allowed for different instance types varies.
    ShardCapacitySpecs []InstanceSpecsInstanceSpecShardCapacitySpec
    The List of capacity specifications for a single shard.
    ShardNumbers []int
    The list of shards that the instance is allowed to use. The number of shards allowed for use varies among different instance architecture types.
    InstanceClass string
    The type of Redis instance.
    archType String
    The architecture type of the Redis instance.
    nodeNumbers List<Integer>
    The list of the number of nodes allowed to be used per shard. The number of nodes allowed for different instance types varies.
    shardCapacitySpecs List<InstanceSpecsInstanceSpecShardCapacitySpec>
    The List of capacity specifications for a single shard.
    shardNumbers List<Integer>
    The list of shards that the instance is allowed to use. The number of shards allowed for use varies among different instance architecture types.
    instanceClass String
    The type of Redis instance.
    archType string
    The architecture type of the Redis instance.
    nodeNumbers number[]
    The list of the number of nodes allowed to be used per shard. The number of nodes allowed for different instance types varies.
    shardCapacitySpecs InstanceSpecsInstanceSpecShardCapacitySpec[]
    The List of capacity specifications for a single shard.
    shardNumbers number[]
    The list of shards that the instance is allowed to use. The number of shards allowed for use varies among different instance architecture types.
    instanceClass string
    The type of Redis instance.
    arch_type str
    The architecture type of the Redis instance.
    node_numbers Sequence[int]
    The list of the number of nodes allowed to be used per shard. The number of nodes allowed for different instance types varies.
    shard_capacity_specs Sequence[InstanceSpecsInstanceSpecShardCapacitySpec]
    The List of capacity specifications for a single shard.
    shard_numbers Sequence[int]
    The list of shards that the instance is allowed to use. The number of shards allowed for use varies among different instance architecture types.
    instance_class str
    The type of Redis instance.
    archType String
    The architecture type of the Redis instance.
    nodeNumbers List<Number>
    The list of the number of nodes allowed to be used per shard. The number of nodes allowed for different instance types varies.
    shardCapacitySpecs List<Property Map>
    The List of capacity specifications for a single shard.
    shardNumbers List<Number>
    The list of shards that the instance is allowed to use. The number of shards allowed for use varies among different instance architecture types.
    instanceClass String
    The type of Redis instance.

    InstanceSpecsInstanceSpecShardCapacitySpec

    DefaultBandwidthPerShard int
    The default bandwidth of the instance under the current memory capacity.
    MaxAdditionalBandwidthPerShard int
    The upper limit of bandwidth that an instance is allowed to modify under the current memory capacity.
    MaxConnectionsPerShard int
    The default maximum number of connections for a single shard.
    ShardCapacity int
    Single-shard memory capacity.
    DefaultBandwidthPerShard int
    The default bandwidth of the instance under the current memory capacity.
    MaxAdditionalBandwidthPerShard int
    The upper limit of bandwidth that an instance is allowed to modify under the current memory capacity.
    MaxConnectionsPerShard int
    The default maximum number of connections for a single shard.
    ShardCapacity int
    Single-shard memory capacity.
    defaultBandwidthPerShard Integer
    The default bandwidth of the instance under the current memory capacity.
    maxAdditionalBandwidthPerShard Integer
    The upper limit of bandwidth that an instance is allowed to modify under the current memory capacity.
    maxConnectionsPerShard Integer
    The default maximum number of connections for a single shard.
    shardCapacity Integer
    Single-shard memory capacity.
    defaultBandwidthPerShard number
    The default bandwidth of the instance under the current memory capacity.
    maxAdditionalBandwidthPerShard number
    The upper limit of bandwidth that an instance is allowed to modify under the current memory capacity.
    maxConnectionsPerShard number
    The default maximum number of connections for a single shard.
    shardCapacity number
    Single-shard memory capacity.
    default_bandwidth_per_shard int
    The default bandwidth of the instance under the current memory capacity.
    max_additional_bandwidth_per_shard int
    The upper limit of bandwidth that an instance is allowed to modify under the current memory capacity.
    max_connections_per_shard int
    The default maximum number of connections for a single shard.
    shard_capacity int
    Single-shard memory capacity.
    defaultBandwidthPerShard Number
    The default bandwidth of the instance under the current memory capacity.
    maxAdditionalBandwidthPerShard Number
    The upper limit of bandwidth that an instance is allowed to modify under the current memory capacity.
    maxConnectionsPerShard Number
    The default maximum number of connections for a single shard.
    shardCapacity Number
    Single-shard memory capacity.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine