1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. polardb
  5. ClusterEndpoint
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

alicloud.polardb.ClusterEndpoint

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

    Provides a PolarDB endpoint resource to manage cluster endpoint of PolarDB cluster.

    NOTE: Available since v1.217.0

    NOTE: The default cluster endpoint can not be created or deleted manually.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const default = alicloud.polardb.getNodeClasses({
        dbType: "MySQL",
        dbVersion: "8.0",
        payType: "PostPaid",
        category: "Normal",
    });
    const defaultNetwork = new alicloud.vpc.Network("default", {
        vpcName: "terraform-example",
        cidrBlock: "172.16.0.0/16",
    });
    const defaultSwitch = new alicloud.vpc.Switch("default", {
        vpcId: defaultNetwork.id,
        cidrBlock: "172.16.0.0/24",
        zoneId: _default.then(_default => _default.classes?.[0]?.zoneId),
        vswitchName: "terraform-example",
    });
    const defaultCluster = new alicloud.polardb.Cluster("default", {
        dbType: "MySQL",
        dbVersion: "8.0",
        dbNodeClass: _default.then(_default => _default.classes?.[0]?.supportedEngines?.[0]?.availableResources?.[0]?.dbNodeClass),
        payType: "PostPaid",
        vswitchId: defaultSwitch.id,
        description: "terraform-example",
    });
    const defaultClusterEndpoint = new alicloud.polardb.ClusterEndpoint("default", {dbClusterId: defaultCluster.id});
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    default = alicloud.polardb.get_node_classes(db_type="MySQL",
        db_version="8.0",
        pay_type="PostPaid",
        category="Normal")
    default_network = alicloud.vpc.Network("default",
        vpc_name="terraform-example",
        cidr_block="172.16.0.0/16")
    default_switch = alicloud.vpc.Switch("default",
        vpc_id=default_network.id,
        cidr_block="172.16.0.0/24",
        zone_id=default.classes[0].zone_id,
        vswitch_name="terraform-example")
    default_cluster = alicloud.polardb.Cluster("default",
        db_type="MySQL",
        db_version="8.0",
        db_node_class=default.classes[0].supported_engines[0].available_resources[0].db_node_class,
        pay_type="PostPaid",
        vswitch_id=default_switch.id,
        description="terraform-example")
    default_cluster_endpoint = alicloud.polardb.ClusterEndpoint("default", db_cluster_id=default_cluster.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
    			DbType:    pulumi.StringRef("MySQL"),
    			DbVersion: pulumi.StringRef("8.0"),
    			PayType:   "PostPaid",
    			Category:  pulumi.StringRef("Normal"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
    			VpcName:   pulumi.String("terraform-example"),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
    			VpcId:       defaultNetwork.ID(),
    			CidrBlock:   pulumi.String("172.16.0.0/24"),
    			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
    			VswitchName: pulumi.String("terraform-example"),
    		})
    		if err != nil {
    			return err
    		}
    		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
    			DbType:      pulumi.String("MySQL"),
    			DbVersion:   pulumi.String("8.0"),
    			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
    			PayType:     pulumi.String("PostPaid"),
    			VswitchId:   defaultSwitch.ID(),
    			Description: pulumi.String("terraform-example"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = polardb.NewClusterEndpoint(ctx, "default", &polardb.ClusterEndpointArgs{
    			DbClusterId: defaultCluster.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = AliCloud.PolarDB.GetNodeClasses.Invoke(new()
        {
            DbType = "MySQL",
            DbVersion = "8.0",
            PayType = "PostPaid",
            Category = "Normal",
        });
    
        var defaultNetwork = new AliCloud.Vpc.Network("default", new()
        {
            VpcName = "terraform-example",
            CidrBlock = "172.16.0.0/16",
        });
    
        var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
        {
            VpcId = defaultNetwork.Id,
            CidrBlock = "172.16.0.0/24",
            ZoneId = @default.Apply(@default => @default.Apply(getNodeClassesResult => getNodeClassesResult.Classes[0]?.ZoneId)),
            VswitchName = "terraform-example",
        });
    
        var defaultCluster = new AliCloud.PolarDB.Cluster("default", new()
        {
            DbType = "MySQL",
            DbVersion = "8.0",
            DbNodeClass = @default.Apply(@default => @default.Apply(getNodeClassesResult => getNodeClassesResult.Classes[0]?.SupportedEngines[0]?.AvailableResources[0]?.DbNodeClass)),
            PayType = "PostPaid",
            VswitchId = defaultSwitch.Id,
            Description = "terraform-example",
        });
    
        var defaultClusterEndpoint = new AliCloud.PolarDB.ClusterEndpoint("default", new()
        {
            DbClusterId = defaultCluster.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.polardb.PolardbFunctions;
    import com.pulumi.alicloud.polardb.inputs.GetNodeClassesArgs;
    import com.pulumi.alicloud.vpc.Network;
    import com.pulumi.alicloud.vpc.NetworkArgs;
    import com.pulumi.alicloud.vpc.Switch;
    import com.pulumi.alicloud.vpc.SwitchArgs;
    import com.pulumi.alicloud.polardb.Cluster;
    import com.pulumi.alicloud.polardb.ClusterArgs;
    import com.pulumi.alicloud.polardb.ClusterEndpoint;
    import com.pulumi.alicloud.polardb.ClusterEndpointArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var default = PolardbFunctions.getNodeClasses(GetNodeClassesArgs.builder()
                .dbType("MySQL")
                .dbVersion("8.0")
                .payType("PostPaid")
                .category("Normal")
                .build());
    
            var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
                .vpcName("terraform-example")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
                .vpcId(defaultNetwork.id())
                .cidrBlock("172.16.0.0/24")
                .zoneId(default_.classes()[0].zoneId())
                .vswitchName("terraform-example")
                .build());
    
            var defaultCluster = new Cluster("defaultCluster", ClusterArgs.builder()
                .dbType("MySQL")
                .dbVersion("8.0")
                .dbNodeClass(default_.classes()[0].supportedEngines()[0].availableResources()[0].dbNodeClass())
                .payType("PostPaid")
                .vswitchId(defaultSwitch.id())
                .description("terraform-example")
                .build());
    
            var defaultClusterEndpoint = new ClusterEndpoint("defaultClusterEndpoint", ClusterEndpointArgs.builder()
                .dbClusterId(defaultCluster.id())
                .build());
    
        }
    }
    
    resources:
      defaultNetwork:
        type: alicloud:vpc:Network
        name: default
        properties:
          vpcName: terraform-example
          cidrBlock: 172.16.0.0/16
      defaultSwitch:
        type: alicloud:vpc:Switch
        name: default
        properties:
          vpcId: ${defaultNetwork.id}
          cidrBlock: 172.16.0.0/24
          zoneId: ${default.classes[0].zoneId}
          vswitchName: terraform-example
      defaultCluster:
        type: alicloud:polardb:Cluster
        name: default
        properties:
          dbType: MySQL
          dbVersion: '8.0'
          dbNodeClass: ${default.classes[0].supportedEngines[0].availableResources[0].dbNodeClass}
          payType: PostPaid
          vswitchId: ${defaultSwitch.id}
          description: terraform-example
      defaultClusterEndpoint:
        type: alicloud:polardb:ClusterEndpoint
        name: default
        properties:
          dbClusterId: ${defaultCluster.id}
    variables:
      default:
        fn::invoke:
          Function: alicloud:polardb:getNodeClasses
          Arguments:
            dbType: MySQL
            dbVersion: '8.0'
            payType: PostPaid
            category: Normal
    

    Create ClusterEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterEndpoint(name: string, args: ClusterEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def ClusterEndpoint(resource_name: str,
                        args: ClusterEndpointArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ClusterEndpoint(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        db_cluster_id: Optional[str] = None,
                        auto_add_new_nodes: Optional[str] = None,
                        connection_prefix: Optional[str] = None,
                        db_endpoint_description: Optional[str] = None,
                        endpoint_config: Optional[Mapping[str, Any]] = None,
                        net_type: Optional[str] = None,
                        nodes: Optional[Sequence[str]] = None,
                        port: Optional[str] = None,
                        read_write_mode: Optional[str] = None,
                        ssl_auto_rotate: Optional[str] = None,
                        ssl_enabled: Optional[str] = None)
    func NewClusterEndpoint(ctx *Context, name string, args ClusterEndpointArgs, opts ...ResourceOption) (*ClusterEndpoint, error)
    public ClusterEndpoint(string name, ClusterEndpointArgs args, CustomResourceOptions? opts = null)
    public ClusterEndpoint(String name, ClusterEndpointArgs args)
    public ClusterEndpoint(String name, ClusterEndpointArgs args, CustomResourceOptions options)
    
    type: alicloud:polardb:ClusterEndpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClusterEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clusterEndpointResource = new AliCloud.PolarDB.ClusterEndpoint("clusterEndpointResource", new()
    {
        DbClusterId = "string",
        AutoAddNewNodes = "string",
        ConnectionPrefix = "string",
        DbEndpointDescription = "string",
        EndpointConfig = 
        {
            { "string", "any" },
        },
        NetType = "string",
        Nodes = new[]
        {
            "string",
        },
        Port = "string",
        ReadWriteMode = "string",
        SslAutoRotate = "string",
        SslEnabled = "string",
    });
    
    example, err := polardb.NewClusterEndpoint(ctx, "clusterEndpointResource", &polardb.ClusterEndpointArgs{
    	DbClusterId:           pulumi.String("string"),
    	AutoAddNewNodes:       pulumi.String("string"),
    	ConnectionPrefix:      pulumi.String("string"),
    	DbEndpointDescription: pulumi.String("string"),
    	EndpointConfig: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	NetType: pulumi.String("string"),
    	Nodes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Port:          pulumi.String("string"),
    	ReadWriteMode: pulumi.String("string"),
    	SslAutoRotate: pulumi.String("string"),
    	SslEnabled:    pulumi.String("string"),
    })
    
    var clusterEndpointResource = new ClusterEndpoint("clusterEndpointResource", ClusterEndpointArgs.builder()
        .dbClusterId("string")
        .autoAddNewNodes("string")
        .connectionPrefix("string")
        .dbEndpointDescription("string")
        .endpointConfig(Map.of("string", "any"))
        .netType("string")
        .nodes("string")
        .port("string")
        .readWriteMode("string")
        .sslAutoRotate("string")
        .sslEnabled("string")
        .build());
    
    cluster_endpoint_resource = alicloud.polardb.ClusterEndpoint("clusterEndpointResource",
        db_cluster_id="string",
        auto_add_new_nodes="string",
        connection_prefix="string",
        db_endpoint_description="string",
        endpoint_config={
            "string": "any",
        },
        net_type="string",
        nodes=["string"],
        port="string",
        read_write_mode="string",
        ssl_auto_rotate="string",
        ssl_enabled="string")
    
    const clusterEndpointResource = new alicloud.polardb.ClusterEndpoint("clusterEndpointResource", {
        dbClusterId: "string",
        autoAddNewNodes: "string",
        connectionPrefix: "string",
        dbEndpointDescription: "string",
        endpointConfig: {
            string: "any",
        },
        netType: "string",
        nodes: ["string"],
        port: "string",
        readWriteMode: "string",
        sslAutoRotate: "string",
        sslEnabled: "string",
    });
    
    type: alicloud:polardb:ClusterEndpoint
    properties:
        autoAddNewNodes: string
        connectionPrefix: string
        dbClusterId: string
        dbEndpointDescription: string
        endpointConfig:
            string: any
        netType: string
        nodes:
            - string
        port: string
        readWriteMode: string
        sslAutoRotate: string
        sslEnabled: string
    

    ClusterEndpoint Resource Properties

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

    Inputs

    The ClusterEndpoint resource accepts the following input properties:

    DbClusterId string
    The Id of cluster that can run database.
    AutoAddNewNodes string
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    ConnectionPrefix string
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    DbEndpointDescription string
    The name of the endpoint.
    EndpointConfig Dictionary<string, object>
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    NetType string
    The network type of the endpoint 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.
    Port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    ReadWriteMode string
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    SslAutoRotate string
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    SslEnabled string
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    DbClusterId string
    The Id of cluster that can run database.
    AutoAddNewNodes string
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    ConnectionPrefix string
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    DbEndpointDescription string
    The name of the endpoint.
    EndpointConfig map[string]interface{}
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    NetType string
    The network type of the endpoint 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.
    Port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    ReadWriteMode string
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    SslAutoRotate string
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    SslEnabled string
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    dbClusterId String
    The Id of cluster that can run database.
    autoAddNewNodes String
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    connectionPrefix String
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    dbEndpointDescription String
    The name of the endpoint.
    endpointConfig Map<String,Object>
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    netType String
    The network type of the endpoint 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.
    port String
    Port of the specified endpoint. Valid values: 3000 to 5999.
    readWriteMode String
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    sslAutoRotate String
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    sslEnabled String
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    dbClusterId string
    The Id of cluster that can run database.
    autoAddNewNodes string
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    connectionPrefix string
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    dbEndpointDescription string
    The name of the endpoint.
    endpointConfig {[key: string]: any}
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    netType string
    The network type of the endpoint 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.
    port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    readWriteMode string
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    sslAutoRotate string
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    sslEnabled string
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    db_cluster_id str
    The Id of cluster that can run database.
    auto_add_new_nodes str
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    connection_prefix str
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    db_endpoint_description str
    The name of the endpoint.
    endpoint_config Mapping[str, Any]
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    net_type str
    The network type of the endpoint address.
    nodes Sequence[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.
    port str
    Port of the specified endpoint. Valid values: 3000 to 5999.
    read_write_mode str
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    ssl_auto_rotate str
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    ssl_enabled str
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    dbClusterId String
    The Id of cluster that can run database.
    autoAddNewNodes String
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    connectionPrefix String
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    dbEndpointDescription String
    The name of the endpoint.
    endpointConfig Map<Any>
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    netType String
    The network type of the endpoint 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.
    port String
    Port of the specified endpoint. Valid values: 3000 to 5999.
    readWriteMode String
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    sslAutoRotate String
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    sslEnabled String
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterEndpoint resource produces the following output properties:

    DbEndpointId string
    The ID of the cluster endpoint.
    EndpointType string
    Type of endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    SslCertificateUrl string
    The specifies SSL certificate download link.
    SslConnectionString string
    The SSL connection string.
    SslExpireTime string
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    DbEndpointId string
    The ID of the cluster endpoint.
    EndpointType string
    Type of endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    SslCertificateUrl string
    The specifies SSL certificate download link.
    SslConnectionString string
    The SSL connection string.
    SslExpireTime string
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    dbEndpointId String
    The ID of the cluster endpoint.
    endpointType String
    Type of endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    sslCertificateUrl String
    The specifies SSL certificate download link.
    sslConnectionString String
    The SSL connection string.
    sslExpireTime String
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    dbEndpointId string
    The ID of the cluster endpoint.
    endpointType string
    Type of endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    sslCertificateUrl string
    The specifies SSL certificate download link.
    sslConnectionString string
    The SSL connection string.
    sslExpireTime string
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    db_endpoint_id str
    The ID of the cluster endpoint.
    endpoint_type str
    Type of endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    ssl_certificate_url str
    The specifies SSL certificate download link.
    ssl_connection_string str
    The SSL connection string.
    ssl_expire_time str
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    dbEndpointId String
    The ID of the cluster endpoint.
    endpointType String
    Type of endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    sslCertificateUrl String
    The specifies SSL certificate download link.
    sslConnectionString String
    The SSL connection string.
    sslExpireTime String
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    Look up Existing ClusterEndpoint Resource

    Get an existing ClusterEndpoint 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?: ClusterEndpointState, opts?: CustomResourceOptions): ClusterEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_add_new_nodes: Optional[str] = None,
            connection_prefix: Optional[str] = None,
            db_cluster_id: Optional[str] = None,
            db_endpoint_description: Optional[str] = None,
            db_endpoint_id: Optional[str] = None,
            endpoint_config: Optional[Mapping[str, Any]] = None,
            endpoint_type: Optional[str] = None,
            net_type: Optional[str] = None,
            nodes: Optional[Sequence[str]] = None,
            port: Optional[str] = None,
            read_write_mode: Optional[str] = None,
            ssl_auto_rotate: Optional[str] = None,
            ssl_certificate_url: Optional[str] = None,
            ssl_connection_string: Optional[str] = None,
            ssl_enabled: Optional[str] = None,
            ssl_expire_time: Optional[str] = None) -> ClusterEndpoint
    func GetClusterEndpoint(ctx *Context, name string, id IDInput, state *ClusterEndpointState, opts ...ResourceOption) (*ClusterEndpoint, error)
    public static ClusterEndpoint Get(string name, Input<string> id, ClusterEndpointState? state, CustomResourceOptions? opts = null)
    public static ClusterEndpoint get(String name, Output<String> id, ClusterEndpointState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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. When creating a new custom endpoint, default to Disable.
    ConnectionPrefix string
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    DbClusterId string
    The Id of cluster that can run database.
    DbEndpointDescription string
    The name of the endpoint.
    DbEndpointId string
    The ID of the cluster endpoint.
    EndpointConfig Dictionary<string, object>
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    EndpointType string
    Type of endpoint.
    NetType string
    The network type of the endpoint 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.
    Port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    ReadWriteMode string
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    SslAutoRotate string
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    SslCertificateUrl string
    The specifies SSL certificate download link.
    SslConnectionString string
    The SSL connection string.
    SslEnabled string
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    SslExpireTime string
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    AutoAddNewNodes string
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    ConnectionPrefix string
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    DbClusterId string
    The Id of cluster that can run database.
    DbEndpointDescription string
    The name of the endpoint.
    DbEndpointId string
    The ID of the cluster endpoint.
    EndpointConfig map[string]interface{}
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    EndpointType string
    Type of endpoint.
    NetType string
    The network type of the endpoint 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.
    Port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    ReadWriteMode string
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    SslAutoRotate string
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    SslCertificateUrl string
    The specifies SSL certificate download link.
    SslConnectionString string
    The SSL connection string.
    SslEnabled string
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    SslExpireTime string
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    autoAddNewNodes String
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    connectionPrefix String
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    dbClusterId String
    The Id of cluster that can run database.
    dbEndpointDescription String
    The name of the endpoint.
    dbEndpointId String
    The ID of the cluster endpoint.
    endpointConfig Map<String,Object>
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    endpointType String
    Type of endpoint.
    netType String
    The network type of the endpoint 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.
    port String
    Port of the specified endpoint. Valid values: 3000 to 5999.
    readWriteMode String
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    sslAutoRotate String
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    sslCertificateUrl String
    The specifies SSL certificate download link.
    sslConnectionString String
    The SSL connection string.
    sslEnabled String
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    sslExpireTime String
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    autoAddNewNodes string
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    connectionPrefix string
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    dbClusterId string
    The Id of cluster that can run database.
    dbEndpointDescription string
    The name of the endpoint.
    dbEndpointId string
    The ID of the cluster endpoint.
    endpointConfig {[key: string]: any}
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    endpointType string
    Type of endpoint.
    netType string
    The network type of the endpoint 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.
    port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    readWriteMode string
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    sslAutoRotate string
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    sslCertificateUrl string
    The specifies SSL certificate download link.
    sslConnectionString string
    The SSL connection string.
    sslEnabled string
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    sslExpireTime string
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    auto_add_new_nodes str
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    connection_prefix str
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    db_cluster_id str
    The Id of cluster that can run database.
    db_endpoint_description str
    The name of the endpoint.
    db_endpoint_id str
    The ID of the cluster endpoint.
    endpoint_config Mapping[str, Any]
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    endpoint_type str
    Type of endpoint.
    net_type str
    The network type of the endpoint address.
    nodes Sequence[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.
    port str
    Port of the specified endpoint. Valid values: 3000 to 5999.
    read_write_mode str
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    ssl_auto_rotate str
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    ssl_certificate_url str
    The specifies SSL certificate download link.
    ssl_connection_string str
    The SSL connection string.
    ssl_enabled str
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    ssl_expire_time str
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    autoAddNewNodes String
    Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.
    connectionPrefix String
    Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
    dbClusterId String
    The Id of cluster that can run database.
    dbEndpointDescription String
    The name of the endpoint.
    dbEndpointId String
    The ID of the cluster endpoint.
    endpointConfig Map<Any>
    The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the description of EndpointConfig in the Request parameters table for details.
    endpointType String
    Type of endpoint.
    netType String
    The network type of the endpoint 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.
    port String
    Port of the specified endpoint. Valid values: 3000 to 5999.
    readWriteMode String
    Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.
    sslAutoRotate String
    Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable. NOTE: For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see Configure SSL encryption. For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
    sslCertificateUrl String
    The specifies SSL certificate download link.
    sslConnectionString String
    The SSL connection string.
    sslEnabled String
    Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.
    sslExpireTime String
    The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    Import

    PolarDB endpoint can be imported using the id, e.g.

    $ pulumi import alicloud:polardb/clusterEndpoint:ClusterEndpoint example pc-abc123456:pe-abc123456
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi