1. Packages
  2. Volcengine
  3. API Docs
  4. nlb
  5. BackendServer
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.nlb.BackendServer

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Create BackendServer Resource

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

    Constructor syntax

    new BackendServer(name: string, args: BackendServerArgs, opts?: CustomResourceOptions);
    @overload
def BackendServer(resource_name: str,
                  args: BackendServerArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def BackendServer(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  backend_servers: Optional[Sequence[BackendServerBackendServerArgs]] = None,
                  server_group_id: Optional[str] = None)
    func NewBackendServer(ctx *Context, name string, args BackendServerArgs, opts ...ResourceOption) (*BackendServer, error)
    public BackendServer(string name, BackendServerArgs args, CustomResourceOptions? opts = null)
    public BackendServer(String name, BackendServerArgs args)
public BackendServer(String name, BackendServerArgs args, CustomResourceOptions options)

    type: volcengine:nlb:BackendServer
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 BackendServerArgs
    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 BackendServerArgs
    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 BackendServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackendServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackendServerArgs
    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 backendServerResource = new Volcengine.Nlb.BackendServer("backendServerResource", new()
{
    BackendServers = new[]
    {
        new Volcengine.Nlb.Inputs.BackendServerBackendServerArgs
        {
            InstanceId = "string",
            Ip = "string",
            Port = 0,
            Type = "string",
            Description = "string",
            ServerId = "string",
            Weight = 0,
            ZoneId = "string",
        },
    },
    ServerGroupId = "string",
});

    example, err := nlb.NewBackendServer(ctx, "backendServerResource", &nlb.BackendServerArgs{
	BackendServers: nlb.BackendServerBackendServerArray{
		&nlb.BackendServerBackendServerArgs{
			InstanceId:  pulumi.String("string"),
			Ip:          pulumi.String("string"),
			Port:        pulumi.Int(0),
			Type:        pulumi.String("string"),
			Description: pulumi.String("string"),
			ServerId:    pulumi.String("string"),
			Weight:      pulumi.Int(0),
			ZoneId:      pulumi.String("string"),
		},
	},
	ServerGroupId: pulumi.String("string"),
})

    var backendServerResource = new BackendServer("backendServerResource", BackendServerArgs.builder()
    .backendServers(BackendServerBackendServerArgs.builder()
        .instanceId("string")
        .ip("string")
        .port(0)
        .type("string")
        .description("string")
        .serverId("string")
        .weight(0)
        .zoneId("string")
        .build())
    .serverGroupId("string")
    .build());

    backend_server_resource = volcengine.nlb.BackendServer("backendServerResource",
    backend_servers=[{
        "instance_id": "string",
        "ip": "string",
        "port": 0,
        "type": "string",
        "description": "string",
        "server_id": "string",
        "weight": 0,
        "zone_id": "string",
    }],
    server_group_id="string")

    const backendServerResource = new volcengine.nlb.BackendServer("backendServerResource", {
    backendServers: [{
        instanceId: "string",
        ip: "string",
        port: 0,
        type: "string",
        description: "string",
        serverId: "string",
        weight: 0,
        zoneId: "string",
    }],
    serverGroupId: "string",
});

    type: volcengine:nlb:BackendServer
properties:
    backendServers:
        - description: string
          instanceId: string
          ip: string
          port: 0
          serverId: string
          type: string
          weight: 0
          zoneId: string
    serverGroupId: string

    BackendServer 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 BackendServer resource accepts the following input properties:

    BackendServers List<BackendServerBackendServer>
    The list of backend servers.
    ServerGroupId string
    The id of the server group.
    BackendServers []BackendServerBackendServerArgs
    The list of backend servers.
    ServerGroupId string
    The id of the server group.
    backendServers List<BackendServerBackendServer>
    The list of backend servers.
    serverGroupId String
    The id of the server group.
    backendServers BackendServerBackendServer[]
    The list of backend servers.
    serverGroupId string
    The id of the server group.
    backend_servers Sequence[BackendServerBackendServerArgs]
    The list of backend servers.
    server_group_id str
    The id of the server group.
    backendServers List<Property Map>
    The list of backend servers.
    serverGroupId String
    The id of the server group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BackendServer Resource

    Get an existing BackendServer 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?: BackendServerState, opts?: CustomResourceOptions): BackendServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend_servers: Optional[Sequence[BackendServerBackendServerArgs]] = None,
        server_group_id: Optional[str] = None) -> BackendServer
    func GetBackendServer(ctx *Context, name string, id IDInput, state *BackendServerState, opts ...ResourceOption) (*BackendServer, error)
    public static BackendServer Get(string name, Input<string> id, BackendServerState? state, CustomResourceOptions? opts = null)
    public static BackendServer get(String name, Output<String> id, BackendServerState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:nlb:BackendServer    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:
    BackendServers List<BackendServerBackendServer>
    The list of backend servers.
    ServerGroupId string
    The id of the server group.
    BackendServers []BackendServerBackendServerArgs
    The list of backend servers.
    ServerGroupId string
    The id of the server group.
    backendServers List<BackendServerBackendServer>
    The list of backend servers.
    serverGroupId String
    The id of the server group.
    backendServers BackendServerBackendServer[]
    The list of backend servers.
    serverGroupId string
    The id of the server group.
    backend_servers Sequence[BackendServerBackendServerArgs]
    The list of backend servers.
    server_group_id str
    The id of the server group.
    backendServers List<Property Map>
    The list of backend servers.
    serverGroupId String
    The id of the server group.

    Supporting Types

    BackendServerBackendServer, BackendServerBackendServerArgs

    InstanceId string
    The instance id of the backend server.
    Ip string
    The ip of the backend server.
    Port int
    The port of the backend server.
    Type string
    The type of the backend server. Valid values: ecs, eni, ip.
    Description string
    The description of the backend server.
    ServerId string
    The server id of the backend server.
    Weight int
    The weight of the backend server.
    ZoneId string
    The zone id of the backend server.
    InstanceId string
    The instance id of the backend server.
    Ip string
    The ip of the backend server.
    Port int
    The port of the backend server.
    Type string
    The type of the backend server. Valid values: ecs, eni, ip.
    Description string
    The description of the backend server.
    ServerId string
    The server id of the backend server.
    Weight int
    The weight of the backend server.
    ZoneId string
    The zone id of the backend server.
    instanceId String
    The instance id of the backend server.
    ip String
    The ip of the backend server.
    port Integer
    The port of the backend server.
    type String
    The type of the backend server. Valid values: ecs, eni, ip.
    description String
    The description of the backend server.
    serverId String
    The server id of the backend server.
    weight Integer
    The weight of the backend server.
    zoneId String
    The zone id of the backend server.
    instanceId string
    The instance id of the backend server.
    ip string
    The ip of the backend server.
    port number
    The port of the backend server.
    type string
    The type of the backend server. Valid values: ecs, eni, ip.
    description string
    The description of the backend server.
    serverId string
    The server id of the backend server.
    weight number
    The weight of the backend server.
    zoneId string
    The zone id of the backend server.
    instance_id str
    The instance id of the backend server.
    ip str
    The ip of the backend server.
    port int
    The port of the backend server.
    type str
    The type of the backend server. Valid values: ecs, eni, ip.
    description str
    The description of the backend server.
    server_id str
    The server id of the backend server.
    weight int
    The weight of the backend server.
    zone_id str
    The zone id of the backend server.
    instanceId String
    The instance id of the backend server.
    ip String
    The ip of the backend server.
    port Number
    The port of the backend server.
    type String
    The type of the backend server. Valid values: ecs, eni, ip.
    description String
    The description of the backend server.
    serverId String
    The server id of the backend server.
    weight Number
    The weight of the backend server.
    zoneId String
    The zone id of the backend server.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.