1. Packages
  2. Volcengine
  3. API Docs
  4. rds_mysql
  5. Database
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

volcengine.rds_mysql.Database

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

    Provides a resource to manage rds mysql database

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var fooZones = Volcengine.Ecs.Zones.Invoke();
    
        var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
        {
            VpcName = "acc-test-project1",
            CidrBlock = "172.16.0.0/16",
        });
    
        var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
        {
            SubnetName = "acc-subnet-test-2",
            CidrBlock = "172.16.0.0/24",
            ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
            VpcId = fooVpc.Id,
        });
    
        var fooInstance = new Volcengine.Rds_mysql.Instance("fooInstance", new()
        {
            DbEngineVersion = "MySQL_5_7",
            NodeSpec = "rds.mysql.1c2g",
            PrimaryZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
            SecondaryZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
            StorageSpace = 80,
            SubnetId = fooSubnet.Id,
            InstanceName = "acc-test",
            LowerCaseTableNames = "1",
            ChargeInfo = new Volcengine.Rds_mysql.Inputs.InstanceChargeInfoArgs
            {
                ChargeType = "PostPaid",
            },
            Parameters = new[]
            {
                new Volcengine.Rds_mysql.Inputs.InstanceParameterArgs
                {
                    ParameterName = "auto_increment_increment",
                    ParameterValue = "2",
                },
                new Volcengine.Rds_mysql.Inputs.InstanceParameterArgs
                {
                    ParameterName = "auto_increment_offset",
                    ParameterValue = "4",
                },
            },
        });
    
        var fooDatabase = new Volcengine.Rds_mysql.Database("fooDatabase", new()
        {
            DbName = "acc-test",
            InstanceId = fooInstance.Id,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_mysql"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		fooZones, err := ecs.Zones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
    			VpcName:   pulumi.String("acc-test-project1"),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
    			SubnetName: pulumi.String("acc-subnet-test-2"),
    			CidrBlock:  pulumi.String("172.16.0.0/24"),
    			ZoneId:     *pulumi.String(fooZones.Zones[0].Id),
    			VpcId:      fooVpc.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		fooInstance, err := rds_mysql.NewInstance(ctx, "fooInstance", &rds_mysql.InstanceArgs{
    			DbEngineVersion:     pulumi.String("MySQL_5_7"),
    			NodeSpec:            pulumi.String("rds.mysql.1c2g"),
    			PrimaryZoneId:       *pulumi.String(fooZones.Zones[0].Id),
    			SecondaryZoneId:     *pulumi.String(fooZones.Zones[0].Id),
    			StorageSpace:        pulumi.Int(80),
    			SubnetId:            fooSubnet.ID(),
    			InstanceName:        pulumi.String("acc-test"),
    			LowerCaseTableNames: pulumi.String("1"),
    			ChargeInfo: &rds_mysql.InstanceChargeInfoArgs{
    				ChargeType: pulumi.String("PostPaid"),
    			},
    			Parameters: rds_mysql.InstanceParameterArray{
    				&rds_mysql.InstanceParameterArgs{
    					ParameterName:  pulumi.String("auto_increment_increment"),
    					ParameterValue: pulumi.String("2"),
    				},
    				&rds_mysql.InstanceParameterArgs{
    					ParameterName:  pulumi.String("auto_increment_offset"),
    					ParameterValue: pulumi.String("4"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = rds_mysql.NewDatabase(ctx, "fooDatabase", &rds_mysql.DatabaseArgs{
    			DbName:     pulumi.String("acc-test"),
    			InstanceId: fooInstance.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.ecs.EcsFunctions;
    import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
    import com.pulumi.volcengine.vpc.Vpc;
    import com.pulumi.volcengine.vpc.VpcArgs;
    import com.pulumi.volcengine.vpc.Subnet;
    import com.pulumi.volcengine.vpc.SubnetArgs;
    import com.pulumi.volcengine.rds_mysql.Instance;
    import com.pulumi.volcengine.rds_mysql.InstanceArgs;
    import com.pulumi.volcengine.rds_mysql.inputs.InstanceChargeInfoArgs;
    import com.pulumi.volcengine.rds_mysql.inputs.InstanceParameterArgs;
    import com.pulumi.volcengine.rds_mysql.Database;
    import com.pulumi.volcengine.rds_mysql.DatabaseArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var fooZones = EcsFunctions.Zones();
    
            var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
                .vpcName("acc-test-project1")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
                .subnetName("acc-subnet-test-2")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
                .vpcId(fooVpc.id())
                .build());
    
            var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
                .dbEngineVersion("MySQL_5_7")
                .nodeSpec("rds.mysql.1c2g")
                .primaryZoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
                .secondaryZoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
                .storageSpace(80)
                .subnetId(fooSubnet.id())
                .instanceName("acc-test")
                .lowerCaseTableNames("1")
                .chargeInfo(InstanceChargeInfoArgs.builder()
                    .chargeType("PostPaid")
                    .build())
                .parameters(            
                    InstanceParameterArgs.builder()
                        .parameterName("auto_increment_increment")
                        .parameterValue("2")
                        .build(),
                    InstanceParameterArgs.builder()
                        .parameterName("auto_increment_offset")
                        .parameterValue("4")
                        .build())
                .build());
    
            var fooDatabase = new Database("fooDatabase", DatabaseArgs.builder()        
                .dbName("acc-test")
                .instanceId(fooInstance.id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo_zones = volcengine.ecs.zones()
    foo_vpc = volcengine.vpc.Vpc("fooVpc",
        vpc_name="acc-test-project1",
        cidr_block="172.16.0.0/16")
    foo_subnet = volcengine.vpc.Subnet("fooSubnet",
        subnet_name="acc-subnet-test-2",
        cidr_block="172.16.0.0/24",
        zone_id=foo_zones.zones[0].id,
        vpc_id=foo_vpc.id)
    foo_instance = volcengine.rds_mysql.Instance("fooInstance",
        db_engine_version="MySQL_5_7",
        node_spec="rds.mysql.1c2g",
        primary_zone_id=foo_zones.zones[0].id,
        secondary_zone_id=foo_zones.zones[0].id,
        storage_space=80,
        subnet_id=foo_subnet.id,
        instance_name="acc-test",
        lower_case_table_names="1",
        charge_info=volcengine.rds_mysql.InstanceChargeInfoArgs(
            charge_type="PostPaid",
        ),
        parameters=[
            volcengine.rds_mysql.InstanceParameterArgs(
                parameter_name="auto_increment_increment",
                parameter_value="2",
            ),
            volcengine.rds_mysql.InstanceParameterArgs(
                parameter_name="auto_increment_offset",
                parameter_value="4",
            ),
        ])
    foo_database = volcengine.rds_mysql.Database("fooDatabase",
        db_name="acc-test",
        instance_id=foo_instance.id)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    import * as volcengine from "@volcengine/pulumi";
    
    const fooZones = volcengine.ecs.Zones({});
    const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
        vpcName: "acc-test-project1",
        cidrBlock: "172.16.0.0/16",
    });
    const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
        subnetName: "acc-subnet-test-2",
        cidrBlock: "172.16.0.0/24",
        zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        vpcId: fooVpc.id,
    });
    const fooInstance = new volcengine.rds_mysql.Instance("fooInstance", {
        dbEngineVersion: "MySQL_5_7",
        nodeSpec: "rds.mysql.1c2g",
        primaryZoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        secondaryZoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        storageSpace: 80,
        subnetId: fooSubnet.id,
        instanceName: "acc-test",
        lowerCaseTableNames: "1",
        chargeInfo: {
            chargeType: "PostPaid",
        },
        parameters: [
            {
                parameterName: "auto_increment_increment",
                parameterValue: "2",
            },
            {
                parameterName: "auto_increment_offset",
                parameterValue: "4",
            },
        ],
    });
    const fooDatabase = new volcengine.rds_mysql.Database("fooDatabase", {
        dbName: "acc-test",
        instanceId: fooInstance.id,
    });
    
    resources:
      fooVpc:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-project1
          cidrBlock: 172.16.0.0/16
      fooSubnet:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-subnet-test-2
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[0].id}
          vpcId: ${fooVpc.id}
      fooInstance:
        type: volcengine:rds_mysql:Instance
        properties:
          dbEngineVersion: MySQL_5_7
          nodeSpec: rds.mysql.1c2g
          primaryZoneId: ${fooZones.zones[0].id}
          secondaryZoneId: ${fooZones.zones[0].id}
          storageSpace: 80
          subnetId: ${fooSubnet.id}
          instanceName: acc-test
          lowerCaseTableNames: '1'
          chargeInfo:
            chargeType: PostPaid
          parameters:
            - parameterName: auto_increment_increment
              parameterValue: '2'
            - parameterName: auto_increment_offset
              parameterValue: '4'
      fooDatabase:
        type: volcengine:rds_mysql:Database
        properties:
          dbName: acc-test
          instanceId: ${fooInstance.id}
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:Zones
          Arguments: {}
    

    Create Database Resource

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

    Constructor syntax

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def Database(resource_name: str,
                 args: DatabaseArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Database(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 db_name: Optional[str] = None,
                 instance_id: Optional[str] = None,
                 character_set_name: Optional[str] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
    public Database(String name, DatabaseArgs args, CustomResourceOptions options)
    
    type: volcengine:rds_mysql:Database
    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 DatabaseArgs
    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 DatabaseArgs
    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 DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var volcengineDatabaseResource = new Volcengine.Rds_mysql.Database("volcengineDatabaseResource", new()
    {
        DbName = "string",
        InstanceId = "string",
        CharacterSetName = "string",
    });
    
    example, err := rds_mysql.NewDatabase(ctx, "volcengineDatabaseResource", &rds_mysql.DatabaseArgs{
    	DbName:           pulumi.String("string"),
    	InstanceId:       pulumi.String("string"),
    	CharacterSetName: pulumi.String("string"),
    })
    
    var volcengineDatabaseResource = new Database("volcengineDatabaseResource", DatabaseArgs.builder()
        .dbName("string")
        .instanceId("string")
        .characterSetName("string")
        .build());
    
    volcengine_database_resource = volcengine.rds_mysql.Database("volcengineDatabaseResource",
        db_name="string",
        instance_id="string",
        character_set_name="string")
    
    const volcengineDatabaseResource = new volcengine.rds_mysql.Database("volcengineDatabaseResource", {
        dbName: "string",
        instanceId: "string",
        characterSetName: "string",
    });
    
    type: volcengine:rds_mysql:Database
    properties:
        characterSetName: string
        dbName: string
        instanceId: string
    

    Database Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Database resource accepts the following input properties:

    DbName string
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    InstanceId string
    The ID of the RDS instance.
    CharacterSetName string
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    DbName string
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    InstanceId string
    The ID of the RDS instance.
    CharacterSetName string
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    dbName String
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    instanceId String
    The ID of the RDS instance.
    characterSetName String
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    dbName string
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    instanceId string
    The ID of the RDS instance.
    characterSetName string
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    db_name str
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    instance_id str
    The ID of the RDS instance.
    character_set_name str
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    dbName String
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    instanceId String
    The ID of the RDS instance.
    characterSetName String
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Database Resource

    Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            character_set_name: Optional[str] = None,
            db_name: Optional[str] = None,
            instance_id: Optional[str] = None) -> Database
    func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
    public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
    public static Database get(String name, Output<String> id, DatabaseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CharacterSetName string
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    DbName string
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    InstanceId string
    The ID of the RDS instance.
    CharacterSetName string
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    DbName string
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    InstanceId string
    The ID of the RDS instance.
    characterSetName String
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    dbName String
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    instanceId String
    The ID of the RDS instance.
    characterSetName string
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    dbName string
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    instanceId string
    The ID of the RDS instance.
    character_set_name str
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    db_name str
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    instance_id str
    The ID of the RDS instance.
    characterSetName String
    Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
    dbName String
    Name database. illustrate: Unique name. The length is 2~64 characters. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, and underscores (_) or dashes (-). Database names are disabled keywords.
    instanceId String
    The ID of the RDS instance.

    Import

    Database can be imported using the instanceId:dbName, e.g.

     $ pulumi import volcengine:rds_mysql/database:Database default mysql-42b38c769c4b:dbname
    

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine