alicloud.rds.DbInstanceEndpoint
Explore with Pulumi AI
Provide RDS cluster instance endpoint connection resources, see What is RDS DB Instance Endpoint.
NOTE: Available since v1.203.0.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const default = alicloud.rds.getZones({
engine: "MySQL",
engineVersion: "8.0",
instanceChargeType: "PostPaid",
category: "cluster",
dbInstanceStorageType: "cloud_essd",
});
const defaultGetInstanceClasses = _default.then(_default => alicloud.rds.getInstanceClasses({
zoneId: _default.ids?.[0],
engine: "MySQL",
engineVersion: "8.0",
category: "cluster",
dbInstanceStorageType: "cloud_essd",
instanceChargeType: "PostPaid",
}));
const defaultNetwork = new alicloud.vpc.Network("default", {
vpcName: name,
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.ids?.[0]),
vswitchName: name,
});
const defaultSecurityGroup = new alicloud.ecs.SecurityGroup("default", {
name: name,
vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.rds.Instance("default", {
engine: "MySQL",
engineVersion: "8.0",
instanceType: defaultGetInstanceClasses.then(defaultGetInstanceClasses => defaultGetInstanceClasses.instanceClasses?.[0]?.instanceClass),
instanceStorage: defaultGetInstanceClasses.then(defaultGetInstanceClasses => defaultGetInstanceClasses.instanceClasses?.[0]?.storageRange?.min),
instanceChargeType: "Postpaid",
instanceName: name,
vswitchId: defaultSwitch.id,
monitoringPeriod: 60,
dbInstanceStorageType: "cloud_essd",
securityGroupIds: [defaultSecurityGroup.id],
zoneId: _default.then(_default => _default.ids?.[0]),
zoneIdSlaveA: _default.then(_default => _default.ids?.[0]),
});
const defaultDbNode = new alicloud.rds.DbNode("default", {
dbInstanceId: defaultInstance.id,
classCode: defaultInstance.instanceType,
zoneId: defaultSwitch.zoneId,
});
const defaultDbInstanceEndpoint = new alicloud.rds.DbInstanceEndpoint("default", {
dbInstanceId: defaultDbNode.dbInstanceId,
vpcId: defaultNetwork.id,
vswitchId: defaultInstance.vswitchId,
connectionStringPrefix: "example",
port: "3306",
dbInstanceEndpointDescription: name,
nodeItems: [{
nodeId: defaultDbNode.nodeId,
weight: 25,
}],
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "tf-example"
default = alicloud.rds.get_zones(engine="MySQL",
engine_version="8.0",
instance_charge_type="PostPaid",
category="cluster",
db_instance_storage_type="cloud_essd")
default_get_instance_classes = alicloud.rds.get_instance_classes(zone_id=default.ids[0],
engine="MySQL",
engine_version="8.0",
category="cluster",
db_instance_storage_type="cloud_essd",
instance_charge_type="PostPaid")
default_network = alicloud.vpc.Network("default",
vpc_name=name,
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.ids[0],
vswitch_name=name)
default_security_group = alicloud.ecs.SecurityGroup("default",
name=name,
vpc_id=default_network.id)
default_instance = alicloud.rds.Instance("default",
engine="MySQL",
engine_version="8.0",
instance_type=default_get_instance_classes.instance_classes[0].instance_class,
instance_storage=default_get_instance_classes.instance_classes[0].storage_range.min,
instance_charge_type="Postpaid",
instance_name=name,
vswitch_id=default_switch.id,
monitoring_period=60,
db_instance_storage_type="cloud_essd",
security_group_ids=[default_security_group.id],
zone_id=default.ids[0],
zone_id_slave_a=default.ids[0])
default_db_node = alicloud.rds.DbNode("default",
db_instance_id=default_instance.id,
class_code=default_instance.instance_type,
zone_id=default_switch.zone_id)
default_db_instance_endpoint = alicloud.rds.DbInstanceEndpoint("default",
db_instance_id=default_db_node.db_instance_id,
vpc_id=default_network.id,
vswitch_id=default_instance.vswitch_id,
connection_string_prefix="example",
port="3306",
db_instance_endpoint_description=name,
node_items=[{
"node_id": default_db_node.node_id,
"weight": 25,
}])
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
_default, err := rds.GetZones(ctx, &rds.GetZonesArgs{
Engine: pulumi.StringRef("MySQL"),
EngineVersion: pulumi.StringRef("8.0"),
InstanceChargeType: pulumi.StringRef("PostPaid"),
Category: pulumi.StringRef("cluster"),
DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
}, nil)
if err != nil {
return err
}
defaultGetInstanceClasses, err := rds.GetInstanceClasses(ctx, &rds.GetInstanceClassesArgs{
ZoneId: pulumi.StringRef(_default.Ids[0]),
Engine: pulumi.StringRef("MySQL"),
EngineVersion: pulumi.StringRef("8.0"),
Category: pulumi.StringRef("cluster"),
DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
InstanceChargeType: pulumi.StringRef("PostPaid"),
}, nil)
if err != nil {
return err
}
defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
VpcName: pulumi.String(name),
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.Ids[0]),
VswitchName: pulumi.String(name),
})
if err != nil {
return err
}
defaultSecurityGroup, err := ecs.NewSecurityGroup(ctx, "default", &ecs.SecurityGroupArgs{
Name: pulumi.String(name),
VpcId: defaultNetwork.ID(),
})
if err != nil {
return err
}
defaultInstance, err := rds.NewInstance(ctx, "default", &rds.InstanceArgs{
Engine: pulumi.String("MySQL"),
EngineVersion: pulumi.String("8.0"),
InstanceType: pulumi.String(defaultGetInstanceClasses.InstanceClasses[0].InstanceClass),
InstanceStorage: pulumi.String(defaultGetInstanceClasses.InstanceClasses[0].StorageRange.Min),
InstanceChargeType: pulumi.String("Postpaid"),
InstanceName: pulumi.String(name),
VswitchId: defaultSwitch.ID(),
MonitoringPeriod: pulumi.Int(60),
DbInstanceStorageType: pulumi.String("cloud_essd"),
SecurityGroupIds: pulumi.StringArray{
defaultSecurityGroup.ID(),
},
ZoneId: pulumi.String(_default.Ids[0]),
ZoneIdSlaveA: pulumi.String(_default.Ids[0]),
})
if err != nil {
return err
}
defaultDbNode, err := rds.NewDbNode(ctx, "default", &rds.DbNodeArgs{
DbInstanceId: defaultInstance.ID(),
ClassCode: defaultInstance.InstanceType,
ZoneId: defaultSwitch.ZoneId,
})
if err != nil {
return err
}
_, err = rds.NewDbInstanceEndpoint(ctx, "default", &rds.DbInstanceEndpointArgs{
DbInstanceId: defaultDbNode.DbInstanceId,
VpcId: defaultNetwork.ID(),
VswitchId: defaultInstance.VswitchId,
ConnectionStringPrefix: pulumi.String("example"),
Port: pulumi.String("3306"),
DbInstanceEndpointDescription: pulumi.String(name),
NodeItems: rds.DbInstanceEndpointNodeItemArray{
&rds.DbInstanceEndpointNodeItemArgs{
NodeId: defaultDbNode.NodeId,
Weight: pulumi.Int(25),
},
},
})
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 config = new Config();
var name = config.Get("name") ?? "tf-example";
var @default = AliCloud.Rds.GetZones.Invoke(new()
{
Engine = "MySQL",
EngineVersion = "8.0",
InstanceChargeType = "PostPaid",
Category = "cluster",
DbInstanceStorageType = "cloud_essd",
});
var defaultGetInstanceClasses = AliCloud.Rds.GetInstanceClasses.Invoke(new()
{
ZoneId = @default.Apply(getZonesResult => getZonesResult.Ids[0]),
Engine = "MySQL",
EngineVersion = "8.0",
Category = "cluster",
DbInstanceStorageType = "cloud_essd",
InstanceChargeType = "PostPaid",
});
var defaultNetwork = new AliCloud.Vpc.Network("default", new()
{
VpcName = name,
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(getZonesResult => getZonesResult.Ids[0])),
VswitchName = name,
});
var defaultSecurityGroup = new AliCloud.Ecs.SecurityGroup("default", new()
{
Name = name,
VpcId = defaultNetwork.Id,
});
var defaultInstance = new AliCloud.Rds.Instance("default", new()
{
Engine = "MySQL",
EngineVersion = "8.0",
InstanceType = defaultGetInstanceClasses.Apply(getInstanceClassesResult => getInstanceClassesResult.InstanceClasses[0]?.InstanceClass),
InstanceStorage = defaultGetInstanceClasses.Apply(getInstanceClassesResult => getInstanceClassesResult.InstanceClasses[0]?.StorageRange?.Min),
InstanceChargeType = "Postpaid",
InstanceName = name,
VswitchId = defaultSwitch.Id,
MonitoringPeriod = 60,
DbInstanceStorageType = "cloud_essd",
SecurityGroupIds = new[]
{
defaultSecurityGroup.Id,
},
ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Ids[0])),
ZoneIdSlaveA = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Ids[0])),
});
var defaultDbNode = new AliCloud.Rds.DbNode("default", new()
{
DbInstanceId = defaultInstance.Id,
ClassCode = defaultInstance.InstanceType,
ZoneId = defaultSwitch.ZoneId,
});
var defaultDbInstanceEndpoint = new AliCloud.Rds.DbInstanceEndpoint("default", new()
{
DbInstanceId = defaultDbNode.DbInstanceId,
VpcId = defaultNetwork.Id,
VswitchId = defaultInstance.VswitchId,
ConnectionStringPrefix = "example",
Port = "3306",
DbInstanceEndpointDescription = name,
NodeItems = new[]
{
new AliCloud.Rds.Inputs.DbInstanceEndpointNodeItemArgs
{
NodeId = defaultDbNode.NodeId,
Weight = 25,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.rds.RdsFunctions;
import com.pulumi.alicloud.rds.inputs.GetZonesArgs;
import com.pulumi.alicloud.rds.inputs.GetInstanceClassesArgs;
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.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.rds.Instance;
import com.pulumi.alicloud.rds.InstanceArgs;
import com.pulumi.alicloud.rds.DbNode;
import com.pulumi.alicloud.rds.DbNodeArgs;
import com.pulumi.alicloud.rds.DbInstanceEndpoint;
import com.pulumi.alicloud.rds.DbInstanceEndpointArgs;
import com.pulumi.alicloud.rds.inputs.DbInstanceEndpointNodeItemArgs;
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 config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var default = RdsFunctions.getZones(GetZonesArgs.builder()
.engine("MySQL")
.engineVersion("8.0")
.instanceChargeType("PostPaid")
.category("cluster")
.dbInstanceStorageType("cloud_essd")
.build());
final var defaultGetInstanceClasses = RdsFunctions.getInstanceClasses(GetInstanceClassesArgs.builder()
.zoneId(default_.ids()[0])
.engine("MySQL")
.engineVersion("8.0")
.category("cluster")
.dbInstanceStorageType("cloud_essd")
.instanceChargeType("PostPaid")
.build());
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.vpcName(name)
.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_.ids()[0])
.vswitchName(name)
.build());
var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()
.name(name)
.vpcId(defaultNetwork.id())
.build());
var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.engine("MySQL")
.engineVersion("8.0")
.instanceType(defaultGetInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].instanceClass()))
.instanceStorage(defaultGetInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].storageRange().min()))
.instanceChargeType("Postpaid")
.instanceName(name)
.vswitchId(defaultSwitch.id())
.monitoringPeriod("60")
.dbInstanceStorageType("cloud_essd")
.securityGroupIds(defaultSecurityGroup.id())
.zoneId(default_.ids()[0])
.zoneIdSlaveA(default_.ids()[0])
.build());
var defaultDbNode = new DbNode("defaultDbNode", DbNodeArgs.builder()
.dbInstanceId(defaultInstance.id())
.classCode(defaultInstance.instanceType())
.zoneId(defaultSwitch.zoneId())
.build());
var defaultDbInstanceEndpoint = new DbInstanceEndpoint("defaultDbInstanceEndpoint", DbInstanceEndpointArgs.builder()
.dbInstanceId(defaultDbNode.dbInstanceId())
.vpcId(defaultNetwork.id())
.vswitchId(defaultInstance.vswitchId())
.connectionStringPrefix("example")
.port("3306")
.dbInstanceEndpointDescription(name)
.nodeItems(DbInstanceEndpointNodeItemArgs.builder()
.nodeId(defaultDbNode.nodeId())
.weight(25)
.build())
.build());
}
}
configuration:
name:
type: string
default: tf-example
resources:
defaultNetwork:
type: alicloud:vpc:Network
name: default
properties:
vpcName: ${name}
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.ids[0]}
vswitchName: ${name}
defaultSecurityGroup:
type: alicloud:ecs:SecurityGroup
name: default
properties:
name: ${name}
vpcId: ${defaultNetwork.id}
defaultInstance:
type: alicloud:rds:Instance
name: default
properties:
engine: MySQL
engineVersion: '8.0'
instanceType: ${defaultGetInstanceClasses.instanceClasses[0].instanceClass}
instanceStorage: ${defaultGetInstanceClasses.instanceClasses[0].storageRange.min}
instanceChargeType: Postpaid
instanceName: ${name}
vswitchId: ${defaultSwitch.id}
monitoringPeriod: '60'
dbInstanceStorageType: cloud_essd
securityGroupIds:
- ${defaultSecurityGroup.id}
zoneId: ${default.ids[0]}
zoneIdSlaveA: ${default.ids[0]}
defaultDbNode:
type: alicloud:rds:DbNode
name: default
properties:
dbInstanceId: ${defaultInstance.id}
classCode: ${defaultInstance.instanceType}
zoneId: ${defaultSwitch.zoneId}
defaultDbInstanceEndpoint:
type: alicloud:rds:DbInstanceEndpoint
name: default
properties:
dbInstanceId: ${defaultDbNode.dbInstanceId}
vpcId: ${defaultNetwork.id}
vswitchId: ${defaultInstance.vswitchId}
connectionStringPrefix: example
port: '3306'
dbInstanceEndpointDescription: ${name}
nodeItems:
- nodeId: ${defaultDbNode.nodeId}
weight: 25
variables:
default:
fn::invoke:
Function: alicloud:rds:getZones
Arguments:
engine: MySQL
engineVersion: '8.0'
instanceChargeType: PostPaid
category: cluster
dbInstanceStorageType: cloud_essd
defaultGetInstanceClasses:
fn::invoke:
Function: alicloud:rds:getInstanceClasses
Arguments:
zoneId: ${default.ids[0]}
engine: MySQL
engineVersion: '8.0'
category: cluster
dbInstanceStorageType: cloud_essd
instanceChargeType: PostPaid
Create DbInstanceEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DbInstanceEndpoint(name: string, args: DbInstanceEndpointArgs, opts?: CustomResourceOptions);
@overload
def DbInstanceEndpoint(resource_name: str,
args: DbInstanceEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DbInstanceEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
connection_string_prefix: Optional[str] = None,
db_instance_id: Optional[str] = None,
node_items: Optional[Sequence[DbInstanceEndpointNodeItemArgs]] = None,
port: Optional[str] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None,
db_instance_endpoint_description: Optional[str] = None)
func NewDbInstanceEndpoint(ctx *Context, name string, args DbInstanceEndpointArgs, opts ...ResourceOption) (*DbInstanceEndpoint, error)
public DbInstanceEndpoint(string name, DbInstanceEndpointArgs args, CustomResourceOptions? opts = null)
public DbInstanceEndpoint(String name, DbInstanceEndpointArgs args)
public DbInstanceEndpoint(String name, DbInstanceEndpointArgs args, CustomResourceOptions options)
type: alicloud:rds:DbInstanceEndpoint
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 DbInstanceEndpointArgs
- 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 DbInstanceEndpointArgs
- 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 DbInstanceEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DbInstanceEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DbInstanceEndpointArgs
- 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 dbInstanceEndpointResource = new AliCloud.Rds.DbInstanceEndpoint("dbInstanceEndpointResource", new()
{
ConnectionStringPrefix = "string",
DbInstanceId = "string",
NodeItems = new[]
{
new AliCloud.Rds.Inputs.DbInstanceEndpointNodeItemArgs
{
NodeId = "string",
Weight = 0,
},
},
Port = "string",
VpcId = "string",
VswitchId = "string",
DbInstanceEndpointDescription = "string",
});
example, err := rds.NewDbInstanceEndpoint(ctx, "dbInstanceEndpointResource", &rds.DbInstanceEndpointArgs{
ConnectionStringPrefix: pulumi.String("string"),
DbInstanceId: pulumi.String("string"),
NodeItems: rds.DbInstanceEndpointNodeItemArray{
&rds.DbInstanceEndpointNodeItemArgs{
NodeId: pulumi.String("string"),
Weight: pulumi.Int(0),
},
},
Port: pulumi.String("string"),
VpcId: pulumi.String("string"),
VswitchId: pulumi.String("string"),
DbInstanceEndpointDescription: pulumi.String("string"),
})
var dbInstanceEndpointResource = new DbInstanceEndpoint("dbInstanceEndpointResource", DbInstanceEndpointArgs.builder()
.connectionStringPrefix("string")
.dbInstanceId("string")
.nodeItems(DbInstanceEndpointNodeItemArgs.builder()
.nodeId("string")
.weight(0)
.build())
.port("string")
.vpcId("string")
.vswitchId("string")
.dbInstanceEndpointDescription("string")
.build());
db_instance_endpoint_resource = alicloud.rds.DbInstanceEndpoint("dbInstanceEndpointResource",
connection_string_prefix="string",
db_instance_id="string",
node_items=[alicloud.rds.DbInstanceEndpointNodeItemArgs(
node_id="string",
weight=0,
)],
port="string",
vpc_id="string",
vswitch_id="string",
db_instance_endpoint_description="string")
const dbInstanceEndpointResource = new alicloud.rds.DbInstanceEndpoint("dbInstanceEndpointResource", {
connectionStringPrefix: "string",
dbInstanceId: "string",
nodeItems: [{
nodeId: "string",
weight: 0,
}],
port: "string",
vpcId: "string",
vswitchId: "string",
dbInstanceEndpointDescription: "string",
});
type: alicloud:rds:DbInstanceEndpoint
properties:
connectionStringPrefix: string
dbInstanceEndpointDescription: string
dbInstanceId: string
nodeItems:
- nodeId: string
weight: 0
port: string
vpcId: string
vswitchId: string
DbInstanceEndpoint 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 DbInstanceEndpoint resource accepts the following input properties:
- Connection
String stringPrefix - The IP address of the internal endpoint.
- Db
Instance stringId - The ID of the instance.
- Node
Items List<Pulumi.Ali Cloud. Rds. Inputs. Db Instance Endpoint Node Item> - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - Port string
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- Vpc
Id string - The virtual private cloud (VPC) ID of the internal endpoint.
- Vswitch
Id string - The vSwitch ID of the internal endpoint.
- Db
Instance stringEndpoint Description - The user-defined description of the endpoint.
- Connection
String stringPrefix - The IP address of the internal endpoint.
- Db
Instance stringId - The ID of the instance.
- Node
Items []DbInstance Endpoint Node Item Args - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - Port string
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- Vpc
Id string - The virtual private cloud (VPC) ID of the internal endpoint.
- Vswitch
Id string - The vSwitch ID of the internal endpoint.
- Db
Instance stringEndpoint Description - The user-defined description of the endpoint.
- connection
String StringPrefix - The IP address of the internal endpoint.
- db
Instance StringId - The ID of the instance.
- node
Items List<DbInstance Endpoint Node Item> - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - port String
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- vpc
Id String - The virtual private cloud (VPC) ID of the internal endpoint.
- vswitch
Id String - The vSwitch ID of the internal endpoint.
- db
Instance StringEndpoint Description - The user-defined description of the endpoint.
- connection
String stringPrefix - The IP address of the internal endpoint.
- db
Instance stringId - The ID of the instance.
- node
Items DbInstance Endpoint Node Item[] - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - port string
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- vpc
Id string - The virtual private cloud (VPC) ID of the internal endpoint.
- vswitch
Id string - The vSwitch ID of the internal endpoint.
- db
Instance stringEndpoint Description - The user-defined description of the endpoint.
- connection_
string_ strprefix - The IP address of the internal endpoint.
- db_
instance_ strid - The ID of the instance.
- node_
items Sequence[DbInstance Endpoint Node Item Args] - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - port str
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- vpc_
id str - The virtual private cloud (VPC) ID of the internal endpoint.
- vswitch_
id str - The vSwitch ID of the internal endpoint.
- db_
instance_ strendpoint_ description - The user-defined description of the endpoint.
- connection
String StringPrefix - The IP address of the internal endpoint.
- db
Instance StringId - The ID of the instance.
- node
Items List<Property Map> - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - port String
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- vpc
Id String - The virtual private cloud (VPC) ID of the internal endpoint.
- vswitch
Id String - The vSwitch ID of the internal endpoint.
- db
Instance StringEndpoint Description - The user-defined description of the endpoint.
Outputs
All input properties are implicitly available as output properties. Additionally, the DbInstanceEndpoint resource produces the following output properties:
- Connection
String string - The internal endpoint.
- Db
Instance stringEndpoint Id - The Endpoint ID of the instance.
- Db
Instance stringEndpoint Type - The type of the endpoint.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Type string - The type of the IP address.
- Private
Ip stringAddress - The IP address of the internal endpoint.
- Connection
String string - The internal endpoint.
- Db
Instance stringEndpoint Id - The Endpoint ID of the instance.
- Db
Instance stringEndpoint Type - The type of the endpoint.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Type string - The type of the IP address.
- Private
Ip stringAddress - The IP address of the internal endpoint.
- connection
String String - The internal endpoint.
- db
Instance StringEndpoint Id - The Endpoint ID of the instance.
- db
Instance StringEndpoint Type - The type of the endpoint.
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Type String - The type of the IP address.
- private
Ip StringAddress - The IP address of the internal endpoint.
- connection
String string - The internal endpoint.
- db
Instance stringEndpoint Id - The Endpoint ID of the instance.
- db
Instance stringEndpoint Type - The type of the endpoint.
- id string
- The provider-assigned unique ID for this managed resource.
- ip
Type string - The type of the IP address.
- private
Ip stringAddress - The IP address of the internal endpoint.
- connection_
string str - The internal endpoint.
- db_
instance_ strendpoint_ id - The Endpoint ID of the instance.
- db_
instance_ strendpoint_ type - The type of the endpoint.
- id str
- The provider-assigned unique ID for this managed resource.
- ip_
type str - The type of the IP address.
- private_
ip_ straddress - The IP address of the internal endpoint.
- connection
String String - The internal endpoint.
- db
Instance StringEndpoint Id - The Endpoint ID of the instance.
- db
Instance StringEndpoint Type - The type of the endpoint.
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Type String - The type of the IP address.
- private
Ip StringAddress - The IP address of the internal endpoint.
Look up Existing DbInstanceEndpoint Resource
Get an existing DbInstanceEndpoint 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?: DbInstanceEndpointState, opts?: CustomResourceOptions): DbInstanceEndpoint
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
connection_string: Optional[str] = None,
connection_string_prefix: Optional[str] = None,
db_instance_endpoint_description: Optional[str] = None,
db_instance_endpoint_id: Optional[str] = None,
db_instance_endpoint_type: Optional[str] = None,
db_instance_id: Optional[str] = None,
ip_type: Optional[str] = None,
node_items: Optional[Sequence[DbInstanceEndpointNodeItemArgs]] = None,
port: Optional[str] = None,
private_ip_address: Optional[str] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None) -> DbInstanceEndpoint
func GetDbInstanceEndpoint(ctx *Context, name string, id IDInput, state *DbInstanceEndpointState, opts ...ResourceOption) (*DbInstanceEndpoint, error)
public static DbInstanceEndpoint Get(string name, Input<string> id, DbInstanceEndpointState? state, CustomResourceOptions? opts = null)
public static DbInstanceEndpoint get(String name, Output<String> id, DbInstanceEndpointState 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.
- Connection
String string - The internal endpoint.
- Connection
String stringPrefix - The IP address of the internal endpoint.
- Db
Instance stringEndpoint Description - The user-defined description of the endpoint.
- Db
Instance stringEndpoint Id - The Endpoint ID of the instance.
- Db
Instance stringEndpoint Type - The type of the endpoint.
- Db
Instance stringId - The ID of the instance.
- Ip
Type string - The type of the IP address.
- Node
Items List<Pulumi.Ali Cloud. Rds. Inputs. Db Instance Endpoint Node Item> - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - Port string
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- Private
Ip stringAddress - The IP address of the internal endpoint.
- Vpc
Id string - The virtual private cloud (VPC) ID of the internal endpoint.
- Vswitch
Id string - The vSwitch ID of the internal endpoint.
- Connection
String string - The internal endpoint.
- Connection
String stringPrefix - The IP address of the internal endpoint.
- Db
Instance stringEndpoint Description - The user-defined description of the endpoint.
- Db
Instance stringEndpoint Id - The Endpoint ID of the instance.
- Db
Instance stringEndpoint Type - The type of the endpoint.
- Db
Instance stringId - The ID of the instance.
- Ip
Type string - The type of the IP address.
- Node
Items []DbInstance Endpoint Node Item Args - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - Port string
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- Private
Ip stringAddress - The IP address of the internal endpoint.
- Vpc
Id string - The virtual private cloud (VPC) ID of the internal endpoint.
- Vswitch
Id string - The vSwitch ID of the internal endpoint.
- connection
String String - The internal endpoint.
- connection
String StringPrefix - The IP address of the internal endpoint.
- db
Instance StringEndpoint Description - The user-defined description of the endpoint.
- db
Instance StringEndpoint Id - The Endpoint ID of the instance.
- db
Instance StringEndpoint Type - The type of the endpoint.
- db
Instance StringId - The ID of the instance.
- ip
Type String - The type of the IP address.
- node
Items List<DbInstance Endpoint Node Item> - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - port String
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- private
Ip StringAddress - The IP address of the internal endpoint.
- vpc
Id String - The virtual private cloud (VPC) ID of the internal endpoint.
- vswitch
Id String - The vSwitch ID of the internal endpoint.
- connection
String string - The internal endpoint.
- connection
String stringPrefix - The IP address of the internal endpoint.
- db
Instance stringEndpoint Description - The user-defined description of the endpoint.
- db
Instance stringEndpoint Id - The Endpoint ID of the instance.
- db
Instance stringEndpoint Type - The type of the endpoint.
- db
Instance stringId - The ID of the instance.
- ip
Type string - The type of the IP address.
- node
Items DbInstance Endpoint Node Item[] - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - port string
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- private
Ip stringAddress - The IP address of the internal endpoint.
- vpc
Id string - The virtual private cloud (VPC) ID of the internal endpoint.
- vswitch
Id string - The vSwitch ID of the internal endpoint.
- connection_
string str - The internal endpoint.
- connection_
string_ strprefix - The IP address of the internal endpoint.
- db_
instance_ strendpoint_ description - The user-defined description of the endpoint.
- db_
instance_ strendpoint_ id - The Endpoint ID of the instance.
- db_
instance_ strendpoint_ type - The type of the endpoint.
- db_
instance_ strid - The ID of the instance.
- ip_
type str - The type of the IP address.
- node_
items Sequence[DbInstance Endpoint Node Item Args] - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - port str
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- private_
ip_ straddress - The IP address of the internal endpoint.
- vpc_
id str - The virtual private cloud (VPC) ID of the internal endpoint.
- vswitch_
id str - The vSwitch ID of the internal endpoint.
- connection
String String - The internal endpoint.
- connection
String StringPrefix - The IP address of the internal endpoint.
- db
Instance StringEndpoint Description - The user-defined description of the endpoint.
- db
Instance StringEndpoint Id - The Endpoint ID of the instance.
- db
Instance StringEndpoint Type - The type of the endpoint.
- db
Instance StringId - The ID of the instance.
- ip
Type String - The type of the IP address.
- node
Items List<Property Map> - The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See
node_items
below. - port String
- The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
- private
Ip StringAddress - The IP address of the internal endpoint.
- vpc
Id String - The virtual private cloud (VPC) ID of the internal endpoint.
- vswitch
Id String - The vSwitch ID of the internal endpoint.
Supporting Types
DbInstanceEndpointNodeItem, DbInstanceEndpointNodeItemArgs
Import
RDS database endpoint feature can be imported using the id, e.g.
$ pulumi import alicloud:rds/dbInstanceEndpoint:DbInstanceEndpoint example <db_instance_id>:<db_instance_endpoint_id>
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.