Alibaba Cloud v3.37.0, May 15 23
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:
- 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 Args> 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.
- 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).
- 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 Args> 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.
- 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).
- 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).
- 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).
- 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 Args> 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.
- 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).
- 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 Args> 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.
- 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).
- 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).
- 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).
- 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
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.