Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. polardb
  5. PrimaryEndpoint
Alibaba Cloud v3.54.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.polardb.PrimaryEndpoint

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.54.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-alicloud

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

    NOTE: Available since v1.217.0

    NOTE: The default primary 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 defaultPrimaryEndpoint = new alicloud.polardb.PrimaryEndpoint("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_primary_endpoint = alicloud.polardb.PrimaryEndpoint("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.NewPrimaryEndpoint(ctx, "default", &polardb.PrimaryEndpointArgs{
			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 defaultPrimaryEndpoint = new AliCloud.PolarDB.PrimaryEndpoint("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.PrimaryEndpoint;
import com.pulumi.alicloud.polardb.PrimaryEndpointArgs;
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 defaultPrimaryEndpoint = new PrimaryEndpoint("defaultPrimaryEndpoint", PrimaryEndpointArgs.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
  defaultPrimaryEndpoint:
    type: alicloud:polardb:PrimaryEndpoint
    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 PrimaryEndpoint Resource

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

    Constructor syntax

    new PrimaryEndpoint(name: string, args: PrimaryEndpointArgs, opts?: CustomResourceOptions);
    @overload
def PrimaryEndpoint(resource_name: str,
                    args: PrimaryEndpointArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def PrimaryEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    db_cluster_id: Optional[str] = None,
                    connection_prefix: Optional[str] = None,
                    db_endpoint_description: Optional[str] = None,
                    net_type: Optional[str] = None,
                    port: Optional[str] = None,
                    ssl_auto_rotate: Optional[str] = None,
                    ssl_enabled: Optional[str] = None)
    func NewPrimaryEndpoint(ctx *Context, name string, args PrimaryEndpointArgs, opts ...ResourceOption) (*PrimaryEndpoint, error)
    public PrimaryEndpoint(string name, PrimaryEndpointArgs args, CustomResourceOptions? opts = null)
    public PrimaryEndpoint(String name, PrimaryEndpointArgs args)
public PrimaryEndpoint(String name, PrimaryEndpointArgs args, CustomResourceOptions options)

    type: alicloud:polardb:PrimaryEndpoint
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 PrimaryEndpointArgs
    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 PrimaryEndpointArgs
    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 PrimaryEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrimaryEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrimaryEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var primaryEndpointResource = new AliCloud.PolarDB.PrimaryEndpoint("primaryEndpointResource", new()
{
    DbClusterId = "string",
    ConnectionPrefix = "string",
    DbEndpointDescription = "string",
    NetType = "string",
    Port = "string",
    SslAutoRotate = "string",
    SslEnabled = "string",
});

    example, err := polardb.NewPrimaryEndpoint(ctx, "primaryEndpointResource", &polardb.PrimaryEndpointArgs{
	DbClusterId:           pulumi.String("string"),
	ConnectionPrefix:      pulumi.String("string"),
	DbEndpointDescription: pulumi.String("string"),
	NetType:               pulumi.String("string"),
	Port:                  pulumi.String("string"),
	SslAutoRotate:         pulumi.String("string"),
	SslEnabled:            pulumi.String("string"),
})

    var primaryEndpointResource = new PrimaryEndpoint("primaryEndpointResource", PrimaryEndpointArgs.builder()        
    .dbClusterId("string")
    .connectionPrefix("string")
    .dbEndpointDescription("string")
    .netType("string")
    .port("string")
    .sslAutoRotate("string")
    .sslEnabled("string")
    .build());

    primary_endpoint_resource = alicloud.polardb.PrimaryEndpoint("primaryEndpointResource",
    db_cluster_id="string",
    connection_prefix="string",
    db_endpoint_description="string",
    net_type="string",
    port="string",
    ssl_auto_rotate="string",
    ssl_enabled="string")

    const primaryEndpointResource = new alicloud.polardb.PrimaryEndpoint("primaryEndpointResource", {
    dbClusterId: "string",
    connectionPrefix: "string",
    dbEndpointDescription: "string",
    netType: "string",
    port: "string",
    sslAutoRotate: "string",
    sslEnabled: "string",
});

    type: alicloud:polardb:PrimaryEndpoint
properties:
    connectionPrefix: string
    dbClusterId: string
    dbEndpointDescription: string
    netType: string
    port: string
    sslAutoRotate: string
    sslEnabled: string

    PrimaryEndpoint 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 PrimaryEndpoint resource accepts the following input properties:

    DbClusterId string
    The Id of cluster that can run database.
    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.
    NetType string
    The network type of the endpoint address.
    Port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    NetType string
    The network type of the endpoint address.
    Port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    netType String
    The network type of the endpoint address.
    port String
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    netType string
    The network type of the endpoint address.
    port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    net_type str
    The network type of the endpoint address.
    port str
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    netType String
    The network type of the endpoint address.
    port String
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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 PrimaryEndpoint 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 PrimaryEndpoint Resource

    Get an existing PrimaryEndpoint 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?: PrimaryEndpointState, opts?: CustomResourceOptions): PrimaryEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = 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_type: Optional[str] = None,
        net_type: Optional[str] = None,
        port: 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) -> PrimaryEndpoint
    func GetPrimaryEndpoint(ctx *Context, name string, id IDInput, state *PrimaryEndpointState, opts ...ResourceOption) (*PrimaryEndpoint, error)
    public static PrimaryEndpoint Get(string name, Input<string> id, PrimaryEndpointState? state, CustomResourceOptions? opts = null)
    public static PrimaryEndpoint get(String name, Output<String> id, PrimaryEndpointState 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:
    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.
    EndpointType string
    Type of endpoint.
    NetType string
    The network type of the endpoint address.
    Port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    EndpointType string
    Type of endpoint.
    NetType string
    The network type of the endpoint address.
    Port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    endpointType String
    Type of endpoint.
    netType String
    The network type of the endpoint address.
    port String
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    endpointType string
    Type of endpoint.
    netType string
    The network type of the endpoint address.
    port string
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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_type str
    Type of endpoint.
    net_type str
    The network type of the endpoint address.
    port str
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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.
    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.
    endpointType String
    Type of endpoint.
    netType String
    The network type of the endpoint address.
    port String
    Port of the specified endpoint. Valid values: 3000 to 5999.
    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/primaryEndpoint:PrimaryEndpoint 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.54.0 published on Wednesday, Apr 24, 2024 by Pulumi
    pulumi/pulumi-alicloud