1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. getRdsInstanceV3
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.getRdsInstanceV3

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for RDSv3 instance you can get at documentation portal

    Use the opentelekomcloud.RdsInstanceV3 datasource to query DB instances according to search criteria.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
    import com.pulumi.opentelekomcloud.inputs.GetRdsInstanceV3Args;
    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 instance = OpentelekomcloudFunctions.getRdsInstanceV3(GetRdsInstanceV3Args.builder()
                .databaseType("PostgreSQL")
                .id("rds_instance_1_id")
                .name("rds_instance_1")
                .subnetId("subnet-id")
                .type("single")
                .vpcId("vpc-id")
                .build());
    
        }
    }
    
    variables:
      instance:
        fn::invoke:
          function: opentelekomcloud:getRdsInstanceV3
          arguments:
            databaseType: PostgreSQL
            id: rds_instance_1_id
            name: rds_instance_1
            subnetId: subnet-id
            type: single
            vpcId: vpc-id
    

    Using getRdsInstanceV3

    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 getRdsInstanceV3(args: GetRdsInstanceV3Args, opts?: InvokeOptions): Promise<GetRdsInstanceV3Result>
    function getRdsInstanceV3Output(args: GetRdsInstanceV3OutputArgs, opts?: InvokeOptions): Output<GetRdsInstanceV3Result>
    def get_rds_instance_v3(datastore_type: Optional[str] = None,
                            id: Optional[str] = None,
                            name: Optional[str] = None,
                            port: Optional[float] = None,
                            region: Optional[str] = None,
                            subnet_id: Optional[str] = None,
                            type: Optional[str] = None,
                            vpc_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetRdsInstanceV3Result
    def get_rds_instance_v3_output(datastore_type: Optional[pulumi.Input[str]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            port: Optional[pulumi.Input[float]] = None,
                            region: Optional[pulumi.Input[str]] = None,
                            subnet_id: Optional[pulumi.Input[str]] = None,
                            type: Optional[pulumi.Input[str]] = None,
                            vpc_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetRdsInstanceV3Result]
    func LookupRdsInstanceV3(ctx *Context, args *LookupRdsInstanceV3Args, opts ...InvokeOption) (*LookupRdsInstanceV3Result, error)
    func LookupRdsInstanceV3Output(ctx *Context, args *LookupRdsInstanceV3OutputArgs, opts ...InvokeOption) LookupRdsInstanceV3ResultOutput

    > Note: This function is named LookupRdsInstanceV3 in the Go SDK.

    public static class GetRdsInstanceV3 
    {
        public static Task<GetRdsInstanceV3Result> InvokeAsync(GetRdsInstanceV3Args args, InvokeOptions? opts = null)
        public static Output<GetRdsInstanceV3Result> Invoke(GetRdsInstanceV3InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRdsInstanceV3Result> getRdsInstanceV3(GetRdsInstanceV3Args args, InvokeOptions options)
    public static Output<GetRdsInstanceV3Result> getRdsInstanceV3(GetRdsInstanceV3Args args, InvokeOptions options)
    
    fn::invoke:
      function: opentelekomcloud:index/getRdsInstanceV3:getRdsInstanceV3
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatastoreType string
    Id string
    ID of the RDS instance.
    Name string
    Specifies the DB instance ID.
    Port double
    Indicates the database port number.
    Region string
    Indicates the region where the DB instance is deployed.
    SubnetId string
    Specifies the network ID of the subnet.
    Type string
    Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    VpcId string
    Specifies the VPC ID.
    DatastoreType string
    Id string
    ID of the RDS instance.
    Name string
    Specifies the DB instance ID.
    Port float64
    Indicates the database port number.
    Region string
    Indicates the region where the DB instance is deployed.
    SubnetId string
    Specifies the network ID of the subnet.
    Type string
    Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    VpcId string
    Specifies the VPC ID.
    datastoreType String
    id String
    ID of the RDS instance.
    name String
    Specifies the DB instance ID.
    port Double
    Indicates the database port number.
    region String
    Indicates the region where the DB instance is deployed.
    subnetId String
    Specifies the network ID of the subnet.
    type String
    Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    vpcId String
    Specifies the VPC ID.
    datastoreType string
    id string
    ID of the RDS instance.
    name string
    Specifies the DB instance ID.
    port number
    Indicates the database port number.
    region string
    Indicates the region where the DB instance is deployed.
    subnetId string
    Specifies the network ID of the subnet.
    type string
    Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    vpcId string
    Specifies the VPC ID.
    datastore_type str
    id str
    ID of the RDS instance.
    name str
    Specifies the DB instance ID.
    port float
    Indicates the database port number.
    region str
    Indicates the region where the DB instance is deployed.
    subnet_id str
    Specifies the network ID of the subnet.
    type str
    Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    vpc_id str
    Specifies the VPC ID.
    datastoreType String
    id String
    ID of the RDS instance.
    name String
    Specifies the DB instance ID.
    port Number
    Indicates the database port number.
    region String
    Indicates the region where the DB instance is deployed.
    subnetId String
    Specifies the network ID of the subnet.
    type String
    Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    vpcId String
    Specifies the VPC ID.

    getRdsInstanceV3 Result

    The following output properties are available:

    AvailabilityZones List<string>
    Indicates the availability zone.
    BackupStrategies List<GetRdsInstanceV3BackupStrategy>
    Created string
    Indicates the creation time.
    DatastoreVersion string
    Indicates the database version.
    DbUsername string
    Indicates the database username.
    DiskEncryptionId string
    Indicates the disk encryption ID.
    FixedIp string
    Flavor string
    Indicates the flavor ID.
    Ha Dictionary<string, string>
    Id string
    Indicates the DB instance ID.
    Nodes List<GetRdsInstanceV3Node>
    Indicates the node information.
    PrivateIps List<string>
    Indicates the private IP address. It is a blank string until an ECS is created.
    PublicIps List<string>
    Indicates the public IP address.
    Region string
    Indicates the region where the DB instance is deployed.
    SecurityGroupId string
    Indicates the security group ID.
    Status string
    Indicates the DB instance status.
    Tags Dictionary<string, string>
    Indicates the tags.
    Timezone string
    Indicates the time zone.
    Updated string
    Indicates the update time.
    VolumeSize double
    Indicates the volume size.
    VolumeType string
    Indicates the volume type.
    DatastoreType string
    Name string
    Indicates created the DB instance name.
    Port double
    Indicates the database port number.
    SubnetId string
    Indicates the network ID of the subnet.
    Type string
    The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    VpcId string
    Indicates the VPC ID.
    AvailabilityZones []string
    Indicates the availability zone.
    BackupStrategies []GetRdsInstanceV3BackupStrategy
    Created string
    Indicates the creation time.
    DatastoreVersion string
    Indicates the database version.
    DbUsername string
    Indicates the database username.
    DiskEncryptionId string
    Indicates the disk encryption ID.
    FixedIp string
    Flavor string
    Indicates the flavor ID.
    Ha map[string]string
    Id string
    Indicates the DB instance ID.
    Nodes []GetRdsInstanceV3Node
    Indicates the node information.
    PrivateIps []string
    Indicates the private IP address. It is a blank string until an ECS is created.
    PublicIps []string
    Indicates the public IP address.
    Region string
    Indicates the region where the DB instance is deployed.
    SecurityGroupId string
    Indicates the security group ID.
    Status string
    Indicates the DB instance status.
    Tags map[string]string
    Indicates the tags.
    Timezone string
    Indicates the time zone.
    Updated string
    Indicates the update time.
    VolumeSize float64
    Indicates the volume size.
    VolumeType string
    Indicates the volume type.
    DatastoreType string
    Name string
    Indicates created the DB instance name.
    Port float64
    Indicates the database port number.
    SubnetId string
    Indicates the network ID of the subnet.
    Type string
    The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    VpcId string
    Indicates the VPC ID.
    availabilityZones List<String>
    Indicates the availability zone.
    backupStrategies List<GetRdsInstanceV3BackupStrategy>
    created String
    Indicates the creation time.
    datastoreVersion String
    Indicates the database version.
    dbUsername String
    Indicates the database username.
    diskEncryptionId String
    Indicates the disk encryption ID.
    fixedIp String
    flavor String
    Indicates the flavor ID.
    ha Map<String,String>
    id String
    Indicates the DB instance ID.
    nodes List<GetRdsInstanceV3Node>
    Indicates the node information.
    privateIps List<String>
    Indicates the private IP address. It is a blank string until an ECS is created.
    publicIps List<String>
    Indicates the public IP address.
    region String
    Indicates the region where the DB instance is deployed.
    securityGroupId String
    Indicates the security group ID.
    status String
    Indicates the DB instance status.
    tags Map<String,String>
    Indicates the tags.
    timezone String
    Indicates the time zone.
    updated String
    Indicates the update time.
    volumeSize Double
    Indicates the volume size.
    volumeType String
    Indicates the volume type.
    datastoreType String
    name String
    Indicates created the DB instance name.
    port Double
    Indicates the database port number.
    subnetId String
    Indicates the network ID of the subnet.
    type String
    The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    vpcId String
    Indicates the VPC ID.
    availabilityZones string[]
    Indicates the availability zone.
    backupStrategies GetRdsInstanceV3BackupStrategy[]
    created string
    Indicates the creation time.
    datastoreVersion string
    Indicates the database version.
    dbUsername string
    Indicates the database username.
    diskEncryptionId string
    Indicates the disk encryption ID.
    fixedIp string
    flavor string
    Indicates the flavor ID.
    ha {[key: string]: string}
    id string
    Indicates the DB instance ID.
    nodes GetRdsInstanceV3Node[]
    Indicates the node information.
    privateIps string[]
    Indicates the private IP address. It is a blank string until an ECS is created.
    publicIps string[]
    Indicates the public IP address.
    region string
    Indicates the region where the DB instance is deployed.
    securityGroupId string
    Indicates the security group ID.
    status string
    Indicates the DB instance status.
    tags {[key: string]: string}
    Indicates the tags.
    timezone string
    Indicates the time zone.
    updated string
    Indicates the update time.
    volumeSize number
    Indicates the volume size.
    volumeType string
    Indicates the volume type.
    datastoreType string
    name string
    Indicates created the DB instance name.
    port number
    Indicates the database port number.
    subnetId string
    Indicates the network ID of the subnet.
    type string
    The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    vpcId string
    Indicates the VPC ID.
    availability_zones Sequence[str]
    Indicates the availability zone.
    backup_strategies Sequence[GetRdsInstanceV3BackupStrategy]
    created str
    Indicates the creation time.
    datastore_version str
    Indicates the database version.
    db_username str
    Indicates the database username.
    disk_encryption_id str
    Indicates the disk encryption ID.
    fixed_ip str
    flavor str
    Indicates the flavor ID.
    ha Mapping[str, str]
    id str
    Indicates the DB instance ID.
    nodes Sequence[GetRdsInstanceV3Node]
    Indicates the node information.
    private_ips Sequence[str]
    Indicates the private IP address. It is a blank string until an ECS is created.
    public_ips Sequence[str]
    Indicates the public IP address.
    region str
    Indicates the region where the DB instance is deployed.
    security_group_id str
    Indicates the security group ID.
    status str
    Indicates the DB instance status.
    tags Mapping[str, str]
    Indicates the tags.
    timezone str
    Indicates the time zone.
    updated str
    Indicates the update time.
    volume_size float
    Indicates the volume size.
    volume_type str
    Indicates the volume type.
    datastore_type str
    name str
    Indicates created the DB instance name.
    port float
    Indicates the database port number.
    subnet_id str
    Indicates the network ID of the subnet.
    type str
    The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    vpc_id str
    Indicates the VPC ID.
    availabilityZones List<String>
    Indicates the availability zone.
    backupStrategies List<Property Map>
    created String
    Indicates the creation time.
    datastoreVersion String
    Indicates the database version.
    dbUsername String
    Indicates the database username.
    diskEncryptionId String
    Indicates the disk encryption ID.
    fixedIp String
    flavor String
    Indicates the flavor ID.
    ha Map<String>
    id String
    Indicates the DB instance ID.
    nodes List<Property Map>
    Indicates the node information.
    privateIps List<String>
    Indicates the private IP address. It is a blank string until an ECS is created.
    publicIps List<String>
    Indicates the public IP address.
    region String
    Indicates the region where the DB instance is deployed.
    securityGroupId String
    Indicates the security group ID.
    status String
    Indicates the DB instance status.
    tags Map<String>
    Indicates the tags.
    timezone String
    Indicates the time zone.
    updated String
    Indicates the update time.
    volumeSize Number
    Indicates the volume size.
    volumeType String
    Indicates the volume type.
    datastoreType String
    name String
    Indicates created the DB instance name.
    port Number
    Indicates the database port number.
    subnetId String
    Indicates the network ID of the subnet.
    type String
    The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
    vpcId String
    Indicates the VPC ID.

    Supporting Types

    GetRdsInstanceV3BackupStrategy

    KeepDays double
    StartTime string
    KeepDays float64
    StartTime string
    keepDays Double
    startTime String
    keepDays number
    startTime string
    keepDays Number
    startTime String

    GetRdsInstanceV3Node

    AvailabilityZone string
    Indicates the availability zone.
    Id string
    ID of the RDS instance.
    Name string
    Specifies the DB instance ID.
    Role string
    Status string
    Indicates the DB instance status.
    AvailabilityZone string
    Indicates the availability zone.
    Id string
    ID of the RDS instance.
    Name string
    Specifies the DB instance ID.
    Role string
    Status string
    Indicates the DB instance status.
    availabilityZone String
    Indicates the availability zone.
    id String
    ID of the RDS instance.
    name String
    Specifies the DB instance ID.
    role String
    status String
    Indicates the DB instance status.
    availabilityZone string
    Indicates the availability zone.
    id string
    ID of the RDS instance.
    name string
    Specifies the DB instance ID.
    role string
    status string
    Indicates the DB instance status.
    availability_zone str
    Indicates the availability zone.
    id str
    ID of the RDS instance.
    name str
    Specifies the DB instance ID.
    role str
    status str
    Indicates the DB instance status.
    availabilityZone String
    Indicates the availability zone.
    id String
    ID of the RDS instance.
    name String
    Specifies the DB instance ID.
    role String
    status String
    Indicates the DB instance status.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud