opentelekomcloud 1.36.35, Apr 14 25

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.RdsInstanceV3

Explore with Pulumi AI

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

Example Usage

Create a single db instance

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  secgroup:
    type: opentelekomcloud:NetworkingSecgroupV2
    properties:
      description: terraform security group acceptance test
  instance:
    type: opentelekomcloud:RdsInstanceV3
    properties:
      availabilityZones:
        - ${var.availability_zone}
      db:
        password: P@ssw0rd1!9851
        type: PostgreSQL
        version: '16'
        port: '8635'
      securityGroupId: ${secgroup.networkingSecgroupV2Id}
      subnetId: ${var.subnet_id}
      vpcId: ${var.vpc_id}
      flavor: rds.pg.n1.large.4
      volume:
        type: CLOUDSSD
        size: 100
      backupStrategy:
        startTime: 08:00-09:00
        keepDays: 1
        period: 1,2,3,4,5
      tags:
        foo: bar
        key: value

Create a primary/standby db instance

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  secgroup:
    type: opentelekomcloud:NetworkingSecgroupV2
    properties:
      description: terraform security group acceptance test
  instance:
    type: opentelekomcloud:RdsInstanceV3
    properties:
      availabilityZones:
        - ${var.availability_zone_1}
        - ${var.availability_zone_2}
      db:
        password: P@ssw0rd1!9851
        type: PostgreSQL
        version: '16'
        port: '8635'
      securityGroupId: ${secgroup.networkingSecgroupV2Id}
      subnetId: ${var.subnet_id}
      vpcId: ${var.vpc_id}
      flavor: rds.pg.x1.8xlarge.4.ha
      haReplicationMode: async
      volume:
        type: CLOUDSSD
        size: 100
      backupStrategy:
        startTime: 08:00-09:00
        keepDays: 1
      tags:
        foo: bar
        key: value

Create a db instance with public IP

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  secgroup:
    type: opentelekomcloud:NetworkingSecgroupV2
    properties:
      description: terraform security group acceptance test
  ip:
    type: opentelekomcloud:ComputeFloatingipV2
  instance:
    type: opentelekomcloud:RdsInstanceV3
    properties:
      availabilityZones:
        - ${var.availability_zone_1}
        - ${var.availability_zone_2}
      db:
        password: Telekom!120521
        type: PostgreSQL
        version: '16'
        port: '8635'
      securityGroupId: ${secgroup.networkingSecgroupV2Id}
      subnetId: ${var.subnet_id}
      vpcId: ${var.vpc_id}
      volume:
        type: CLOUDSSD
        size: 100
      flavor: rds.pg.x1.8xlarge.4.ha
      haReplicationMode: async
      backupStrategy:
        startTime: 08:00-09:00
        keepDays: 1
      publicIps:
        - ${ip.address}
      tags:
        foo: bar
        key: value

Create a single db instance with encrypted volume

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  key:
    type: opentelekomcloud:KmsKeyV1
    properties:
      keyAlias: key_1
      keyDescription: first test key
      isEnabled: true
  secgroup:
    type: opentelekomcloud:NetworkingSecgroupV2
    properties:
      description: terraform security group acceptance test
  instance:
    type: opentelekomcloud:RdsInstanceV3
    properties:
      availabilityZones:
        - ${var.availability_zone}
      securityGroupId: ${secgroup.networkingSecgroupV2Id}
      subnetId: ${var.subnet_id}
      vpcId: ${var.vpc_id}
      flavor: rds.pg.n1.xlarge.2
      db:
        password: P@ssw0rd1!9851
        type: PostgreSQL
        version: '16'
        port: '8635'
      volume:
        diskEncryptionId: ${key.kmsKeyV1Id}
        type: CLOUDSSD
        size: 100
      backupStrategy:
        startTime: 08:00-09:00
        keepDays: 1

Overriding parameters from template

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  sg:
    type: opentelekomcloud:NetworkingSecgroupV2
  pg:
    type: opentelekomcloud:RdsParametergroupV3
    properties:
      values:
        autocommit: OFF
      datastore:
        type: postgresql
        version: '16'
  instance:
    type: opentelekomcloud:RdsInstanceV3
    properties:
      availabilityZones:
        - ${var.availability_zone}
      db:
        password: Postgres!120521
        type: PostgreSQL
        version: '16'
        port: '8635'
      securityGroupId: ${sg.networkingSecgroupV2Id}
      subnetId: ${var.subnet_id}
      vpcId: ${var.vpc_id}
      flavor: rds.pg.n1.xlarge.2
      volume:
        type: CLOUDSSD
        size: 40
      parameters:
        max_connections: '37'

Restore backup to a new instance

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  fromBackup:
    type: opentelekomcloud:RdsInstanceV3
    properties:
      availabilityZones: ${opentelekomcloud_rds_instance_v3.instance.availability_zone}
      flavor: rds.pg.n1.xlarge.2
      restorePoint:
        instanceId: ${backup.instanceId}
        backupId: ${backup.id}
      db:
        password: Postgres!120521
        type: PostgreSQL
        version: '16'
        port: '8635'
      securityGroupId: ${var.security_group_id}
      subnetId: ${var.os_network_id}
      vpcId: ${var.os_router_id}
      volume:
        type: CLOUDSSD
        size: 40
      backupStrategy:
        startTime: 08:00-09:00
        keepDays: 1
variables:
  backup:
    fn::invoke:
      function: opentelekomcloud:getRdsBackupV3
      arguments:
        instanceId: ${var.rds_instance_id}
        type: auto

Notes

But due to some attributes missing from the API response, it’s required to ignore changes as below. Also, for some MySQL versions the lower_case_table_names should be also added.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  instance1:
    type: opentelekomcloud:RdsInstanceV3
    properties:
      lifecycle:
        ignoreChanges:
          - availabilityZone
          - availabilityZones
          - db

Create RdsInstanceV3 Resource

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

Constructor syntax

new RdsInstanceV3(name: string, args: RdsInstanceV3Args, opts?: CustomResourceOptions);

@overload
def RdsInstanceV3(resource_name: str,
                  args: RdsInstanceV3Args,
                  opts: Optional[ResourceOptions] = None)

@overload
def RdsInstanceV3(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  security_group_id: Optional[str] = None,
                  vpc_id: Optional[str] = None,
                  db: Optional[RdsInstanceV3DbArgs] = None,
                  flavor: Optional[str] = None,
                  volume: Optional[RdsInstanceV3VolumeArgs] = None,
                  availability_zone: Optional[Sequence[str]] = None,
                  subnet_id: Optional[str] = None,
                  lower_case_table_names: Optional[str] = None,
                  ssl_enable: Optional[bool] = None,
                  public_ips: Optional[Sequence[str]] = None,
                  rds_instance_v3_id: Optional[str] = None,
                  restore_from_backup: Optional[RdsInstanceV3RestoreFromBackupArgs] = None,
                  restore_point: Optional[RdsInstanceV3RestorePointArgs] = None,
                  param_group_id: Optional[str] = None,
                  parameters: Optional[Mapping[str, str]] = None,
                  name: Optional[str] = None,
                  tag: Optional[Mapping[str, str]] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  timeouts: Optional[RdsInstanceV3TimeoutsArgs] = None,
                  ha_replication_mode: Optional[str] = None,
                  backup_strategy: Optional[RdsInstanceV3BackupStrategyArgs] = None)

func NewRdsInstanceV3(ctx *Context, name string, args RdsInstanceV3Args, opts ...ResourceOption) (*RdsInstanceV3, error)

public RdsInstanceV3(string name, RdsInstanceV3Args args, CustomResourceOptions? opts = null)

public RdsInstanceV3(String name, RdsInstanceV3Args args)
public RdsInstanceV3(String name, RdsInstanceV3Args args, CustomResourceOptions options)

type: opentelekomcloud:RdsInstanceV3
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 RdsInstanceV3Args: 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 RdsInstanceV3Args: 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 RdsInstanceV3Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RdsInstanceV3Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RdsInstanceV3Args: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var rdsInstanceV3Resource = new Opentelekomcloud.RdsInstanceV3("rdsInstanceV3Resource", new()
{
    SecurityGroupId = "string",
    VpcId = "string",
    Db = new Opentelekomcloud.Inputs.RdsInstanceV3DbArgs
    {
        Password = "string",
        Port = 0,
        Type = "string",
        UserName = "string",
        Version = "string",
    },
    Flavor = "string",
    Volume = new Opentelekomcloud.Inputs.RdsInstanceV3VolumeArgs
    {
        Size = 0,
        Type = "string",
        DiskEncryptionId = "string",
        LimitSize = 0,
        TriggerThreshold = 0,
    },
    AvailabilityZone = new[]
    {
        "string",
    },
    SubnetId = "string",
    LowerCaseTableNames = "string",
    SslEnable = false,
    PublicIps = new[]
    {
        "string",
    },
    RdsInstanceV3Id = "string",
    RestorePoint = new Opentelekomcloud.Inputs.RdsInstanceV3RestorePointArgs
    {
        InstanceId = "string",
        BackupId = "string",
        RestoreTime = 0,
    },
    ParamGroupId = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Opentelekomcloud.Inputs.RdsInstanceV3TimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
    HaReplicationMode = "string",
    BackupStrategy = new Opentelekomcloud.Inputs.RdsInstanceV3BackupStrategyArgs
    {
        StartTime = "string",
        KeepDays = 0,
        Period = "string",
    },
});

example, err := opentelekomcloud.NewRdsInstanceV3(ctx, "rdsInstanceV3Resource", &opentelekomcloud.RdsInstanceV3Args{
SecurityGroupId: pulumi.String("string"),
VpcId: pulumi.String("string"),
Db: &.RdsInstanceV3DbArgs{
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
Type: pulumi.String("string"),
UserName: pulumi.String("string"),
Version: pulumi.String("string"),
},
Flavor: pulumi.String("string"),
Volume: &.RdsInstanceV3VolumeArgs{
Size: pulumi.Float64(0),
Type: pulumi.String("string"),
DiskEncryptionId: pulumi.String("string"),
LimitSize: pulumi.Float64(0),
TriggerThreshold: pulumi.Float64(0),
},
AvailabilityZone: pulumi.StringArray{
pulumi.String("string"),
},
SubnetId: pulumi.String("string"),
LowerCaseTableNames: pulumi.String("string"),
SslEnable: pulumi.Bool(false),
PublicIps: pulumi.StringArray{
pulumi.String("string"),
},
RdsInstanceV3Id: pulumi.String("string"),
RestorePoint: &.RdsInstanceV3RestorePointArgs{
InstanceId: pulumi.String("string"),
BackupId: pulumi.String("string"),
RestoreTime: pulumi.Float64(0),
},
ParamGroupId: pulumi.String("string"),
Parameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeouts: &.RdsInstanceV3TimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
HaReplicationMode: pulumi.String("string"),
BackupStrategy: &.RdsInstanceV3BackupStrategyArgs{
StartTime: pulumi.String("string"),
KeepDays: pulumi.Float64(0),
Period: pulumi.String("string"),
},
})

var rdsInstanceV3Resource = new RdsInstanceV3("rdsInstanceV3Resource", RdsInstanceV3Args.builder()
    .securityGroupId("string")
    .vpcId("string")
    .db(RdsInstanceV3DbArgs.builder()
        .password("string")
        .port(0)
        .type("string")
        .userName("string")
        .version("string")
        .build())
    .flavor("string")
    .volume(RdsInstanceV3VolumeArgs.builder()
        .size(0)
        .type("string")
        .diskEncryptionId("string")
        .limitSize(0)
        .triggerThreshold(0)
        .build())
    .availabilityZone("string")
    .subnetId("string")
    .lowerCaseTableNames("string")
    .sslEnable(false)
    .publicIps("string")
    .rdsInstanceV3Id("string")
    .restorePoint(RdsInstanceV3RestorePointArgs.builder()
        .instanceId("string")
        .backupId("string")
        .restoreTime(0)
        .build())
    .paramGroupId("string")
    .parameters(Map.of("string", "string"))
    .name("string")
    .tags(Map.of("string", "string"))
    .timeouts(RdsInstanceV3TimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .haReplicationMode("string")
    .backupStrategy(RdsInstanceV3BackupStrategyArgs.builder()
        .startTime("string")
        .keepDays(0)
        .period("string")
        .build())
    .build());

rds_instance_v3_resource = opentelekomcloud.RdsInstanceV3("rdsInstanceV3Resource",
    security_group_id="string",
    vpc_id="string",
    db={
        "password": "string",
        "port": 0,
        "type": "string",
        "user_name": "string",
        "version": "string",
    },
    flavor="string",
    volume={
        "size": 0,
        "type": "string",
        "disk_encryption_id": "string",
        "limit_size": 0,
        "trigger_threshold": 0,
    },
    availability_zone=["string"],
    subnet_id="string",
    lower_case_table_names="string",
    ssl_enable=False,
    public_ips=["string"],
    rds_instance_v3_id="string",
    restore_point={
        "instance_id": "string",
        "backup_id": "string",
        "restore_time": 0,
    },
    param_group_id="string",
    parameters={
        "string": "string",
    },
    name="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "update": "string",
    },
    ha_replication_mode="string",
    backup_strategy={
        "start_time": "string",
        "keep_days": 0,
        "period": "string",
    })

const rdsInstanceV3Resource = new opentelekomcloud.RdsInstanceV3("rdsInstanceV3Resource", {
    securityGroupId: "string",
    vpcId: "string",
    db: {
        password: "string",
        port: 0,
        type: "string",
        userName: "string",
        version: "string",
    },
    flavor: "string",
    volume: {
        size: 0,
        type: "string",
        diskEncryptionId: "string",
        limitSize: 0,
        triggerThreshold: 0,
    },
    availabilityZone: ["string"],
    subnetId: "string",
    lowerCaseTableNames: "string",
    sslEnable: false,
    publicIps: ["string"],
    rdsInstanceV3Id: "string",
    restorePoint: {
        instanceId: "string",
        backupId: "string",
        restoreTime: 0,
    },
    paramGroupId: "string",
    parameters: {
        string: "string",
    },
    name: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        update: "string",
    },
    haReplicationMode: "string",
    backupStrategy: {
        startTime: "string",
        keepDays: 0,
        period: "string",
    },
});

type: opentelekomcloud:RdsInstanceV3
properties:
    availabilityZone:
        - string
    backupStrategy:
        keepDays: 0
        period: string
        startTime: string
    db:
        password: string
        port: 0
        type: string
        userName: string
        version: string
    flavor: string
    haReplicationMode: string
    lowerCaseTableNames: string
    name: string
    paramGroupId: string
    parameters:
        string: string
    publicIps:
        - string
    rdsInstanceV3Id: string
    restorePoint:
        backupId: string
        instanceId: string
        restoreTime: 0
    securityGroupId: string
    sslEnable: false
    subnetId: string
    tags:
        string: string
    timeouts:
        create: string
        update: string
    volume:
        diskEncryptionId: string
        limitSize: 0
        size: 0
        triggerThreshold: 0
        type: string
    vpcId: string

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

AvailabilityZone List<string>

Specifies the AZ name. Changing this parameter will create a new resource.

Db RdsInstanceV3Db

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

Flavor string

Specifies the specification code. Use data source opentelekomcloud.getRdsFlavorsV3 to get a list of available flavor names. Examples could be rds.pg.n1.large.4 or rds.pg.x1.8xlarge.4.ha for HA clusters.

SecurityGroupId string

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

SubnetId string

Specifies the subnet id. Changing this parameter will create a new resource.

Volume RdsInstanceV3Volume

Specifies the volume information. Structure is documented below.

VpcId string

Specifies the VPC ID. Changing this parameter will create a new resource.

BackupStrategy RdsInstanceV3BackupStrategy

Specifies the advanced backup policy. Structure is documented below.

HaReplicationMode string

Specifies the replication mode for the standby DB instance. For MySQL, the value is async or semisync. For PostgreSQL, the value is async or sync. For Microsoft SQL Server, the value is sync. Parameter is required for HA clusters.

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

LowerCaseTableNames string

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

Name string

Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

ParamGroupId string

Specifies the parameter group ID.

Parameters Dictionary<string, string>

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

PublicIps List<string>

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

RdsInstanceV3Id string

Indicates the node ID.

RestoreFromBackup RdsInstanceV3RestoreFromBackup

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

RestorePoint RdsInstanceV3RestorePoint

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

SslEnable bool

Specifies whether SSL should be enabled for MySql instances.

Tag Dictionary<string, string>

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

Tags Dictionary<string, string>

Tags key/value pairs to associate with the instance.

Timeouts RdsInstanceV3Timeouts

AvailabilityZone []string

Specifies the AZ name. Changing this parameter will create a new resource.

Db RdsInstanceV3DbArgs

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

Flavor string

SecurityGroupId string

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

SubnetId string

Specifies the subnet id. Changing this parameter will create a new resource.

Volume RdsInstanceV3VolumeArgs

Specifies the volume information. Structure is documented below.

VpcId string

Specifies the VPC ID. Changing this parameter will create a new resource.

BackupStrategy RdsInstanceV3BackupStrategyArgs

Specifies the advanced backup policy. Structure is documented below.

HaReplicationMode string

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

LowerCaseTableNames string

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

Name string

ParamGroupId string

Specifies the parameter group ID.

Parameters map[string]string

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

PublicIps []string

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

RdsInstanceV3Id string

Indicates the node ID.

RestoreFromBackup RdsInstanceV3RestoreFromBackupArgs

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

RestorePoint RdsInstanceV3RestorePointArgs

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

SslEnable bool

Specifies whether SSL should be enabled for MySql instances.

Tag map[string]string

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

Tags map[string]string

Tags key/value pairs to associate with the instance.

Timeouts RdsInstanceV3TimeoutsArgs

availabilityZone List<String>

Specifies the AZ name. Changing this parameter will create a new resource.

db RdsInstanceV3Db

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

flavor String

securityGroupId String

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

subnetId String

Specifies the subnet id. Changing this parameter will create a new resource.

volume RdsInstanceV3Volume

Specifies the volume information. Structure is documented below.

vpcId String

Specifies the VPC ID. Changing this parameter will create a new resource.

backupStrategy RdsInstanceV3BackupStrategy

Specifies the advanced backup policy. Structure is documented below.

haReplicationMode String

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

lowerCaseTableNames String

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

name String

paramGroupId String

Specifies the parameter group ID.

parameters Map<String,String>

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

publicIps List<String>

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

rdsInstanceV3Id String

Indicates the node ID.

restoreFromBackup RdsInstanceV3RestoreFromBackup

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

restorePoint RdsInstanceV3RestorePoint

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

sslEnable Boolean

Specifies whether SSL should be enabled for MySql instances.

tag Map<String,String>

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

tags Map<String,String>

Tags key/value pairs to associate with the instance.

timeouts RdsInstanceV3Timeouts

availabilityZone string[]

Specifies the AZ name. Changing this parameter will create a new resource.

db RdsInstanceV3Db

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

flavor string

securityGroupId string

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

subnetId string

Specifies the subnet id. Changing this parameter will create a new resource.

volume RdsInstanceV3Volume

Specifies the volume information. Structure is documented below.

vpcId string

Specifies the VPC ID. Changing this parameter will create a new resource.

backupStrategy RdsInstanceV3BackupStrategy

Specifies the advanced backup policy. Structure is documented below.

haReplicationMode string

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

lowerCaseTableNames string

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

name string

paramGroupId string

Specifies the parameter group ID.

parameters {[key: string]: string}

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

publicIps string[]

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

rdsInstanceV3Id string

Indicates the node ID.

restoreFromBackup RdsInstanceV3RestoreFromBackup

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

restorePoint RdsInstanceV3RestorePoint

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

sslEnable boolean

Specifies whether SSL should be enabled for MySql instances.

tag {[key: string]: string}

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

tags {[key: string]: string}

Tags key/value pairs to associate with the instance.

timeouts RdsInstanceV3Timeouts

availability_zone Sequence[str]

Specifies the AZ name. Changing this parameter will create a new resource.

db RdsInstanceV3DbArgs

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

flavor str

security_group_id str

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

subnet_id str

Specifies the subnet id. Changing this parameter will create a new resource.

volume RdsInstanceV3VolumeArgs

Specifies the volume information. Structure is documented below.

vpc_id str

Specifies the VPC ID. Changing this parameter will create a new resource.

backup_strategy RdsInstanceV3BackupStrategyArgs

Specifies the advanced backup policy. Structure is documented below.

ha_replication_mode str

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

lower_case_table_names str

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

name str

param_group_id str

Specifies the parameter group ID.

parameters Mapping[str, str]

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

public_ips Sequence[str]

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

rds_instance_v3_id str

Indicates the node ID.

restore_from_backup RdsInstanceV3RestoreFromBackupArgs

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

restore_point RdsInstanceV3RestorePointArgs

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

ssl_enable bool

Specifies whether SSL should be enabled for MySql instances.

tag Mapping[str, str]

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

tags Mapping[str, str]

Tags key/value pairs to associate with the instance.

timeouts RdsInstanceV3TimeoutsArgs

availabilityZone List<String>

Specifies the AZ name. Changing this parameter will create a new resource.

db Property Map

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

flavor String

securityGroupId String

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

subnetId String

Specifies the subnet id. Changing this parameter will create a new resource.

volume Property Map

Specifies the volume information. Structure is documented below.

vpcId String

Specifies the VPC ID. Changing this parameter will create a new resource.

backupStrategy Property Map

Specifies the advanced backup policy. Structure is documented below.

haReplicationMode String

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

lowerCaseTableNames String

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

name String

paramGroupId String

Specifies the parameter group ID.

parameters Map<String>

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

publicIps List<String>

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

rdsInstanceV3Id String

Indicates the node ID.

restoreFromBackup Property Map

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

restorePoint Property Map

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

sslEnable Boolean

Specifies whether SSL should be enabled for MySql instances.

tag Map<String>

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

tags Map<String>

Tags key/value pairs to associate with the instance.

timeouts Property Map

Outputs

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

AutoscalingEnabled bool: Indicates whether autoscaling was enabled for this resource.
AvailabilityZones List<string>: Indicates the instance AZs.
Created string: Indicates the creation time.
Id string: The provider-assigned unique ID for this managed resource.
Nodes List<RdsInstanceV3Node>: Indicates the instance nodes information. Structure is documented below.
PrivateIps List<string>: Indicates the private IP address list. It is a blank string until an ECS is created.
RestoredBackupId string: Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

AutoscalingEnabled bool: Indicates whether autoscaling was enabled for this resource.
AvailabilityZones []string: Indicates the instance AZs.
Created string: Indicates the creation time.
Id string: The provider-assigned unique ID for this managed resource.
Nodes []RdsInstanceV3Node: Indicates the instance nodes information. Structure is documented below.
PrivateIps []string: Indicates the private IP address list. It is a blank string until an ECS is created.
RestoredBackupId string: Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

autoscalingEnabled Boolean: Indicates whether autoscaling was enabled for this resource.
availabilityZones List<String>: Indicates the instance AZs.
created String: Indicates the creation time.
id String: The provider-assigned unique ID for this managed resource.
nodes List<RdsInstanceV3Node>: Indicates the instance nodes information. Structure is documented below.
privateIps List<String>: Indicates the private IP address list. It is a blank string until an ECS is created.
restoredBackupId String: Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

autoscalingEnabled boolean: Indicates whether autoscaling was enabled for this resource.
availabilityZones string[]: Indicates the instance AZs.
created string: Indicates the creation time.
id string: The provider-assigned unique ID for this managed resource.
nodes RdsInstanceV3Node[]: Indicates the instance nodes information. Structure is documented below.
privateIps string[]: Indicates the private IP address list. It is a blank string until an ECS is created.
restoredBackupId string: Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

autoscaling_enabled bool: Indicates whether autoscaling was enabled for this resource.
availability_zones Sequence[str]: Indicates the instance AZs.
created str: Indicates the creation time.
id str: The provider-assigned unique ID for this managed resource.
nodes Sequence[RdsInstanceV3Node]: Indicates the instance nodes information. Structure is documented below.
private_ips Sequence[str]: Indicates the private IP address list. It is a blank string until an ECS is created.
restored_backup_id str: Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

autoscalingEnabled Boolean: Indicates whether autoscaling was enabled for this resource.
availabilityZones List<String>: Indicates the instance AZs.
created String: Indicates the creation time.
id String: The provider-assigned unique ID for this managed resource.
nodes List<Property Map>: Indicates the instance nodes information. Structure is documented below.
privateIps List<String>: Indicates the private IP address list. It is a blank string until an ECS is created.
restoredBackupId String: Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

Look up Existing RdsInstanceV3 Resource

Get an existing RdsInstanceV3 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?: RdsInstanceV3State, opts?: CustomResourceOptions): RdsInstanceV3

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autoscaling_enabled: Optional[bool] = None,
        availability_zone: Optional[Sequence[str]] = None,
        availability_zones: Optional[Sequence[str]] = None,
        backup_strategy: Optional[RdsInstanceV3BackupStrategyArgs] = None,
        created: Optional[str] = None,
        db: Optional[RdsInstanceV3DbArgs] = None,
        flavor: Optional[str] = None,
        ha_replication_mode: Optional[str] = None,
        lower_case_table_names: Optional[str] = None,
        name: Optional[str] = None,
        nodes: Optional[Sequence[RdsInstanceV3NodeArgs]] = None,
        param_group_id: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        private_ips: Optional[Sequence[str]] = None,
        public_ips: Optional[Sequence[str]] = None,
        rds_instance_v3_id: Optional[str] = None,
        restore_from_backup: Optional[RdsInstanceV3RestoreFromBackupArgs] = None,
        restore_point: Optional[RdsInstanceV3RestorePointArgs] = None,
        restored_backup_id: Optional[str] = None,
        security_group_id: Optional[str] = None,
        ssl_enable: Optional[bool] = None,
        subnet_id: Optional[str] = None,
        tag: Optional[Mapping[str, str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        timeouts: Optional[RdsInstanceV3TimeoutsArgs] = None,
        volume: Optional[RdsInstanceV3VolumeArgs] = None,
        vpc_id: Optional[str] = None) -> RdsInstanceV3

func GetRdsInstanceV3(ctx *Context, name string, id IDInput, state *RdsInstanceV3State, opts ...ResourceOption) (*RdsInstanceV3, error)

public static RdsInstanceV3 Get(string name, Input<string> id, RdsInstanceV3State? state, CustomResourceOptions? opts = null)

public static RdsInstanceV3 get(String name, Output<String> id, RdsInstanceV3State state, CustomResourceOptions options)

resources:  _:    type: opentelekomcloud:RdsInstanceV3    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:

AutoscalingEnabled bool

Indicates whether autoscaling was enabled for this resource.

AvailabilityZone List<string>

Specifies the AZ name. Changing this parameter will create a new resource.

AvailabilityZones List<string>

Indicates the instance AZs.

BackupStrategy RdsInstanceV3BackupStrategy

Specifies the advanced backup policy. Structure is documented below.

Created string

Indicates the creation time.

Db RdsInstanceV3Db

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

Flavor string

HaReplicationMode string

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

LowerCaseTableNames string

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

Name string

Nodes List<RdsInstanceV3Node>

Indicates the instance nodes information. Structure is documented below.

ParamGroupId string

Specifies the parameter group ID.

Parameters Dictionary<string, string>

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

PrivateIps List<string>

Indicates the private IP address list. It is a blank string until an ECS is created.

PublicIps List<string>

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

RdsInstanceV3Id string

Indicates the node ID.

RestoreFromBackup RdsInstanceV3RestoreFromBackup

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

RestorePoint RdsInstanceV3RestorePoint

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

RestoredBackupId string

Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

SecurityGroupId string

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

SslEnable bool

Specifies whether SSL should be enabled for MySql instances.

SubnetId string

Specifies the subnet id. Changing this parameter will create a new resource.

Tag Dictionary<string, string>

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

Tags Dictionary<string, string>

Tags key/value pairs to associate with the instance.

Timeouts RdsInstanceV3Timeouts

Volume RdsInstanceV3Volume

Specifies the volume information. Structure is documented below.

VpcId string

Specifies the VPC ID. Changing this parameter will create a new resource.

AutoscalingEnabled bool

Indicates whether autoscaling was enabled for this resource.

AvailabilityZone []string

Specifies the AZ name. Changing this parameter will create a new resource.

AvailabilityZones []string

Indicates the instance AZs.

BackupStrategy RdsInstanceV3BackupStrategyArgs

Specifies the advanced backup policy. Structure is documented below.

Created string

Indicates the creation time.

Db RdsInstanceV3DbArgs

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

Flavor string

HaReplicationMode string

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

LowerCaseTableNames string

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

Name string

Nodes []RdsInstanceV3NodeArgs

Indicates the instance nodes information. Structure is documented below.

ParamGroupId string

Specifies the parameter group ID.

Parameters map[string]string

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

PrivateIps []string

Indicates the private IP address list. It is a blank string until an ECS is created.

PublicIps []string

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

RdsInstanceV3Id string

Indicates the node ID.

RestoreFromBackup RdsInstanceV3RestoreFromBackupArgs

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

RestorePoint RdsInstanceV3RestorePointArgs

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

RestoredBackupId string

Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

SecurityGroupId string

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

SslEnable bool

Specifies whether SSL should be enabled for MySql instances.

SubnetId string

Specifies the subnet id. Changing this parameter will create a new resource.

Tag map[string]string

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

Tags map[string]string

Tags key/value pairs to associate with the instance.

Timeouts RdsInstanceV3TimeoutsArgs

Volume RdsInstanceV3VolumeArgs

Specifies the volume information. Structure is documented below.

VpcId string

Specifies the VPC ID. Changing this parameter will create a new resource.

autoscalingEnabled Boolean

Indicates whether autoscaling was enabled for this resource.

availabilityZone List<String>

Specifies the AZ name. Changing this parameter will create a new resource.

availabilityZones List<String>

Indicates the instance AZs.

backupStrategy RdsInstanceV3BackupStrategy

Specifies the advanced backup policy. Structure is documented below.

created String

Indicates the creation time.

db RdsInstanceV3Db

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

flavor String

haReplicationMode String

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

lowerCaseTableNames String

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

name String

nodes List<RdsInstanceV3Node>

Indicates the instance nodes information. Structure is documented below.

paramGroupId String

Specifies the parameter group ID.

parameters Map<String,String>

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

privateIps List<String>

Indicates the private IP address list. It is a blank string until an ECS is created.

publicIps List<String>

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

rdsInstanceV3Id String

Indicates the node ID.

restoreFromBackup RdsInstanceV3RestoreFromBackup

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

restorePoint RdsInstanceV3RestorePoint

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

restoredBackupId String

Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

securityGroupId String

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

sslEnable Boolean

Specifies whether SSL should be enabled for MySql instances.

subnetId String

Specifies the subnet id. Changing this parameter will create a new resource.

tag Map<String,String>

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

tags Map<String,String>

Tags key/value pairs to associate with the instance.

timeouts RdsInstanceV3Timeouts

volume RdsInstanceV3Volume

Specifies the volume information. Structure is documented below.

vpcId String

Specifies the VPC ID. Changing this parameter will create a new resource.

autoscalingEnabled boolean

Indicates whether autoscaling was enabled for this resource.

availabilityZone string[]

Specifies the AZ name. Changing this parameter will create a new resource.

availabilityZones string[]

Indicates the instance AZs.

backupStrategy RdsInstanceV3BackupStrategy

Specifies the advanced backup policy. Structure is documented below.

created string

Indicates the creation time.

db RdsInstanceV3Db

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

flavor string

haReplicationMode string

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

lowerCaseTableNames string

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

name string

nodes RdsInstanceV3Node[]

Indicates the instance nodes information. Structure is documented below.

paramGroupId string

Specifies the parameter group ID.

parameters {[key: string]: string}

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

privateIps string[]

Indicates the private IP address list. It is a blank string until an ECS is created.

publicIps string[]

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

rdsInstanceV3Id string

Indicates the node ID.

restoreFromBackup RdsInstanceV3RestoreFromBackup

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

restorePoint RdsInstanceV3RestorePoint

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

restoredBackupId string

Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

securityGroupId string

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

sslEnable boolean

Specifies whether SSL should be enabled for MySql instances.

subnetId string

Specifies the subnet id. Changing this parameter will create a new resource.

tag {[key: string]: string}

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

tags {[key: string]: string}

Tags key/value pairs to associate with the instance.

timeouts RdsInstanceV3Timeouts

volume RdsInstanceV3Volume

Specifies the volume information. Structure is documented below.

vpcId string

Specifies the VPC ID. Changing this parameter will create a new resource.

autoscaling_enabled bool

Indicates whether autoscaling was enabled for this resource.

availability_zone Sequence[str]

Specifies the AZ name. Changing this parameter will create a new resource.

availability_zones Sequence[str]

Indicates the instance AZs.

backup_strategy RdsInstanceV3BackupStrategyArgs

Specifies the advanced backup policy. Structure is documented below.

created str

Indicates the creation time.

db RdsInstanceV3DbArgs

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

flavor str

ha_replication_mode str

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

lower_case_table_names str

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

name str

nodes Sequence[RdsInstanceV3NodeArgs]

Indicates the instance nodes information. Structure is documented below.

param_group_id str

Specifies the parameter group ID.

parameters Mapping[str, str]

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

private_ips Sequence[str]

Indicates the private IP address list. It is a blank string until an ECS is created.

public_ips Sequence[str]

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

rds_instance_v3_id str

Indicates the node ID.

restore_from_backup RdsInstanceV3RestoreFromBackupArgs

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

restore_point RdsInstanceV3RestorePointArgs

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

restored_backup_id str

Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

security_group_id str

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

ssl_enable bool

Specifies whether SSL should be enabled for MySql instances.

subnet_id str

Specifies the subnet id. Changing this parameter will create a new resource.

tag Mapping[str, str]

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

tags Mapping[str, str]

Tags key/value pairs to associate with the instance.

timeouts RdsInstanceV3TimeoutsArgs

volume RdsInstanceV3VolumeArgs

Specifies the volume information. Structure is documented below.

vpc_id str

Specifies the VPC ID. Changing this parameter will create a new resource.

autoscalingEnabled Boolean

Indicates whether autoscaling was enabled for this resource.

availabilityZone List<String>

Specifies the AZ name. Changing this parameter will create a new resource.

availabilityZones List<String>

Indicates the instance AZs.

backupStrategy Property Map

Specifies the advanced backup policy. Structure is documented below.

created String

Indicates the creation time.

db Property Map

Specifies the database information. Structure is documented below. Changing this parameter will create a new resource.

flavor String

haReplicationMode String

async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode. Changing this parameter will create a new resource.

lowerCaseTableNames String

Specifies the case-sensitive state of the database table name, the default value is "1". Changing this parameter will create a new resource.

0: Table names are stored as fixed and table names are case-sensitive.
1: Table names will be stored in lower case and table names are not case-sensitive.

name String

nodes List<Property Map>

Indicates the instance nodes information. Structure is documented below.

paramGroupId String

Specifies the parameter group ID.

parameters Map<String>

Map of additional configuration parameters. Values should be strings. Parameters set here overrides values from configuration template (parameter group).

privateIps List<String>

Indicates the private IP address list. It is a blank string until an ECS is created.

publicIps List<String>

Specifies floating IP to be assigned to the instance. This should be a list with single element only.

Setting public IP is done with assigning floating IP to internally created port. So RDS itself doesn't know about this assignment. This assignment won't show on the console. This argument will be ignored in future when RDSv3 API for EIP assignment will be implemented.

rdsInstanceV3Id String

Indicates the node ID.

restoreFromBackup Property Map

DEPRECATED - (Optional) Specifies whether to restore database to an instance described in current resource. Structure is documented below. Please use alternative parameter restore_point.

Deprecated: Deprecated

restorePoint Property Map

Specifies the restoration information. By selecting this option you can either create a new RDS instance or restore backup from existing one. Structure is documented below.

restoredBackupId String

Indicates the backup ID in cases when instance was restored by using restore_from_backup block.

securityGroupId String

Specifies the security group which the RDS DB instance belongs to. Changing this parameter will create a new resource.

sslEnable Boolean

Specifies whether SSL should be enabled for MySql instances.

subnetId String

Specifies the subnet id. Changing this parameter will create a new resource.

tag Map<String>

Tags key/value pairs to associate with the instance. Deprecated, please use the tags instead.

Deprecated: Deprecated

tags Map<String>

Tags key/value pairs to associate with the instance.

timeouts Property Map

volume Property Map

Specifies the volume information. Structure is documented below.

vpcId String

Specifies the VPC ID. Changing this parameter will create a new resource.

Supporting Types

RdsInstanceV3BackupStrategy, RdsInstanceV3BackupStrategyArgs

StartTime string: Specifies the backup time window. Automated backups will be triggered during the backup time window. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00.
KeepDays double: Specifies the retention days for specific backup files. The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. NOTICE: Primary/standby DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
Period string: Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. This parameter is mandatory except that the automated backup policy is disabled. Value range: The value is digits separated by commas (,), indicating the day of the week and starting from Monday. For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

StartTime string: Specifies the backup time window. Automated backups will be triggered during the backup time window. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00.
KeepDays float64: Specifies the retention days for specific backup files. The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. NOTICE: Primary/standby DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
Period string: Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. This parameter is mandatory except that the automated backup policy is disabled. Value range: The value is digits separated by commas (,), indicating the day of the week and starting from Monday. For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

startTime String: Specifies the backup time window. Automated backups will be triggered during the backup time window. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00.
keepDays Double: Specifies the retention days for specific backup files. The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. NOTICE: Primary/standby DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
period String: Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. This parameter is mandatory except that the automated backup policy is disabled. Value range: The value is digits separated by commas (,), indicating the day of the week and starting from Monday. For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

startTime string: Specifies the backup time window. Automated backups will be triggered during the backup time window. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00.
keepDays number: Specifies the retention days for specific backup files. The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. NOTICE: Primary/standby DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
period string: Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. This parameter is mandatory except that the automated backup policy is disabled. Value range: The value is digits separated by commas (,), indicating the day of the week and starting from Monday. For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

start_time str: Specifies the backup time window. Automated backups will be triggered during the backup time window. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00.
keep_days float: Specifies the retention days for specific backup files. The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. NOTICE: Primary/standby DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
period str: Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. This parameter is mandatory except that the automated backup policy is disabled. Value range: The value is digits separated by commas (,), indicating the day of the week and starting from Monday. For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

startTime String: Specifies the backup time window. Automated backups will be triggered during the backup time window. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00.
keepDays Number: Specifies the retention days for specific backup files. The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. NOTICE: Primary/standby DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
period String: Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. This parameter is mandatory except that the automated backup policy is disabled. Value range: The value is digits separated by commas (,), indicating the day of the week and starting from Monday. For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

RdsInstanceV3Db, RdsInstanceV3DbArgs

Password string

Specifies the database password. The value cannot be empty and should contain 8 to 32 characters, including uppercase and lowercase letters, digits, and the following special characters: ~!@#%^*-_=+? You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking. Changing this parameter will create a new resource.

Port double

Specifies the database port information. The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used). The PostgreSQL database port ranges from 2100 to 9500. The Microsoft SQL Server database port can be 1433 or ranges from 2100 to 9500, excluding 5355 and 5985. If this parameter is not set, the default value is as follows: For MySQL, the default value is 3306. For PostgreSQL, the default value is 5432. For Microsoft SQL Server, the default value is 1433. Changing this parameter will create a new resource.

Type string

Specifies the DB engine. Value: MySQL, PostgreSQL, SQLServer. Changing this parameter will create a new resource.

UserName string

Indicates the default user name of database.

Version string

Specifies the database version.

MySQL: 8.0, 5.7, and 5.6
PostgreSQL: 11 through 16
Microsoft SQL Server: 2017 (Enterprise/Standard) through 2022 (Enterprise/Standard) Changing this parameter will create a new resource.

Password string

Port float64

Type string

Specifies the DB engine. Value: MySQL, PostgreSQL, SQLServer. Changing this parameter will create a new resource.

UserName string

Indicates the default user name of database.

Version string

Specifies the database version.

MySQL: 8.0, 5.7, and 5.6
PostgreSQL: 11 through 16
Microsoft SQL Server: 2017 (Enterprise/Standard) through 2022 (Enterprise/Standard) Changing this parameter will create a new resource.

password String

port Double

type String

Specifies the DB engine. Value: MySQL, PostgreSQL, SQLServer. Changing this parameter will create a new resource.

userName String

Indicates the default user name of database.

version String

Specifies the database version.

MySQL: 8.0, 5.7, and 5.6
PostgreSQL: 11 through 16
Microsoft SQL Server: 2017 (Enterprise/Standard) through 2022 (Enterprise/Standard) Changing this parameter will create a new resource.

password string

port number

type string

Specifies the DB engine. Value: MySQL, PostgreSQL, SQLServer. Changing this parameter will create a new resource.

userName string

Indicates the default user name of database.

version string

Specifies the database version.

MySQL: 8.0, 5.7, and 5.6
PostgreSQL: 11 through 16
Microsoft SQL Server: 2017 (Enterprise/Standard) through 2022 (Enterprise/Standard) Changing this parameter will create a new resource.

password str

port float

type str

Specifies the DB engine. Value: MySQL, PostgreSQL, SQLServer. Changing this parameter will create a new resource.

user_name str

Indicates the default user name of database.

version str

Specifies the database version.

MySQL: 8.0, 5.7, and 5.6
PostgreSQL: 11 through 16
Microsoft SQL Server: 2017 (Enterprise/Standard) through 2022 (Enterprise/Standard) Changing this parameter will create a new resource.

password String

port Number

type String

Specifies the DB engine. Value: MySQL, PostgreSQL, SQLServer. Changing this parameter will create a new resource.

userName String

Indicates the default user name of database.

version String

Specifies the database version.

MySQL: 8.0, 5.7, and 5.6
PostgreSQL: 11 through 16
Microsoft SQL Server: 2017 (Enterprise/Standard) through 2022 (Enterprise/Standard) Changing this parameter will create a new resource.

RdsInstanceV3Node, RdsInstanceV3NodeArgs

AvailabilityZone string: Specifies the AZ name. Changing this parameter will create a new resource.
Id string: Indicates the node ID.
Name string: Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).
Role string: Indicates the node type. The value can be master or slave, indicating the primary node or standby node respectively.
Status string: Indicates the node status.

AvailabilityZone string: Specifies the AZ name. Changing this parameter will create a new resource.
Id string: Indicates the node ID.
Name string: Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).
Role string: Indicates the node type. The value can be master or slave, indicating the primary node or standby node respectively.
Status string: Indicates the node status.

availabilityZone String: Specifies the AZ name. Changing this parameter will create a new resource.
id String: Indicates the node ID.
name String: Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).
role String: Indicates the node type. The value can be master or slave, indicating the primary node or standby node respectively.
status String: Indicates the node status.

availabilityZone string: Specifies the AZ name. Changing this parameter will create a new resource.
id string: Indicates the node ID.
name string: Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).
role string: Indicates the node type. The value can be master or slave, indicating the primary node or standby node respectively.
status string: Indicates the node status.

availability_zone str: Specifies the AZ name. Changing this parameter will create a new resource.
id str: Indicates the node ID.
name str: Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).
role str: Indicates the node type. The value can be master or slave, indicating the primary node or standby node respectively.
status str: Indicates the node status.

availabilityZone String: Specifies the AZ name. Changing this parameter will create a new resource.
id String: Indicates the node ID.
name String: Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).
role String: Indicates the node type. The value can be master or slave, indicating the primary node or standby node respectively.
status String: Indicates the node status.

RdsInstanceV3RestoreFromBackup, RdsInstanceV3RestoreFromBackupArgs

SourceInstanceId string: Specifies the source instance ID.
Type string: Specifies the restoration mode. The values can be:
BackupId string: Specifies the ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration.
RestoreTime double: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

SourceInstanceId string: Specifies the source instance ID.
Type string: Specifies the restoration mode. The values can be:
BackupId string: Specifies the ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration.
RestoreTime float64: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

sourceInstanceId String: Specifies the source instance ID.
type String: Specifies the restoration mode. The values can be:
backupId String: Specifies the ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration.
restoreTime Double: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

sourceInstanceId string: Specifies the source instance ID.
type string: Specifies the restoration mode. The values can be:
backupId string: Specifies the ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration.
restoreTime number: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

source_instance_id str: Specifies the source instance ID.
type str: Specifies the restoration mode. The values can be:
backup_id str: Specifies the ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration.
restore_time float: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

sourceInstanceId String: Specifies the source instance ID.
type String: Specifies the restoration mode. The values can be:
backupId String: Specifies the ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration.
restoreTime Number: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

RdsInstanceV3RestorePoint, RdsInstanceV3RestorePointArgs

InstanceId string: Specifies the original DB instance ID.
BackupId string: Specifies the ID of the backup used to restore data.
RestoreTime double: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

InstanceId string: Specifies the original DB instance ID.
BackupId string: Specifies the ID of the backup used to restore data.
RestoreTime float64: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

instanceId String: Specifies the original DB instance ID.
backupId String: Specifies the ID of the backup used to restore data.
restoreTime Double: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

instanceId string: Specifies the original DB instance ID.
backupId string: Specifies the ID of the backup used to restore data.
restoreTime number: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

instance_id str: Specifies the original DB instance ID.
backup_id str: Specifies the ID of the backup used to restore data.
restore_time float: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

instanceId String: Specifies the original DB instance ID.
backupId String: Specifies the ID of the backup used to restore data.
restoreTime Number: Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Exactly one of backup_id and restore_time needs to be set.

RdsInstanceV3Timeouts, RdsInstanceV3TimeoutsArgs

Create string
Update string

Create string
Update string

create String
update String

create string
update string

create str
update str

create String
update String

RdsInstanceV3Volume, RdsInstanceV3VolumeArgs

Size double

Specifies the volume size. Its value range is from 40 GB to 4000 GB. The value must be a multiple of 10. Changing this resize the volume.

Type string

Specifies the volume type. Changing this resize the volume. Its value can be any of the following and is case-sensitive:

COMMON: SATA storage.
ULTRAHIGH: ultra-high I/O storage.
CLOUDSSD: cloud SSD storage.
ESSD: extreme SSD storage.

Note The MySQL and PostgreSQL DB engines support the following volume types: CLOUDSSD and ESSD. ESSD is not supported for Single instance types for MySQL and PostgreSQL. The SQL Server engine supports the following volume types: COMMON, ULTRAHIGH, and ESSD.

Warning Specifying both limit_size and trigger_threshold will enable autoscaling for RDS instance. Once autoscaling is activated, the size parameter for the volume will be ignored to prevent discrepancies between configuration and actual state.

DiskEncryptionId string

Specifies the key ID for disk encryption. Changing this parameter will create a new resource.

LimitSize double

Specifies the upper limit of automatic expansion of storage, in GB. The value ranges from 40 GB to 4,000 GB and must be no less than the current storage of the instance. If this parameter is configured, trigger_threshold is mandatory.

TriggerThreshold double

Specifies the threshold to trigger automatic expansion. If this parameter is configured, limit_size is mandatory. If the available storage drops to this threshold or 10 GB, the automatic expansion is triggered. The valid values are as follows:

Size float64

Specifies the volume size. Its value range is from 40 GB to 4000 GB. The value must be a multiple of 10. Changing this resize the volume.

Type string

Specifies the volume type. Changing this resize the volume. Its value can be any of the following and is case-sensitive:

COMMON: SATA storage.
ULTRAHIGH: ultra-high I/O storage.
CLOUDSSD: cloud SSD storage.
ESSD: extreme SSD storage.

Note The MySQL and PostgreSQL DB engines support the following volume types: CLOUDSSD and ESSD. ESSD is not supported for Single instance types for MySQL and PostgreSQL. The SQL Server engine supports the following volume types: COMMON, ULTRAHIGH, and ESSD.

Warning Specifying both limit_size and trigger_threshold will enable autoscaling for RDS instance. Once autoscaling is activated, the size parameter for the volume will be ignored to prevent discrepancies between configuration and actual state.

DiskEncryptionId string

Specifies the key ID for disk encryption. Changing this parameter will create a new resource.

LimitSize float64

TriggerThreshold float64

size Double

Specifies the volume size. Its value range is from 40 GB to 4000 GB. The value must be a multiple of 10. Changing this resize the volume.

type String

Specifies the volume type. Changing this resize the volume. Its value can be any of the following and is case-sensitive:

COMMON: SATA storage.
ULTRAHIGH: ultra-high I/O storage.
CLOUDSSD: cloud SSD storage.
ESSD: extreme SSD storage.

Note The MySQL and PostgreSQL DB engines support the following volume types: CLOUDSSD and ESSD. ESSD is not supported for Single instance types for MySQL and PostgreSQL. The SQL Server engine supports the following volume types: COMMON, ULTRAHIGH, and ESSD.

Warning Specifying both limit_size and trigger_threshold will enable autoscaling for RDS instance. Once autoscaling is activated, the size parameter for the volume will be ignored to prevent discrepancies between configuration and actual state.

diskEncryptionId String

Specifies the key ID for disk encryption. Changing this parameter will create a new resource.

limitSize Double

triggerThreshold Double

size number

Specifies the volume size. Its value range is from 40 GB to 4000 GB. The value must be a multiple of 10. Changing this resize the volume.

type string

Specifies the volume type. Changing this resize the volume. Its value can be any of the following and is case-sensitive:

COMMON: SATA storage.
ULTRAHIGH: ultra-high I/O storage.
CLOUDSSD: cloud SSD storage.
ESSD: extreme SSD storage.

Note The MySQL and PostgreSQL DB engines support the following volume types: CLOUDSSD and ESSD. ESSD is not supported for Single instance types for MySQL and PostgreSQL. The SQL Server engine supports the following volume types: COMMON, ULTRAHIGH, and ESSD.

Warning Specifying both limit_size and trigger_threshold will enable autoscaling for RDS instance. Once autoscaling is activated, the size parameter for the volume will be ignored to prevent discrepancies between configuration and actual state.

diskEncryptionId string

Specifies the key ID for disk encryption. Changing this parameter will create a new resource.

limitSize number

triggerThreshold number

size float

Specifies the volume size. Its value range is from 40 GB to 4000 GB. The value must be a multiple of 10. Changing this resize the volume.

type str

Specifies the volume type. Changing this resize the volume. Its value can be any of the following and is case-sensitive:

COMMON: SATA storage.
ULTRAHIGH: ultra-high I/O storage.
CLOUDSSD: cloud SSD storage.
ESSD: extreme SSD storage.

Note The MySQL and PostgreSQL DB engines support the following volume types: CLOUDSSD and ESSD. ESSD is not supported for Single instance types for MySQL and PostgreSQL. The SQL Server engine supports the following volume types: COMMON, ULTRAHIGH, and ESSD.

Warning Specifying both limit_size and trigger_threshold will enable autoscaling for RDS instance. Once autoscaling is activated, the size parameter for the volume will be ignored to prevent discrepancies between configuration and actual state.

disk_encryption_id str

Specifies the key ID for disk encryption. Changing this parameter will create a new resource.

limit_size float

trigger_threshold float

size Number

Specifies the volume size. Its value range is from 40 GB to 4000 GB. The value must be a multiple of 10. Changing this resize the volume.

type String

Specifies the volume type. Changing this resize the volume. Its value can be any of the following and is case-sensitive:

COMMON: SATA storage.
ULTRAHIGH: ultra-high I/O storage.
CLOUDSSD: cloud SSD storage.
ESSD: extreme SSD storage.

Note The MySQL and PostgreSQL DB engines support the following volume types: CLOUDSSD and ESSD. ESSD is not supported for Single instance types for MySQL and PostgreSQL. The SQL Server engine supports the following volume types: COMMON, ULTRAHIGH, and ESSD.

Warning Specifying both limit_size and trigger_threshold will enable autoscaling for RDS instance. Once autoscaling is activated, the size parameter for the volume will be ignored to prevent discrepancies between configuration and actual state.

diskEncryptionId String

Specifies the key ID for disk encryption. Changing this parameter will create a new resource.

limitSize Number

triggerThreshold Number

Import

RDS instance can be imported using the id, e.g.

$ pulumi import opentelekomcloud:index/rdsInstanceV3:RdsInstanceV3 instance_1 7117d38e-4c8f-4624-a505-bd96b97d024c

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

Package Details

Repository: opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
License
Notes: This Pulumi package is based on the opentelekomcloud Terraform Provider.

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.RdsInstanceV3

On this page

On this page

Example Usage

Create a single db instance

Create a primary/standby db instance

Create a db instance with public IP

Create a single db instance with encrypted volume

Overriding parameters from template

Restore backup to a new instance

Notes

Create RdsInstanceV3 Resource

Constructor syntax

Parameters

Constructor example

RdsInstanceV3 Resource Properties

Inputs

Outputs

Look up Existing RdsInstanceV3 Resource

Supporting Types

RdsInstanceV3BackupStrategy, RdsInstanceV3BackupStrategyArgs

RdsInstanceV3Db, RdsInstanceV3DbArgs

RdsInstanceV3Node, RdsInstanceV3NodeArgs

RdsInstanceV3RestoreFromBackup, RdsInstanceV3RestoreFromBackupArgs

RdsInstanceV3RestorePoint, RdsInstanceV3RestorePointArgs

RdsInstanceV3Timeouts, RdsInstanceV3TimeoutsArgs

RdsInstanceV3Volume, RdsInstanceV3VolumeArgs

Import

Package Details

On this page

On this page