com.pulumi.alicloud.polardb.kotlin.Endpoint.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-alicloud-kotlin Show documentation
Show all versions of pulumi-alicloud-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.alicloud.polardb.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [Endpoint].
*/
@PulumiTagMarker
public class EndpointResourceBuilder internal constructor() {
public var name: String? = null
public var args: EndpointArgs = EndpointArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend EndpointArgsBuilder.() -> Unit) {
val builder = EndpointArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Endpoint {
val builtJavaResource = com.pulumi.alicloud.polardb.Endpoint(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Endpoint(builtJavaResource)
}
}
/**
* 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
*
* ```typescript
* 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 defaultEndpoint = new alicloud.polardb.Endpoint("default", {
* dbClusterId: defaultCluster.id,
* endpointType: "Custom",
* });
* ```
* ```python
* 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_endpoint = alicloud.polardb.Endpoint("default",
* db_cluster_id=default_cluster.id,
* endpoint_type="Custom")
* ```
* ```csharp
* 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 defaultEndpoint = new AliCloud.PolarDB.Endpoint("default", new()
* {
* DbClusterId = defaultCluster.Id,
* EndpointType = "Custom",
* });
* });
* ```
* ```go
* 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.NewEndpoint(ctx, "default", &polardb.EndpointArgs{
* DbClusterId: defaultCluster.ID(),
* EndpointType: pulumi.String("Custom"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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].supportedEngines()[0].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());
* }
* }
* ```
* ```yaml
* 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
* 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
* ```
*
* ## Import
* PolarDB endpoint can be imported using the id, e.g.
* ```sh
* $ pulumi import alicloud:polardb/endpoint:Endpoint example pc-abc123456:pe-abc123456
* ```
*/
public class Endpoint internal constructor(
override val javaResource: com.pulumi.alicloud.polardb.Endpoint,
) : KotlinCustomResource(javaResource, EndpointMapper) {
/**
* Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.
*/
public val autoAddNewNodes: Output
get() = javaResource.autoAddNewNodes().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val connectionPrefix: Output
get() = javaResource.connectionPrefix().applyValue({ args0 -> args0 })
/**
* The Id of cluster that can run database.
*/
public val dbClusterId: Output
get() = javaResource.dbClusterId().applyValue({ args0 -> args0 })
/**
* The name of the endpoint.
*/
public val dbEndpointDescription: Output?
get() = javaResource.dbEndpointDescription().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* (Available since v1.161.0) The ID of the cluster endpoint.
*/
public val dbEndpointId: Output
get() = javaResource.dbEndpointId().applyValue({ args0 -> args0 })
/**
* 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](https://www.alibabacloud.com/help/doc-detail/116593.htm).
*/
public val endpointConfig: Output>
get() = javaResource.endpointConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* 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`.
*/
public val endpointType: Output?
get() = javaResource.endpointType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The network type of the endpoint address.
*/
public val netType: Output?
get() = javaResource.netType().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(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.
*/
public val nodes: Output>
get() = javaResource.nodes().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* Port of the specified endpoint. Valid values: 3000 to 5999.
*/
public val port: Output
get() = javaResource.port().applyValue({ args0 -> args0 })
/**
* Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.
*/
public val readWriteMode: Output
get() = javaResource.readWriteMode().applyValue({ args0 -> args0 })
/**
* Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
*/
public val sslAutoRotate: Output?
get() = javaResource.sslAutoRotate().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies SSL certificate download link.
* **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](https://www.alibabacloud.com/help/doc-detail/153182.htm).
* 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.
*/
public val sslCertificateUrl: Output
get() = javaResource.sslCertificateUrl().applyValue({ args0 -> args0 })
/**
* (Available since v1.121.0) The SSL connection string.
*/
public val sslConnectionString: Output
get() = javaResource.sslConnectionString().applyValue({ args0 -> args0 })
/**
* Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
*/
public val sslEnabled: Output?
get() = javaResource.sslEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* (Available since v1.121.0) 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.
*/
public val sslExpireTime: Output
get() = javaResource.sslExpireTime().applyValue({ args0 -> args0 })
}
public object EndpointMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.alicloud.polardb.Endpoint::class == javaResource::class
override fun map(javaResource: Resource): Endpoint = Endpoint(
javaResource as
com.pulumi.alicloud.polardb.Endpoint,
)
}
/**
* @see [Endpoint].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Endpoint].
*/
public suspend fun endpoint(name: String, block: suspend EndpointResourceBuilder.() -> Unit): Endpoint {
val builder = EndpointResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Endpoint].
* @param name The _unique_ name of the resulting resource.
*/
public fun endpoint(name: String): Endpoint {
val builder = EndpointResourceBuilder()
builder.name(name)
return builder.build()
}