1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. LbMemberV3
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.LbMemberV3

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for DLB member you can get at documentation portal

    Manages a Dedicated Load Balancer member resource within OpenTelekomCloud.

    Create LbMemberV3 Resource

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

    Constructor syntax

    new LbMemberV3(name: string, args: LbMemberV3Args, opts?: CustomResourceOptions);
    @overload
    def LbMemberV3(resource_name: str,
                   args: LbMemberV3Args,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def LbMemberV3(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   address: Optional[str] = None,
                   pool_id: Optional[str] = None,
                   protocol_port: Optional[float] = None,
                   lb_member_v3_id: Optional[str] = None,
                   name: Optional[str] = None,
                   project_id: Optional[str] = None,
                   subnet_id: Optional[str] = None,
                   weight: Optional[float] = None)
    func NewLbMemberV3(ctx *Context, name string, args LbMemberV3Args, opts ...ResourceOption) (*LbMemberV3, error)
    public LbMemberV3(string name, LbMemberV3Args args, CustomResourceOptions? opts = null)
    public LbMemberV3(String name, LbMemberV3Args args)
    public LbMemberV3(String name, LbMemberV3Args args, CustomResourceOptions options)
    
    type: opentelekomcloud:LbMemberV3
    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 LbMemberV3Args
    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 LbMemberV3Args
    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 LbMemberV3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbMemberV3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbMemberV3Args
    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 lbMemberV3Resource = new Opentelekomcloud.LbMemberV3("lbMemberV3Resource", new()
    {
        Address = "string",
        PoolId = "string",
        ProtocolPort = 0,
        LbMemberV3Id = "string",
        Name = "string",
        ProjectId = "string",
        SubnetId = "string",
        Weight = 0,
    });
    
    example, err := opentelekomcloud.NewLbMemberV3(ctx, "lbMemberV3Resource", &opentelekomcloud.LbMemberV3Args{
    	Address:      pulumi.String("string"),
    	PoolId:       pulumi.String("string"),
    	ProtocolPort: pulumi.Float64(0),
    	LbMemberV3Id: pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	SubnetId:     pulumi.String("string"),
    	Weight:       pulumi.Float64(0),
    })
    
    var lbMemberV3Resource = new LbMemberV3("lbMemberV3Resource", LbMemberV3Args.builder()
        .address("string")
        .poolId("string")
        .protocolPort(0)
        .lbMemberV3Id("string")
        .name("string")
        .projectId("string")
        .subnetId("string")
        .weight(0)
        .build());
    
    lb_member_v3_resource = opentelekomcloud.LbMemberV3("lbMemberV3Resource",
        address="string",
        pool_id="string",
        protocol_port=0,
        lb_member_v3_id="string",
        name="string",
        project_id="string",
        subnet_id="string",
        weight=0)
    
    const lbMemberV3Resource = new opentelekomcloud.LbMemberV3("lbMemberV3Resource", {
        address: "string",
        poolId: "string",
        protocolPort: 0,
        lbMemberV3Id: "string",
        name: "string",
        projectId: "string",
        subnetId: "string",
        weight: 0,
    });
    
    type: opentelekomcloud:LbMemberV3
    properties:
        address: string
        lbMemberV3Id: string
        name: string
        poolId: string
        projectId: string
        protocolPort: 0
        subnetId: string
        weight: 0
    

    LbMemberV3 Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LbMemberV3 resource accepts the following input properties:

    Address string

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    PoolId string
    ProtocolPort double
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    LbMemberV3Id string
    Name string
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    ProjectId string
    Specifies the project ID.
    SubnetId string

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    Weight double

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    Address string

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    PoolId string
    ProtocolPort float64
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    LbMemberV3Id string
    Name string
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    ProjectId string
    Specifies the project ID.
    SubnetId string

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    Weight float64

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    address String

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    poolId String
    protocolPort Double
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    lbMemberV3Id String
    name String
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    projectId String
    Specifies the project ID.
    subnetId String

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    weight Double

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    address string

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    poolId string
    protocolPort number
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    lbMemberV3Id string
    name string
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    projectId string
    Specifies the project ID.
    subnetId string

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    weight number

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    address str

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    pool_id str
    protocol_port float
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    lb_member_v3_id str
    name str
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    project_id str
    Specifies the project ID.
    subnet_id str

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    weight float

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    address String

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    poolId String
    protocolPort Number
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    lbMemberV3Id String
    name String
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    projectId String
    Specifies the project ID.
    subnetId String

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    weight Number

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LbMemberV3 resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IpVersion string
    Version of IP based on the address parameter. The value can be v4 or v6.
    MemberId string
    ID of the pool member.
    OperatingStatus string
    Specifies the operating status of the backend server.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpVersion string
    Version of IP based on the address parameter. The value can be v4 or v6.
    MemberId string
    ID of the pool member.
    OperatingStatus string
    Specifies the operating status of the backend server.
    id String
    The provider-assigned unique ID for this managed resource.
    ipVersion String
    Version of IP based on the address parameter. The value can be v4 or v6.
    memberId String
    ID of the pool member.
    operatingStatus String
    Specifies the operating status of the backend server.
    id string
    The provider-assigned unique ID for this managed resource.
    ipVersion string
    Version of IP based on the address parameter. The value can be v4 or v6.
    memberId string
    ID of the pool member.
    operatingStatus string
    Specifies the operating status of the backend server.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_version str
    Version of IP based on the address parameter. The value can be v4 or v6.
    member_id str
    ID of the pool member.
    operating_status str
    Specifies the operating status of the backend server.
    id String
    The provider-assigned unique ID for this managed resource.
    ipVersion String
    Version of IP based on the address parameter. The value can be v4 or v6.
    memberId String
    ID of the pool member.
    operatingStatus String
    Specifies the operating status of the backend server.

    Look up Existing LbMemberV3 Resource

    Get an existing LbMemberV3 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?: LbMemberV3State, opts?: CustomResourceOptions): LbMemberV3
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            ip_version: Optional[str] = None,
            lb_member_v3_id: Optional[str] = None,
            member_id: Optional[str] = None,
            name: Optional[str] = None,
            operating_status: Optional[str] = None,
            pool_id: Optional[str] = None,
            project_id: Optional[str] = None,
            protocol_port: Optional[float] = None,
            subnet_id: Optional[str] = None,
            weight: Optional[float] = None) -> LbMemberV3
    func GetLbMemberV3(ctx *Context, name string, id IDInput, state *LbMemberV3State, opts ...ResourceOption) (*LbMemberV3, error)
    public static LbMemberV3 Get(string name, Input<string> id, LbMemberV3State? state, CustomResourceOptions? opts = null)
    public static LbMemberV3 get(String name, Output<String> id, LbMemberV3State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:LbMemberV3    get:      id: ${id}
    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:
    Address string

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    IpVersion string
    Version of IP based on the address parameter. The value can be v4 or v6.
    LbMemberV3Id string
    MemberId string
    ID of the pool member.
    Name string
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    OperatingStatus string
    Specifies the operating status of the backend server.
    PoolId string
    ProjectId string
    Specifies the project ID.
    ProtocolPort double
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    SubnetId string

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    Weight double

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    Address string

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    IpVersion string
    Version of IP based on the address parameter. The value can be v4 or v6.
    LbMemberV3Id string
    MemberId string
    ID of the pool member.
    Name string
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    OperatingStatus string
    Specifies the operating status of the backend server.
    PoolId string
    ProjectId string
    Specifies the project ID.
    ProtocolPort float64
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    SubnetId string

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    Weight float64

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    address String

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    ipVersion String
    Version of IP based on the address parameter. The value can be v4 or v6.
    lbMemberV3Id String
    memberId String
    ID of the pool member.
    name String
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    operatingStatus String
    Specifies the operating status of the backend server.
    poolId String
    projectId String
    Specifies the project ID.
    protocolPort Double
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    subnetId String

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    weight Double

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    address string

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    ipVersion string
    Version of IP based on the address parameter. The value can be v4 or v6.
    lbMemberV3Id string
    memberId string
    ID of the pool member.
    name string
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    operatingStatus string
    Specifies the operating status of the backend server.
    poolId string
    projectId string
    Specifies the project ID.
    protocolPort number
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    subnetId string

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    weight number

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    address str

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    ip_version str
    Version of IP based on the address parameter. The value can be v4 or v6.
    lb_member_v3_id str
    member_id str
    ID of the pool member.
    name str
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    operating_status str
    Specifies the operating status of the backend server.
    pool_id str
    project_id str
    Specifies the project ID.
    protocol_port float
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    subnet_id str

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    weight float

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    address String

    Specifies the IP address of the backend server.

    The IP address must be in the subnet specified by subnet_id, for example, 192.168.3.11.

    The IP address can only be the IP address of the primary NIC.

    If subnet_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    ipVersion String
    Version of IP based on the address parameter. The value can be v4 or v6.
    lbMemberV3Id String
    memberId String
    ID of the pool member.
    name String
    Specifies the backend server name. The value is a string of 0 to 255 characters.
    operatingStatus String
    Specifies the operating status of the backend server.
    poolId String
    projectId String
    Specifies the project ID.
    protocolPort Number
    Specifies the port used by the backend server to receive requests. The value should be a valid port.
    subnetId String

    Specifies the ID of the subnet where the backend server works.

    This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated.

    Only IPv4 subnets are supported.

    weight Number

    Specifies the weight of the backend server.

    Requests are routed to backend servers in the same backend server group based on their weights.

    If the weight is 0, the backend server will not accept new requests.

    This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

    Import

    Members can be imported using the pool_id/member_id, e.g.

    $ pulumi import opentelekomcloud:index/lbMemberV3:LbMemberV3 member 7b80e108-1636-44e5-aece-986b0052b7dd/1bb93b8b-37a4-4b50-92cc-daa4c89d4e4c
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud