UNPKG

@volcengine/pulumi

Version:

A Pulumi package for creating and managing volcengine cloud resources.

328 lines (327 loc) 9.63 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Use this data source to query detailed information of rds mysql instances * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcengine from "@pulumi/volcengine"; * import * as volcengine from "@volcengine/pulumi"; * * const fooZones = volcengine.ecs.getZones({}); * 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 fooInstances = volcengine.rds_mysql.getInstancesOutput({ * instanceId: fooInstance.id, * }); * ``` */ /** @deprecated volcengine.rds_mysql.Instances has been deprecated in favor of volcengine.rds_mysql.getInstances */ export declare function instances(args?: InstancesArgs, opts?: pulumi.InvokeOptions): Promise<InstancesResult>; /** * A collection of arguments for invoking Instances. */ export interface InstancesArgs { /** * The charge type of the RDS instance. */ chargeType?: string; /** * The end time of creating RDS instance. */ createTimeEnd?: string; /** * The start time of creating RDS instance. */ createTimeStart?: string; /** * The version of the RDS instance. */ dbEngineVersion?: string; /** * The id of the RDS instance. */ instanceId?: string; /** * The name of the RDS instance. */ instanceName?: string; /** * The status of the RDS instance. */ instanceStatus?: string; /** * Instance type. The value is DoubleNode. */ instanceType?: string; /** * The kernel version of the instance. */ kernelVersions?: string[]; /** * A Name Regex of RDS instance. */ nameRegex?: string; /** * Primary node specification. For detailed information about the node specifications, please refer to Product Specifications. */ nodeSpec?: string; /** * File name where to save data source results. */ outputFile?: string; /** * The IP address of the instance's default terminal, used to query the instance by IP address. */ privateNetworkIpAddress?: string; /** * The ID of the private network. Instances using the specified private network can be filtered by this field. */ privateNetworkVpcId?: string; /** * The project name of the RDS instance. */ projectName?: string; /** * Instance storage type. The value is LocalSSD, indicating a local SSD disk. */ storageType?: string; /** * Tags. */ tags?: inputs.rds_mysql.InstancesTag[]; /** * The available zone of the RDS instance. */ zoneId?: string; } /** * A collection of values returned by Instances. */ export interface InstancesResult { /** * Payment type. Value: * PostPaid - Pay-As-You-Go * PrePaid - Yearly and monthly (default). */ readonly chargeType?: string; readonly createTimeEnd?: string; readonly createTimeStart?: string; /** * The engine version of the RDS instance. */ readonly dbEngineVersion?: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * Instance ID. */ readonly instanceId?: string; /** * The name of the RDS instance. */ readonly instanceName?: string; /** * The status of the RDS instance. */ readonly instanceStatus?: string; readonly instanceType?: string; /** * The current kernel version of the RDS instance. */ readonly kernelVersions?: string[]; readonly nameRegex?: string; /** * General instance type, different from Custom instance type. */ readonly nodeSpec?: string; readonly outputFile?: string; readonly privateNetworkIpAddress?: string; readonly privateNetworkVpcId?: string; /** * The project name of the RDS instance. */ readonly projectName?: string; /** * The collection of RDS instance query. */ readonly rdsMysqlInstances: outputs.rds_mysql.InstancesRdsMysqlInstance[]; /** * Instance storage type. */ readonly storageType?: string; /** * Tags. */ readonly tags?: outputs.rds_mysql.InstancesTag[]; /** * The total count of RDS instance query. */ readonly totalCount: number; /** * The available zone of the RDS instance. */ readonly zoneId?: string; } /** * Use this data source to query detailed information of rds mysql instances * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcengine from "@pulumi/volcengine"; * import * as volcengine from "@volcengine/pulumi"; * * const fooZones = volcengine.ecs.getZones({}); * 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 fooInstances = volcengine.rds_mysql.getInstancesOutput({ * instanceId: fooInstance.id, * }); * ``` */ /** @deprecated volcengine.rds_mysql.Instances has been deprecated in favor of volcengine.rds_mysql.getInstances */ export declare function instancesOutput(args?: InstancesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<InstancesResult>; /** * A collection of arguments for invoking Instances. */ export interface InstancesOutputArgs { /** * The charge type of the RDS instance. */ chargeType?: pulumi.Input<string>; /** * The end time of creating RDS instance. */ createTimeEnd?: pulumi.Input<string>; /** * The start time of creating RDS instance. */ createTimeStart?: pulumi.Input<string>; /** * The version of the RDS instance. */ dbEngineVersion?: pulumi.Input<string>; /** * The id of the RDS instance. */ instanceId?: pulumi.Input<string>; /** * The name of the RDS instance. */ instanceName?: pulumi.Input<string>; /** * The status of the RDS instance. */ instanceStatus?: pulumi.Input<string>; /** * Instance type. The value is DoubleNode. */ instanceType?: pulumi.Input<string>; /** * The kernel version of the instance. */ kernelVersions?: pulumi.Input<pulumi.Input<string>[]>; /** * A Name Regex of RDS instance. */ nameRegex?: pulumi.Input<string>; /** * Primary node specification. For detailed information about the node specifications, please refer to Product Specifications. */ nodeSpec?: pulumi.Input<string>; /** * File name where to save data source results. */ outputFile?: pulumi.Input<string>; /** * The IP address of the instance's default terminal, used to query the instance by IP address. */ privateNetworkIpAddress?: pulumi.Input<string>; /** * The ID of the private network. Instances using the specified private network can be filtered by this field. */ privateNetworkVpcId?: pulumi.Input<string>; /** * The project name of the RDS instance. */ projectName?: pulumi.Input<string>; /** * Instance storage type. The value is LocalSSD, indicating a local SSD disk. */ storageType?: pulumi.Input<string>; /** * Tags. */ tags?: pulumi.Input<pulumi.Input<inputs.rds_mysql.InstancesTagArgs>[]>; /** * The available zone of the RDS instance. */ zoneId?: pulumi.Input<string>; }