Endpoint

Provides a PolarDB endpoint resource to allocate an Internet endpoint string for PolarDB instance.

NOTE: Available in v1.80.0+. Each PolarDB instance will allocate a intranet connection string automatically and its prefix is Cluster ID. To avoid unnecessary conflict, please specified a internet connection prefix before applying the resource.

Create a Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

def Endpoint(resource_name, opts=None, auto_add_new_nodes=None, db_cluster_id=None, endpoint_config=None, endpoint_type=None, nodes=None, read_write_mode=None, __props__=None);

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

Endpoint Resource Properties

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

Inputs

The Endpoint resource accepts the following input properties:

DbClusterId string: The Id of cluster that can run database.
EndpointType string: Type of endpoint. Valid value: Custom. Currently supported only Custom.
AutoAddNewNodes string: Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.
EndpointConfig Dictionary<string, object>: Advanced configuration of the cluster address.
Nodes List<string>: Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.
ReadWriteMode string: Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

DbClusterId string: The Id of cluster that can run database.
EndpointType string: Type of endpoint. Valid value: Custom. Currently supported only Custom.
AutoAddNewNodes string: Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.
EndpointConfig map[string]interface{}: Advanced configuration of the cluster address.
Nodes []string: Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.
ReadWriteMode string: Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

dbClusterId string: The Id of cluster that can run database.
endpointType string: Type of endpoint. Valid value: Custom. Currently supported only Custom.
autoAddNewNodes string: Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.
endpointConfig {[key: string]: any}: Advanced configuration of the cluster address.
nodes string[]: Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.
readWriteMode string: Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

db_cluster_id str: The Id of cluster that can run database.
endpoint_type str: Type of endpoint. Valid value: Custom. Currently supported only Custom.
auto_add_new_nodes str: Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.
endpoint_config Dict[str, Any]: Advanced configuration of the cluster address.
nodes List[str]: Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.
read_write_mode str: Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

Outputs

All input properties are implicitly available as output properties. Additionally, the Endpoint 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing Endpoint Resource

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

static get(resource_name, id, opts=None, auto_add_new_nodes=None, db_cluster_id=None, endpoint_config=None, endpoint_type=None, nodes=None, read_write_mode=None, __props__=None);

func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)

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

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.

The following state arguments are supported:

AutoAddNewNodes string: Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.
DbClusterId string: The Id of cluster that can run database.
EndpointConfig Dictionary<string, object>: Advanced configuration of the cluster address.
EndpointType string: Type of endpoint. Valid value: Custom. Currently supported only Custom.
Nodes List<string>: Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.
ReadWriteMode string: Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

AutoAddNewNodes string: Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.
DbClusterId string: The Id of cluster that can run database.
EndpointConfig map[string]interface{}: Advanced configuration of the cluster address.
EndpointType string: Type of endpoint. Valid value: Custom. Currently supported only Custom.
Nodes []string: Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.
ReadWriteMode string: Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

autoAddNewNodes string: Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.
dbClusterId string: The Id of cluster that can run database.
endpointConfig {[key: string]: any}: Advanced configuration of the cluster address.
endpointType string: Type of endpoint. Valid value: Custom. Currently supported only Custom.
nodes string[]: Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.
readWriteMode string: Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

auto_add_new_nodes str: Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.
db_cluster_id str: The Id of cluster that can run database.
endpoint_config Dict[str, Any]: Advanced configuration of the cluster address.
endpoint_type str: Type of endpoint. Valid value: Custom. Currently supported only Custom.
nodes List[str]: Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.
read_write_mode str: Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud