pulumi-alicloud-kotlin/com.pulumi.alicloud.polardb.kotlin/EndpointArgs

EndpointArgs

data class EndpointArgs(val autoAddNewNodes: Output<String>? = null, val connectionPrefix: Output<String>? = null, val dbClusterId: Output<String>? = null, val dbEndpointDescription: Output<String>? = null, val endpointConfig: Output<Map<String, String>>? = null, val endpointType: Output<String>? = null, val netType: Output<String>? = null, val nodes: Output<List<String>>? = null, val port: Output<String>? = null, val readWriteMode: Output<String>? = null, val sslAutoRotate: Output<String>? = null, val sslEnabled: Output<String>? = null) : ConvertibleToJava<EndpointArgs>

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

NOTE: Available since v1.80.0. NOTE: After v1.80.0 and before v1.121.0, you can only use this resource to manage the custom endpoint. Since v1.121.0, you also can import the primary endpoint and the cluster endpoint, to modify their ssl status and so on. NOTE: The primary endpoint and 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]?&#46;supportedEngines?&#46;[0]?&#46;availableResources?&#46;[0]?.dbNodeClass),
    payType: "PostPaid",
    vswitchId: defaultSwitch.id,
    description: "terraform-example",
});
const defaultEndpoint = new alicloud.polardb.Endpoint("default", {
    dbClusterId: defaultCluster.id,
    endpointType: "Custom",
});
Content copied to clipboard
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]&#46;supported_engines[0]&#46;available_resources[0].db_node_class,
    pay_type="PostPaid",
    vswitch_id=default_switch.id,
    description="terraform-example")
default_endpoint = alicloud.polardb.Endpoint("default",
    db_cluster_id=default_cluster.id,
    endpoint_type="Custom")
Content copied to clipboard
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]?&#46;SupportedEngines[0]?&#46;AvailableResources[0]?.DbNodeClass)),
        PayType = "PostPaid",
        VswitchId = defaultSwitch.Id,
        Description = "terraform-example",
    });
    var defaultEndpoint = new AliCloud.PolarDB.Endpoint("default", new()
    {
        DbClusterId = defaultCluster.Id,
        EndpointType = "Custom",
    });
});
Content copied to clipboard
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]&#46;SupportedEngines[0]&#46;AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewEndpoint(ctx, "default", &polardb.EndpointArgs{
			DbClusterId:  defaultCluster.ID(),
			EndpointType: pulumi.String("Custom"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.Endpoint;
import com.pulumi.alicloud.polardb.EndpointArgs;
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]&#46;supportedEngines()[0]&#46;availableResources()[0].dbNodeClass())
            .payType("PostPaid")
            .vswitchId(defaultSwitch.id())
            .description("terraform-example")
            .build());
        var defaultEndpoint = new Endpoint("defaultEndpoint", EndpointArgs.builder()
            .dbClusterId(defaultCluster.id())
            .endpointType("Custom")
            .build());
    }
}
Content copied to clipboard
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]&#46;supportedEngines[0]&#46;availableResources[0].dbNodeClass}
      payType: PostPaid
      vswitchId: ${defaultSwitch.id}
      description: terraform-example
  defaultEndpoint:
    type: alicloud:polardb:Endpoint
    name: default
    properties:
      dbClusterId: ${defaultCluster.id}
      endpointType: Custom
variables:
  default:
    fn::invoke:
      function: alicloud:polardb:getNodeClasses
      arguments:
        dbType: MySQL
        dbVersion: '8.0'
        payType: PostPaid
        category: Normal
Content copied to clipboard

Import

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

$ pulumi import alicloud:polardb/endpoint:Endpoint example pc-abc123456:pe-abc123456
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(autoAddNewNodes: Output<String>? = null, connectionPrefix: Output<String>? = null, dbClusterId: Output<String>? = null, dbEndpointDescription: Output<String>? = null, endpointConfig: Output<Map<String, String>>? = null, endpointType: Output<String>? = null, netType: Output<String>? = null, nodes: Output<List<String>>? = null, port: Output<String>? = null, readWriteMode: Output<String>? = null, sslAutoRotate: Output<String>? = null, sslEnabled: Output<String>? = null)

Properties

Link copied to clipboard
val autoAddNewNodes: Output<String>? = null

Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. When creating a new custom endpoint, default to Disable.

Link copied to clipboard
val connectionPrefix: Output<String>? = null

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.

Link copied to clipboard
val dbClusterId: Output<String>? = null

The Id of cluster that can run database.

Link copied to clipboard
val dbEndpointDescription: Output<String>? = null

The name of the endpoint.

Link copied to clipboard
val endpointConfig: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val endpointType: Output<String>? = null

Type of the endpoint. Before v1.121.0, it only can be Custom. since v1.121.0, Custom, Cluster, Primary are valid, default to Custom. However when creating a new endpoint, it also only can be Custom.

Link copied to clipboard
val netType: Output<String>? = null

The network type of the endpoint address.

Link copied to clipboard
val nodes: Output<List<String>>? = null

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.

Link copied to clipboard
val port: Output<String>? = null

Port of the specified endpoint. Valid values: 3000 to 5999.

Link copied to clipboard
val readWriteMode: Output<String>? = null

Read or write mode. Valid values are ReadWrite, ReadOnly. When creating a new custom endpoint, default to ReadOnly.

Link copied to clipboard
val sslAutoRotate: Output<String>? = null

Specifies whether automatic rotation of SSL certificates is enabled. Valid values: Enable,Disable.

Link copied to clipboard
val sslEnabled: Output<String>? = null

Specifies how to modify the SSL encryption status. Valid values: Disable, Enable, Update.

Functions

Link copied to clipboard
open override fun toJava(): EndpointArgs