Class 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.

Inheritance
System.Object
Resource
CustomResource
Endpoint
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.AliCloud.PolarDB
Assembly: Pulumi.AliCloud.dll
Syntax
public class Endpoint : CustomResource

Constructors

View Source

Endpoint(String, EndpointArgs, CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

Declaration
public Endpoint(string name, EndpointArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
EndpointArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AutoAddNewNodes

Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.

Declaration
public Output<string> AutoAddNewNodes { get; }
Property Value
Type Description
Output<System.String>
View Source

DbClusterId

The Id of cluster that can run database.

Declaration
public Output<string> DbClusterId { get; }
Property Value
Type Description
Output<System.String>
View Source

EndpointConfig

Advanced configuration of the cluster address.

Declaration
public Output<ImmutableDictionary<string, object>> EndpointConfig { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

EndpointType

Type of endpoint. Valid value: Custom. Currently supported only Custom.

Declaration
public Output<string> EndpointType { get; }
Property Value
Type Description
Output<System.String>
View Source

Nodes

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.

Declaration
public Output<ImmutableArray<string>> Nodes { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

ReadWriteMode

Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

Declaration
public Output<string> ReadWriteMode { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, EndpointState, CustomResourceOptions)

Get an existing Endpoint resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Endpoint Get(string name, Input<string> id, EndpointState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
EndpointState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Endpoint