@huaweicloudos/pulumi/gaussdb/getMysqlInstance.d.ts

A Pulumi package for creating and managing Huaweicloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "../types";
/**
 * Use this data source to get available HuaweiCloud gaussdb mysql instance.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as huaweicloud from "@pulumi/huaweicloud";
 *
 * const thisMysqlInstance = pulumi.output(huaweicloud.GaussDB.getMysqlInstance({
 *     name: "gaussdb-instance",
 * }));
 * ```
 */
export declare function getMysqlInstance(args?: GetMysqlInstanceArgs, opts?: pulumi.InvokeOptions): Promise<GetMysqlInstanceResult>;
/**
 * A collection of arguments for invoking getMysqlInstance.
 */
export interface GetMysqlInstanceArgs {
    /**
     * Specifies the name of the instance.
     */
    name?: string;
    /**
     * The region in which to obtain the instance. If omitted, the provider-level region will
     * be used.
     */
    region?: string;
    /**
     * Specifies the network ID of a subnet.
     */
    subnetId?: string;
    /**
     * Specifies the VPC ID.
     */
    vpcId?: string;
}
/**
 * A collection of values returned by getMysqlInstance.
 */
export interface GetMysqlInstanceResult {
    /**
     * Indicates the availability zone mode: "single" or "multi".
     */
    readonly availabilityZoneMode: string;
    /**
     * Indicates the advanced backup policy. Structure is documented below.
     */
    readonly backupStrategies: outputs.GaussDB.GetMysqlInstanceBackupStrategy[];
    /**
     * Indicates the configuration ID.
     */
    readonly configurationId: string;
    /**
     * Indicates the database information. Structure is documented below.
     */
    readonly datastores: outputs.GaussDB.GetMysqlInstanceDatastore[];
    /**
     * Indicates the default username.
     */
    readonly dbUserName: string;
    /**
     * Indicates the enterprise project id.
     */
    readonly enterpriseProjectId: string;
    /**
     * Indicates the instance specifications.
     */
    readonly flavor: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Indicates the availability zone where the master node resides.
     */
    readonly masterAvailabilityZone: string;
    /**
     * Indicates the instance mode.
     */
    readonly mode: string;
    /**
     * Indicates the node name.
     */
    readonly name: string;
    /**
     * Indicates the instance nodes information. Structure is documented below.
     */
    readonly nodes: outputs.GaussDB.GetMysqlInstanceNode[];
    /**
     * Indicates the database port.
     */
    readonly port: number;
    /**
     * Indicates the private IP address of the DB instance.
     */
    readonly privateWriteIp: string;
    /**
     * Indicates the count of read replicas.
     */
    readonly readReplicas: number;
    readonly region: string;
    /**
     * Indicates the security group ID.
     */
    readonly securityGroupId: string;
    /**
     * Indicates the node status.
     */
    readonly status: string;
    readonly subnetId: string;
    /**
     * Indicates the time zone.
     */
    readonly timeZone: string;
    readonly vpcId: string;
}
export declare function getMysqlInstanceOutput(args?: GetMysqlInstanceOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetMysqlInstanceResult>;
/**
 * A collection of arguments for invoking getMysqlInstance.
 */
export interface GetMysqlInstanceOutputArgs {
    /**
     * Specifies the name of the instance.
     */
    name?: pulumi.Input<string>;
    /**
     * The region in which to obtain the instance. If omitted, the provider-level region will
     * be used.
     */
    region?: pulumi.Input<string>;
    /**
     * Specifies the network ID of a subnet.
     */
    subnetId?: pulumi.Input<string>;
    /**
     * Specifies the VPC ID.
     */
    vpcId?: pulumi.Input<string>;
}