import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * The endpoint is a network proxy service provided by Cloud Database MySQL Edition, located between the database and application. Based on endpoint functionality, endpoints are classified as proxy endpoints and direct endpoints. Connections via proxy endpoints pass through the proxy and support features such as read/write splitting, load balancing, idle connection recycling, and Multi-Statements. Connections via direct endpoints connect directly to the corresponding node and do not support proxy-related features. * * ## Import * * ```sh * $ pulumi import volcenginecc:rdsmysql/endpoint:Endpoint example "instance_id|endpoint_id" * ``` */ export declare class Endpoint extends pulumi.CustomResource { /** * Get an existing Endpoint resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: EndpointState, opts?: pulumi.CustomResourceOptions): Endpoint; /** * Returns true if the given object is an instance of Endpoint. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Endpoint; readonly addresses: pulumi.Output; /** * When the endpoint type is read/write or read-only, you can set whether new nodes are automatically added. Values: true: automatically added. false: not automatically added (default). */ readonly autoAddNewNodes: pulumi.Output; /** * Associate all replica nodes. Values: true: enabled (default). false: disabled. Note: Only read-only endpoints of multi-node instances support this configuration. This feature can be disabled only if the instance has two or more replica nodes. */ readonly connectAllSlaveNodes: pulumi.Output; /** * Connection endpoint tags. */ readonly connectionInfoTags: pulumi.Output; /** * Endpoint type. Options: Proxy: proxy endpoint. Direct: direct endpoint. Note: If the database proxy feature is enabled for the instance, you can select Proxy or Direct. If the database proxy feature is not enabled, only Direct is available. You can call the DescribeDBInstanceDetail API to check the status of the database proxy feature for the instance. */ readonly connectionMode: pulumi.Output; /** * Connection pool type for proxy endpoints. Options: Transaction: transaction-level connection pool (default). Direct: direct mode. Note: Single-node instances do not support this feature. */ readonly connectionPoolType: pulumi.Output; /** * SQL forwarding rules for the connection endpoint. */ readonly customRouteStrategy: pulumi.Output; /** * Remarks. */ readonly description: pulumi.Output; /** * Enable connection keep-alive for the endpoint. Values: true: enabled. false: disabled. Note: Only proxy endpoints support this setting. */ readonly enableConnectionPersistent: pulumi.Output; /** * Enable global read-only. Values: Enable: enabled. Disable: not enabled. */ readonly enableReadOnly: pulumi.Output; /** * Instance connection endpoint ID. */ readonly endpointId: pulumi.Output; /** * Instance connection endpoint name. */ readonly endpointName: pulumi.Output; /** * Endpoint type. Value: Custom (custom endpoint). */ readonly endpointType: pulumi.Output; /** * Enable idle connection recycling. true: enabled. false: not enabled. Note: This field is returned only for proxy endpoints. */ readonly idleConnectionReclaim: pulumi.Output; /** * Enable transaction separation. Options: true: yes. false: no. Note: Only proxy endpoints return this field. */ readonly implicitTransSplit: pulumi.Output; /** * Instance ID. */ readonly instanceId: pulumi.Output; /** * Enable primary node routing. Values: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints. */ readonly masterNodeRouting: pulumi.Output; /** * Overload protection timeout. Value range: integer between 60~7200. Unit: seconds. Note: This field is returned only for proxy endpoints. */ readonly masterProtectorTimeout: pulumi.Output; /** * Multi-Statements mode for proxy endpoints. Options: Strict: strict mode (default). Loose: loose mode. */ readonly multiStatementsMode: pulumi.Output; /** * List of node IDs configured for the connection endpoint. Required when EndpointType is Custom. Note: To add the primary node to the endpoint, do not enter the primary node ID; just enter Primary. Separate multiple node IDs with commas (,). */ readonly nodes: pulumi.Output; /** * Enable overload protection. Options: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints. */ readonly overloadProtection: pulumi.Output; /** * Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, the value range is: LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, the value range is: Default: automatic allocation based on specification weight. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. */ readonly readOnlyNodeDistributionType: pulumi.Output; /** * Read-only node latency threshold. Value range: 1~3600. Default: 30. Unit: seconds. */ readonly readOnlyNodeMaxDelayTime: pulumi.Output; readonly readOnlyNodeWeights: pulumi.Output; /** * Read/write mode: ReadWrite: read/write. ReadOnly: read-only. */ readonly readWriteMode: pulumi.Output; /** * Enable read/write splitting. Values: true: enabled (default). false: disabled. */ readonly readWriteSpliting: pulumi.Output; /** * Create a Endpoint resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args?: EndpointArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Endpoint resources. */ export interface EndpointState { addresses?: pulumi.Input[]>; /** * When the endpoint type is read/write or read-only, you can set whether new nodes are automatically added. Values: true: automatically added. false: not automatically added (default). */ autoAddNewNodes?: pulumi.Input; /** * Associate all replica nodes. Values: true: enabled (default). false: disabled. Note: Only read-only endpoints of multi-node instances support this configuration. This feature can be disabled only if the instance has two or more replica nodes. */ connectAllSlaveNodes?: pulumi.Input; /** * Connection endpoint tags. */ connectionInfoTags?: pulumi.Input[]>; /** * Endpoint type. Options: Proxy: proxy endpoint. Direct: direct endpoint. Note: If the database proxy feature is enabled for the instance, you can select Proxy or Direct. If the database proxy feature is not enabled, only Direct is available. You can call the DescribeDBInstanceDetail API to check the status of the database proxy feature for the instance. */ connectionMode?: pulumi.Input; /** * Connection pool type for proxy endpoints. Options: Transaction: transaction-level connection pool (default). Direct: direct mode. Note: Single-node instances do not support this feature. */ connectionPoolType?: pulumi.Input; /** * SQL forwarding rules for the connection endpoint. */ customRouteStrategy?: pulumi.Input; /** * Remarks. */ description?: pulumi.Input; /** * Enable connection keep-alive for the endpoint. Values: true: enabled. false: disabled. Note: Only proxy endpoints support this setting. */ enableConnectionPersistent?: pulumi.Input; /** * Enable global read-only. Values: Enable: enabled. Disable: not enabled. */ enableReadOnly?: pulumi.Input; /** * Instance connection endpoint ID. */ endpointId?: pulumi.Input; /** * Instance connection endpoint name. */ endpointName?: pulumi.Input; /** * Endpoint type. Value: Custom (custom endpoint). */ endpointType?: pulumi.Input; /** * Enable idle connection recycling. true: enabled. false: not enabled. Note: This field is returned only for proxy endpoints. */ idleConnectionReclaim?: pulumi.Input; /** * Enable transaction separation. Options: true: yes. false: no. Note: Only proxy endpoints return this field. */ implicitTransSplit?: pulumi.Input; /** * Instance ID. */ instanceId?: pulumi.Input; /** * Enable primary node routing. Values: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints. */ masterNodeRouting?: pulumi.Input; /** * Overload protection timeout. Value range: integer between 60~7200. Unit: seconds. Note: This field is returned only for proxy endpoints. */ masterProtectorTimeout?: pulumi.Input; /** * Multi-Statements mode for proxy endpoints. Options: Strict: strict mode (default). Loose: loose mode. */ multiStatementsMode?: pulumi.Input; /** * List of node IDs configured for the connection endpoint. Required when EndpointType is Custom. Note: To add the primary node to the endpoint, do not enter the primary node ID; just enter Primary. Separate multiple node IDs with commas (,). */ nodes?: pulumi.Input; /** * Enable overload protection. Options: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints. */ overloadProtection?: pulumi.Input; /** * Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, the value range is: LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, the value range is: Default: automatic allocation based on specification weight. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. */ readOnlyNodeDistributionType?: pulumi.Input; /** * Read-only node latency threshold. Value range: 1~3600. Default: 30. Unit: seconds. */ readOnlyNodeMaxDelayTime?: pulumi.Input; readOnlyNodeWeights?: pulumi.Input[]>; /** * Read/write mode: ReadWrite: read/write. ReadOnly: read-only. */ readWriteMode?: pulumi.Input; /** * Enable read/write splitting. Values: true: enabled (default). false: disabled. */ readWriteSpliting?: pulumi.Input; } /** * The set of arguments for constructing a Endpoint resource. */ export interface EndpointArgs { addresses?: pulumi.Input[]>; /** * When the endpoint type is read/write or read-only, you can set whether new nodes are automatically added. Values: true: automatically added. false: not automatically added (default). */ autoAddNewNodes?: pulumi.Input; /** * Associate all replica nodes. Values: true: enabled (default). false: disabled. Note: Only read-only endpoints of multi-node instances support this configuration. This feature can be disabled only if the instance has two or more replica nodes. */ connectAllSlaveNodes?: pulumi.Input; /** * Endpoint type. Options: Proxy: proxy endpoint. Direct: direct endpoint. Note: If the database proxy feature is enabled for the instance, you can select Proxy or Direct. If the database proxy feature is not enabled, only Direct is available. You can call the DescribeDBInstanceDetail API to check the status of the database proxy feature for the instance. */ connectionMode?: pulumi.Input; /** * Connection pool type for proxy endpoints. Options: Transaction: transaction-level connection pool (default). Direct: direct mode. Note: Single-node instances do not support this feature. */ connectionPoolType?: pulumi.Input; /** * Remarks. */ description?: pulumi.Input; /** * Enable connection keep-alive for the endpoint. Values: true: enabled. false: disabled. Note: Only proxy endpoints support this setting. */ enableConnectionPersistent?: pulumi.Input; /** * Instance connection endpoint name. */ endpointName?: pulumi.Input; /** * Endpoint type. Value: Custom (custom endpoint). */ endpointType?: pulumi.Input; /** * Enable idle connection recycling. true: enabled. false: not enabled. Note: This field is returned only for proxy endpoints. */ idleConnectionReclaim?: pulumi.Input; /** * Enable transaction separation. Options: true: yes. false: no. Note: Only proxy endpoints return this field. */ implicitTransSplit?: pulumi.Input; /** * Instance ID. */ instanceId?: pulumi.Input; /** * Enable primary node routing. Values: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints. */ masterNodeRouting?: pulumi.Input; /** * Overload protection timeout. Value range: integer between 60~7200. Unit: seconds. Note: This field is returned only for proxy endpoints. */ masterProtectorTimeout?: pulumi.Input; /** * Multi-Statements mode for proxy endpoints. Options: Strict: strict mode (default). Loose: loose mode. */ multiStatementsMode?: pulumi.Input; /** * List of node IDs configured for the connection endpoint. Required when EndpointType is Custom. Note: To add the primary node to the endpoint, do not enter the primary node ID; just enter Primary. Separate multiple node IDs with commas (,). */ nodes?: pulumi.Input; /** * Enable overload protection. Options: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints. */ overloadProtection?: pulumi.Input; /** * Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, the value range is: LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, the value range is: Default: automatic allocation based on specification weight. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. */ readOnlyNodeDistributionType?: pulumi.Input; /** * Read-only node latency threshold. Value range: 1~3600. Default: 30. Unit: seconds. */ readOnlyNodeMaxDelayTime?: pulumi.Input; readOnlyNodeWeights?: pulumi.Input[]>; /** * Read/write mode: ReadWrite: read/write. ReadOnly: read-only. */ readWriteMode?: pulumi.Input; /** * Enable read/write splitting. Values: true: enabled (default). false: disabled. */ readWriteSpliting?: pulumi.Input; }