Volcengine v0.0.27, Dec 10 24

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

volcengine.rds.Instances

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const default = volcengine.rds.Instances({
    instanceId: "mysql-0fdd3bab2e7c",
});

import pulumi
import pulumi_volcengine as volcengine

default = volcengine.rds.instances(instance_id="mysql-0fdd3bab2e7c")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.Instances(ctx, &rds.InstancesArgs{
			InstanceId: pulumi.StringRef("mysql-0fdd3bab2e7c"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Rds.Instances.Invoke(new()
    {
        InstanceId = "mysql-0fdd3bab2e7c",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds.RdsFunctions;
import com.pulumi.volcengine.rds.inputs.InstancesArgs;
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 default = RdsFunctions.Instances(InstancesArgs.builder()
            .instanceId("mysql-0fdd3bab2e7c")
            .build());

    }
}

variables:
  default:
    fn::invoke:
      Function: volcengine:rds:Instances
      Arguments:
        instanceId: mysql-0fdd3bab2e7c

Using Instances

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.

TypeScript
Python
Go
C#
Java
YAML

function instances(args: InstancesArgs, opts?: InvokeOptions): Promise<InstancesResult>
function instancesOutput(args: InstancesOutputArgs, opts?: InvokeOptions): Output<InstancesResult>

def instances(create_end_time: Optional[str] = None,
              create_start_time: Optional[str] = None,
              instance_id: Optional[str] = None,
              instance_status: Optional[str] = None,
              instance_type: Optional[str] = None,
              name_regex: Optional[str] = None,
              output_file: Optional[str] = None,
              region: Optional[str] = None,
              zone: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> InstancesResult
def instances_output(create_end_time: Optional[pulumi.Input[str]] = None,
              create_start_time: Optional[pulumi.Input[str]] = None,
              instance_id: Optional[pulumi.Input[str]] = None,
              instance_status: Optional[pulumi.Input[str]] = None,
              instance_type: Optional[pulumi.Input[str]] = None,
              name_regex: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              region: Optional[pulumi.Input[str]] = None,
              zone: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[InstancesResult]

func Instances(ctx *Context, args *InstancesArgs, opts ...InvokeOption) (*InstancesResult, error)
func InstancesOutput(ctx *Context, args *InstancesOutputArgs, opts ...InvokeOption) InstancesResultOutput

public static class Instances 
{
    public static Task<InstancesResult> InvokeAsync(InstancesArgs args, InvokeOptions? opts = null)
    public static Output<InstancesResult> Invoke(InstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<InstancesResult> instances(InstancesArgs args, InvokeOptions options)
public static Output<InstancesResult> instances(InstancesArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:rds:Instances
  arguments:
    # arguments dictionary

The following arguments are supported:

CreateEndTime string: The end time of creating RDS instance.
CreateStartTime string: The start time of creating RDS instance.
InstanceId string: The id of the RDS instance.
InstanceStatus string: The status of the RDS instance.
InstanceType string: The type of the RDS instance.
NameRegex string: A Name Regex of RDS instance.
OutputFile string: File name where to save data source results.
Region string: The region of the RDS instance.
Zone string: The available zone of the RDS instance.

CreateEndTime string: The end time of creating RDS instance.
CreateStartTime string: The start time of creating RDS instance.
InstanceId string: The id of the RDS instance.
InstanceStatus string: The status of the RDS instance.
InstanceType string: The type of the RDS instance.
NameRegex string: A Name Regex of RDS instance.
OutputFile string: File name where to save data source results.
Region string: The region of the RDS instance.
Zone string: The available zone of the RDS instance.

createEndTime String: The end time of creating RDS instance.
createStartTime String: The start time of creating RDS instance.
instanceId String: The id of the RDS instance.
instanceStatus String: The status of the RDS instance.
instanceType String: The type of the RDS instance.
nameRegex String: A Name Regex of RDS instance.
outputFile String: File name where to save data source results.
region String: The region of the RDS instance.
zone String: The available zone of the RDS instance.

createEndTime string: The end time of creating RDS instance.
createStartTime string: The start time of creating RDS instance.
instanceId string: The id of the RDS instance.
instanceStatus string: The status of the RDS instance.
instanceType string: The type of the RDS instance.
nameRegex string: A Name Regex of RDS instance.
outputFile string: File name where to save data source results.
region string: The region of the RDS instance.
zone string: The available zone of the RDS instance.

create_end_time str: The end time of creating RDS instance.
create_start_time str: The start time of creating RDS instance.
instance_id str: The id of the RDS instance.
instance_status str: The status of the RDS instance.
instance_type str: The type of the RDS instance.
name_regex str: A Name Regex of RDS instance.
output_file str: File name where to save data source results.
region str: The region of the RDS instance.
zone str: The available zone of the RDS instance.

createEndTime String: The end time of creating RDS instance.
createStartTime String: The start time of creating RDS instance.
instanceId String: The id of the RDS instance.
instanceStatus String: The status of the RDS instance.
instanceType String: The type of the RDS instance.
nameRegex String: A Name Regex of RDS instance.
outputFile String: File name where to save data source results.
region String: The region of the RDS instance.
zone String: The available zone of the RDS instance.

Instances Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
RdsInstances List<InstancesRdsInstance>: The collection of RDS instance query.
TotalCount int: The total count of RDS instance query.
CreateEndTime string
CreateStartTime string
InstanceId string: The ID of the RDS instance.
InstanceStatus string: The status of the RDS instance.
InstanceType string: The type of the RDS instance.
NameRegex string
OutputFile string
Region string: The region of the RDS instance.
Zone string: The available zone of the RDS instance.

Id string: The provider-assigned unique ID for this managed resource.
RdsInstances []InstancesRdsInstance: The collection of RDS instance query.
TotalCount int: The total count of RDS instance query.
CreateEndTime string
CreateStartTime string
InstanceId string: The ID of the RDS instance.
InstanceStatus string: The status of the RDS instance.
InstanceType string: The type of the RDS instance.
NameRegex string
OutputFile string
Region string: The region of the RDS instance.
Zone string: The available zone of the RDS instance.

id String: The provider-assigned unique ID for this managed resource.
rdsInstances List<InstancesRdsInstance>: The collection of RDS instance query.
totalCount Integer: The total count of RDS instance query.
createEndTime String
createStartTime String
instanceId String: The ID of the RDS instance.
instanceStatus String: The status of the RDS instance.
instanceType String: The type of the RDS instance.
nameRegex String
outputFile String
region String: The region of the RDS instance.
zone String: The available zone of the RDS instance.

id string: The provider-assigned unique ID for this managed resource.
rdsInstances InstancesRdsInstance[]: The collection of RDS instance query.
totalCount number: The total count of RDS instance query.
createEndTime string
createStartTime string
instanceId string: The ID of the RDS instance.
instanceStatus string: The status of the RDS instance.
instanceType string: The type of the RDS instance.
nameRegex string
outputFile string
region string: The region of the RDS instance.
zone string: The available zone of the RDS instance.

id str: The provider-assigned unique ID for this managed resource.
rds_instances Sequence[InstancesRdsInstance]: The collection of RDS instance query.
total_count int: The total count of RDS instance query.
create_end_time str
create_start_time str
instance_id str: The ID of the RDS instance.
instance_status str: The status of the RDS instance.
instance_type str: The type of the RDS instance.
name_regex str
output_file str
region str: The region of the RDS instance.
zone str: The available zone of the RDS instance.

id String: The provider-assigned unique ID for this managed resource.
rdsInstances List<Property Map>: The collection of RDS instance query.
totalCount Number: The total count of RDS instance query.
createEndTime String
createStartTime String
instanceId String: The ID of the RDS instance.
instanceStatus String: The status of the RDS instance.
instanceType String: The type of the RDS instance.
nameRegex String
outputFile String
region String: The region of the RDS instance.
zone String: The available zone of the RDS instance.

Supporting Types

InstancesRdsInstance

ChargeStatus string: The charge status of the RDS instance.
ChargeType string: The charge type of the RDS instance.
ConnectionInfo InstancesRdsInstanceConnectionInfo: The connection info ot the RDS instance.
CreateTime string: The create time of the RDS instance.
DbEngine string: The engine of the RDS instance.
DbEngineVersion string: The engine version of the RDS instance.
Id string: The ID of the RDS instance.
InstanceId string: The id of the RDS instance.
InstanceName string: The name of the RDS instance.
InstanceSpec InstancesRdsInstanceInstanceSpec: The spec type detail of RDS instance.
InstanceStatus string: The status of the RDS instance.
InstanceType string: The type of the RDS instance.
Region string: The region of the RDS instance.
StorageSpaceGb int: The total storage GB of the RDS instance.
UpdateTime string: The update time of the RDS instance.
VpcId string: The vpc ID of the RDS instance.
Zone string: The available zone of the RDS instance.
ReadOnlyInstanceIds List<string>: The ID list of read only instance.

ChargeStatus string: The charge status of the RDS instance.
ChargeType string: The charge type of the RDS instance.
ConnectionInfo InstancesRdsInstanceConnectionInfo: The connection info ot the RDS instance.
CreateTime string: The create time of the RDS instance.
DbEngine string: The engine of the RDS instance.
DbEngineVersion string: The engine version of the RDS instance.
Id string: The ID of the RDS instance.
InstanceId string: The id of the RDS instance.
InstanceName string: The name of the RDS instance.
InstanceSpec InstancesRdsInstanceInstanceSpec: The spec type detail of RDS instance.
InstanceStatus string: The status of the RDS instance.
InstanceType string: The type of the RDS instance.
Region string: The region of the RDS instance.
StorageSpaceGb int: The total storage GB of the RDS instance.
UpdateTime string: The update time of the RDS instance.
VpcId string: The vpc ID of the RDS instance.
Zone string: The available zone of the RDS instance.
ReadOnlyInstanceIds []string: The ID list of read only instance.

chargeStatus String: The charge status of the RDS instance.
chargeType String: The charge type of the RDS instance.
connectionInfo InstancesRdsInstanceConnectionInfo: The connection info ot the RDS instance.
createTime String: The create time of the RDS instance.
dbEngine String: The engine of the RDS instance.
dbEngineVersion String: The engine version of the RDS instance.
id String: The ID of the RDS instance.
instanceId String: The id of the RDS instance.
instanceName String: The name of the RDS instance.
instanceSpec InstancesRdsInstanceInstanceSpec: The spec type detail of RDS instance.
instanceStatus String: The status of the RDS instance.
instanceType String: The type of the RDS instance.
region String: The region of the RDS instance.
storageSpaceGb Integer: The total storage GB of the RDS instance.
updateTime String: The update time of the RDS instance.
vpcId String: The vpc ID of the RDS instance.
zone String: The available zone of the RDS instance.
readOnlyInstanceIds List<String>: The ID list of read only instance.

chargeStatus string: The charge status of the RDS instance.
chargeType string: The charge type of the RDS instance.
connectionInfo InstancesRdsInstanceConnectionInfo: The connection info ot the RDS instance.
createTime string: The create time of the RDS instance.
dbEngine string: The engine of the RDS instance.
dbEngineVersion string: The engine version of the RDS instance.
id string: The ID of the RDS instance.
instanceId string: The id of the RDS instance.
instanceName string: The name of the RDS instance.
instanceSpec InstancesRdsInstanceInstanceSpec: The spec type detail of RDS instance.
instanceStatus string: The status of the RDS instance.
instanceType string: The type of the RDS instance.
region string: The region of the RDS instance.
storageSpaceGb number: The total storage GB of the RDS instance.
updateTime string: The update time of the RDS instance.
vpcId string: The vpc ID of the RDS instance.
zone string: The available zone of the RDS instance.
readOnlyInstanceIds string[]: The ID list of read only instance.

charge_status str: The charge status of the RDS instance.
charge_type str: The charge type of the RDS instance.
connection_info InstancesRdsInstanceConnectionInfo: The connection info ot the RDS instance.
create_time str: The create time of the RDS instance.
db_engine str: The engine of the RDS instance.
db_engine_version str: The engine version of the RDS instance.
id str: The ID of the RDS instance.
instance_id str: The id of the RDS instance.
instance_name str: The name of the RDS instance.
instance_spec InstancesRdsInstanceInstanceSpec: The spec type detail of RDS instance.
instance_status str: The status of the RDS instance.
instance_type str: The type of the RDS instance.
region str: The region of the RDS instance.
storage_space_gb int: The total storage GB of the RDS instance.
update_time str: The update time of the RDS instance.
vpc_id str: The vpc ID of the RDS instance.
zone str: The available zone of the RDS instance.
read_only_instance_ids Sequence[str]: The ID list of read only instance.

chargeStatus String: The charge status of the RDS instance.
chargeType String: The charge type of the RDS instance.
connectionInfo Property Map: The connection info ot the RDS instance.
createTime String: The create time of the RDS instance.
dbEngine String: The engine of the RDS instance.
dbEngineVersion String: The engine version of the RDS instance.
id String: The ID of the RDS instance.
instanceId String: The id of the RDS instance.
instanceName String: The name of the RDS instance.
instanceSpec Property Map: The spec type detail of RDS instance.
instanceStatus String: The status of the RDS instance.
instanceType String: The type of the RDS instance.
region String: The region of the RDS instance.
storageSpaceGb Number: The total storage GB of the RDS instance.
updateTime String: The update time of the RDS instance.
vpcId String: The vpc ID of the RDS instance.
zone String: The available zone of the RDS instance.
readOnlyInstanceIds List<String>: The ID list of read only instance.

InstancesRdsInstanceConnectionInfo

EnableReadOnly string: Whether global read-only is enabled.
EnableReadWriteSplitting string: Whether read-write separation is enabled.
InternalDomain string: The internal domain of the RDS instance.
InternalPort string: The interval port of the RDS instance.
PublicDomain string: The public domain of the RDS instance.
PublicPort string: The public port of the RDS instance.

EnableReadOnly string: Whether global read-only is enabled.
EnableReadWriteSplitting string: Whether read-write separation is enabled.
InternalDomain string: The internal domain of the RDS instance.
InternalPort string: The interval port of the RDS instance.
PublicDomain string: The public domain of the RDS instance.
PublicPort string: The public port of the RDS instance.

enableReadOnly String: Whether global read-only is enabled.
enableReadWriteSplitting String: Whether read-write separation is enabled.
internalDomain String: The internal domain of the RDS instance.
internalPort String: The interval port of the RDS instance.
publicDomain String: The public domain of the RDS instance.
publicPort String: The public port of the RDS instance.

enableReadOnly string: Whether global read-only is enabled.
enableReadWriteSplitting string: Whether read-write separation is enabled.
internalDomain string: The internal domain of the RDS instance.
internalPort string: The interval port of the RDS instance.
publicDomain string: The public domain of the RDS instance.
publicPort string: The public port of the RDS instance.

enable_read_only str: Whether global read-only is enabled.
enable_read_write_splitting str: Whether read-write separation is enabled.
internal_domain str: The internal domain of the RDS instance.
internal_port str: The interval port of the RDS instance.
public_domain str: The public domain of the RDS instance.
public_port str: The public port of the RDS instance.

enableReadOnly String: Whether global read-only is enabled.
enableReadWriteSplitting String: Whether read-write separation is enabled.
internalDomain String: The internal domain of the RDS instance.
internalPort String: The interval port of the RDS instance.
publicDomain String: The public domain of the RDS instance.
publicPort String: The public port of the RDS instance.

InstancesRdsInstanceInstanceSpec

CpuNum int: The cpu core count of spec type.
MemInGb int: The memory size(GB) of spec type.
SpecName string: The name of spec type.

CpuNum int: The cpu core count of spec type.
MemInGb int: The memory size(GB) of spec type.
SpecName string: The name of spec type.

cpuNum Integer: The cpu core count of spec type.
memInGb Integer: The memory size(GB) of spec type.
specName String: The name of spec type.

cpuNum number: The cpu core count of spec type.
memInGb number: The memory size(GB) of spec type.
specName string: The name of spec type.

cpu_num int: The cpu core count of spec type.
mem_in_gb int: The memory size(GB) of spec type.
spec_name str: The name of spec type.

cpuNum Number: The cpu core count of spec type.
memInGb Number: The memory size(GB) of spec type.
specName String: The name of spec type.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

volcengine/pulumi-volcengine

volcengine.rds.Instances

On this page

On this page

Example Usage

Using Instances

Instances Result

Supporting Types

InstancesRdsInstance

InstancesRdsInstanceConnectionInfo

InstancesRdsInstanceInstanceSpec

Package Details

On this page

On this page