alicloud logo
Alibaba Cloud v3.37.0, May 15 23

alicloud.rds.DbInstanceEndpoint

Explore with Pulumi AI

Provide RDS cluster instance endpoint connection resources.

NOTE: Available in 1.203.0+.

Block node_items

The node_items mapping supports the following:

  • node_id - (Required) The ID of the node.
  • weight - (Required) The weight of the node. Read requests are distributed based on the weight.Valid values: 0 to 100.

Create DbInstanceEndpoint Resource

new DbInstanceEndpoint(name: string, args: DbInstanceEndpointArgs, opts?: CustomResourceOptions);
@overload
def DbInstanceEndpoint(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       connection_string_prefix: Optional[str] = None,
                       db_instance_endpoint_description: 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)
@overload
def DbInstanceEndpoint(resource_name: str,
                       args: DbInstanceEndpointArgs,
                       opts: Optional[ResourceOptions] = 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.

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.

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:

ConnectionStringPrefix string

The IP address of the internal endpoint.

DbInstanceId string

The ID of the instance.

NodeItems List<Pulumi.AliCloud.Rds.Inputs.DbInstanceEndpointNodeItemArgs>

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

Port string

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

VpcId string

The virtual private cloud (VPC) ID of the internal endpoint.

VswitchId string

The vSwitch ID of the internal endpoint.

DbInstanceEndpointDescription string

The user-defined description of the endpoint.

ConnectionStringPrefix string

The IP address of the internal endpoint.

DbInstanceId string

The ID of the instance.

NodeItems []DbInstanceEndpointNodeItemArgs

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

Port string

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

VpcId string

The virtual private cloud (VPC) ID of the internal endpoint.

VswitchId string

The vSwitch ID of the internal endpoint.

DbInstanceEndpointDescription string

The user-defined description of the endpoint.

connectionStringPrefix String

The IP address of the internal endpoint.

dbInstanceId String

The ID of the instance.

nodeItems List<DbInstanceEndpointNodeItemArgs>

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

port String

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

vpcId String

The virtual private cloud (VPC) ID of the internal endpoint.

vswitchId String

The vSwitch ID of the internal endpoint.

dbInstanceEndpointDescription String

The user-defined description of the endpoint.

connectionStringPrefix string

The IP address of the internal endpoint.

dbInstanceId string

The ID of the instance.

nodeItems DbInstanceEndpointNodeItemArgs[]

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

port string

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

vpcId string

The virtual private cloud (VPC) ID of the internal endpoint.

vswitchId string

The vSwitch ID of the internal endpoint.

dbInstanceEndpointDescription string

The user-defined description of the endpoint.

connection_string_prefix str

The IP address of the internal endpoint.

db_instance_id str

The ID of the instance.

node_items Sequence[DbInstanceEndpointNodeItemArgs]

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

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_endpoint_description str

The user-defined description of the endpoint.

connectionStringPrefix String

The IP address of the internal endpoint.

dbInstanceId String

The ID of the instance.

nodeItems List<Property Map>

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

port String

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

vpcId String

The virtual private cloud (VPC) ID of the internal endpoint.

vswitchId String

The vSwitch ID of the internal endpoint.

dbInstanceEndpointDescription String

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:

ConnectionString string

The internal endpoint.

DbInstanceEndpointId string

The Endpoint ID of the instance.

DbInstanceEndpointType string

The type of the endpoint.

Id string

The provider-assigned unique ID for this managed resource.

IpType string

The type of the IP address.

PrivateIpAddress string

The IP address of the internal endpoint.

ConnectionString string

The internal endpoint.

DbInstanceEndpointId string

The Endpoint ID of the instance.

DbInstanceEndpointType string

The type of the endpoint.

Id string

The provider-assigned unique ID for this managed resource.

IpType string

The type of the IP address.

PrivateIpAddress string

The IP address of the internal endpoint.

connectionString String

The internal endpoint.

dbInstanceEndpointId String

The Endpoint ID of the instance.

dbInstanceEndpointType String

The type of the endpoint.

id String

The provider-assigned unique ID for this managed resource.

ipType String

The type of the IP address.

privateIpAddress String

The IP address of the internal endpoint.

connectionString string

The internal endpoint.

dbInstanceEndpointId string

The Endpoint ID of the instance.

dbInstanceEndpointType string

The type of the endpoint.

id string

The provider-assigned unique ID for this managed resource.

ipType string

The type of the IP address.

privateIpAddress string

The IP address of the internal endpoint.

connection_string str

The internal endpoint.

db_instance_endpoint_id str

The Endpoint ID of the instance.

db_instance_endpoint_type str

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_address str

The IP address of the internal endpoint.

connectionString String

The internal endpoint.

dbInstanceEndpointId String

The Endpoint ID of the instance.

dbInstanceEndpointType String

The type of the endpoint.

id String

The provider-assigned unique ID for this managed resource.

ipType String

The type of the IP address.

privateIpAddress String

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.
The following state arguments are supported:
ConnectionString string

The internal endpoint.

ConnectionStringPrefix string

The IP address of the internal endpoint.

DbInstanceEndpointDescription string

The user-defined description of the endpoint.

DbInstanceEndpointId string

The Endpoint ID of the instance.

DbInstanceEndpointType string

The type of the endpoint.

DbInstanceId string

The ID of the instance.

IpType string

The type of the IP address.

NodeItems List<Pulumi.AliCloud.Rds.Inputs.DbInstanceEndpointNodeItemArgs>

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

Port string

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

PrivateIpAddress string

The IP address of the internal endpoint.

VpcId string

The virtual private cloud (VPC) ID of the internal endpoint.

VswitchId string

The vSwitch ID of the internal endpoint.

ConnectionString string

The internal endpoint.

ConnectionStringPrefix string

The IP address of the internal endpoint.

DbInstanceEndpointDescription string

The user-defined description of the endpoint.

DbInstanceEndpointId string

The Endpoint ID of the instance.

DbInstanceEndpointType string

The type of the endpoint.

DbInstanceId string

The ID of the instance.

IpType string

The type of the IP address.

NodeItems []DbInstanceEndpointNodeItemArgs

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

Port string

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

PrivateIpAddress string

The IP address of the internal endpoint.

VpcId string

The virtual private cloud (VPC) ID of the internal endpoint.

VswitchId string

The vSwitch ID of the internal endpoint.

connectionString String

The internal endpoint.

connectionStringPrefix String

The IP address of the internal endpoint.

dbInstanceEndpointDescription String

The user-defined description of the endpoint.

dbInstanceEndpointId String

The Endpoint ID of the instance.

dbInstanceEndpointType String

The type of the endpoint.

dbInstanceId String

The ID of the instance.

ipType String

The type of the IP address.

nodeItems List<DbInstanceEndpointNodeItemArgs>

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

port String

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

privateIpAddress String

The IP address of the internal endpoint.

vpcId String

The virtual private cloud (VPC) ID of the internal endpoint.

vswitchId String

The vSwitch ID of the internal endpoint.

connectionString string

The internal endpoint.

connectionStringPrefix string

The IP address of the internal endpoint.

dbInstanceEndpointDescription string

The user-defined description of the endpoint.

dbInstanceEndpointId string

The Endpoint ID of the instance.

dbInstanceEndpointType string

The type of the endpoint.

dbInstanceId string

The ID of the instance.

ipType string

The type of the IP address.

nodeItems DbInstanceEndpointNodeItemArgs[]

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

port string

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

privateIpAddress string

The IP address of the internal endpoint.

vpcId string

The virtual private cloud (VPC) ID of the internal endpoint.

vswitchId string

The vSwitch ID of the internal endpoint.

connection_string str

The internal endpoint.

connection_string_prefix str

The IP address of the internal endpoint.

db_instance_endpoint_description str

The user-defined description of the endpoint.

db_instance_endpoint_id str

The Endpoint ID of the instance.

db_instance_endpoint_type str

The type of the endpoint.

db_instance_id str

The ID of the instance.

ip_type str

The type of the IP address.

node_items Sequence[DbInstanceEndpointNodeItemArgs]

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

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_address str

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.

connectionString String

The internal endpoint.

connectionStringPrefix String

The IP address of the internal endpoint.

dbInstanceEndpointDescription String

The user-defined description of the endpoint.

dbInstanceEndpointId String

The Endpoint ID of the instance.

dbInstanceEndpointType String

The type of the endpoint.

dbInstanceId String

The ID of the instance.

ipType String

The type of the IP address.

nodeItems List<Property Map>

The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight).

port String

The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.

privateIpAddress String

The IP address of the internal endpoint.

vpcId String

The virtual private cloud (VPC) ID of the internal endpoint.

vswitchId String

The vSwitch ID of the internal endpoint.

Supporting Types

DbInstanceEndpointNodeItem

NodeId string
Weight int
NodeId string
Weight int
nodeId String
weight Integer
nodeId string
weight number
nodeId String
weight Number

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>

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.