1. Packages
  2. Linode
  3. API Docs
  4. NodeBalancerNode
Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi

linode.NodeBalancerNode

Explore with Pulumi AI

linode logo
Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi

    Provides a Linode NodeBalancer Node resource. This can be used to create, modify, and delete Linodes NodeBalancer Nodes. For more information, see Getting Started with NodeBalancers and the Linode APIv4 docs.

    Create NodeBalancerNode Resource

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

    Constructor syntax

    new NodeBalancerNode(name: string, args: NodeBalancerNodeArgs, opts?: CustomResourceOptions);
    @overload
    def NodeBalancerNode(resource_name: str,
                         args: NodeBalancerNodeArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def NodeBalancerNode(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         address: Optional[str] = None,
                         config_id: Optional[int] = None,
                         label: Optional[str] = None,
                         nodebalancer_id: Optional[int] = None,
                         mode: Optional[str] = None,
                         weight: Optional[int] = None)
    func NewNodeBalancerNode(ctx *Context, name string, args NodeBalancerNodeArgs, opts ...ResourceOption) (*NodeBalancerNode, error)
    public NodeBalancerNode(string name, NodeBalancerNodeArgs args, CustomResourceOptions? opts = null)
    public NodeBalancerNode(String name, NodeBalancerNodeArgs args)
    public NodeBalancerNode(String name, NodeBalancerNodeArgs args, CustomResourceOptions options)
    
    type: linode:NodeBalancerNode
    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 NodeBalancerNodeArgs
    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 NodeBalancerNodeArgs
    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 NodeBalancerNodeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NodeBalancerNodeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NodeBalancerNodeArgs
    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 nodeBalancerNodeResource = new Linode.NodeBalancerNode("nodeBalancerNodeResource", new()
    {
        Address = "string",
        ConfigId = 0,
        Label = "string",
        NodebalancerId = 0,
        Mode = "string",
        Weight = 0,
    });
    
    example, err := linode.NewNodeBalancerNode(ctx, "nodeBalancerNodeResource", &linode.NodeBalancerNodeArgs{
    	Address:        pulumi.String("string"),
    	ConfigId:       pulumi.Int(0),
    	Label:          pulumi.String("string"),
    	NodebalancerId: pulumi.Int(0),
    	Mode:           pulumi.String("string"),
    	Weight:         pulumi.Int(0),
    })
    
    var nodeBalancerNodeResource = new NodeBalancerNode("nodeBalancerNodeResource", NodeBalancerNodeArgs.builder()
        .address("string")
        .configId(0)
        .label("string")
        .nodebalancerId(0)
        .mode("string")
        .weight(0)
        .build());
    
    node_balancer_node_resource = linode.NodeBalancerNode("nodeBalancerNodeResource",
        address="string",
        config_id=0,
        label="string",
        nodebalancer_id=0,
        mode="string",
        weight=0)
    
    const nodeBalancerNodeResource = new linode.NodeBalancerNode("nodeBalancerNodeResource", {
        address: "string",
        configId: 0,
        label: "string",
        nodebalancerId: 0,
        mode: "string",
        weight: 0,
    });
    
    type: linode:NodeBalancerNode
    properties:
        address: string
        configId: 0
        label: string
        mode: string
        nodebalancerId: 0
        weight: 0
    

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

    Address string
    The private IP Address where this backend can be reached. This must be a private IP address.


    ConfigId int
    The ID of the NodeBalancerConfig to access.
    Label string
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    NodebalancerId int
    The ID of the NodeBalancer to access.
    Mode string
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    Weight int
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    Address string
    The private IP Address where this backend can be reached. This must be a private IP address.


    ConfigId int
    The ID of the NodeBalancerConfig to access.
    Label string
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    NodebalancerId int
    The ID of the NodeBalancer to access.
    Mode string
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    Weight int
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    address String
    The private IP Address where this backend can be reached. This must be a private IP address.


    configId Integer
    The ID of the NodeBalancerConfig to access.
    label String
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    nodebalancerId Integer
    The ID of the NodeBalancer to access.
    mode String
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    weight Integer
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    address string
    The private IP Address where this backend can be reached. This must be a private IP address.


    configId number
    The ID of the NodeBalancerConfig to access.
    label string
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    nodebalancerId number
    The ID of the NodeBalancer to access.
    mode string
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    weight number
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    address str
    The private IP Address where this backend can be reached. This must be a private IP address.


    config_id int
    The ID of the NodeBalancerConfig to access.
    label str
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    nodebalancer_id int
    The ID of the NodeBalancer to access.
    mode str
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    weight int
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    address String
    The private IP Address where this backend can be reached. This must be a private IP address.


    configId Number
    The ID of the NodeBalancerConfig to access.
    label String
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    nodebalancerId Number
    The ID of the NodeBalancer to access.
    mode String
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    weight Number
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).

    Look up Existing NodeBalancerNode Resource

    Get an existing NodeBalancerNode 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?: NodeBalancerNodeState, opts?: CustomResourceOptions): NodeBalancerNode
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            config_id: Optional[int] = None,
            label: Optional[str] = None,
            mode: Optional[str] = None,
            nodebalancer_id: Optional[int] = None,
            status: Optional[str] = None,
            weight: Optional[int] = None) -> NodeBalancerNode
    func GetNodeBalancerNode(ctx *Context, name string, id IDInput, state *NodeBalancerNodeState, opts ...ResourceOption) (*NodeBalancerNode, error)
    public static NodeBalancerNode Get(string name, Input<string> id, NodeBalancerNodeState? state, CustomResourceOptions? opts = null)
    public static NodeBalancerNode get(String name, Output<String> id, NodeBalancerNodeState 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:
    Address string
    The private IP Address where this backend can be reached. This must be a private IP address.


    ConfigId int
    The ID of the NodeBalancerConfig to access.
    Label string
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    Mode string
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    NodebalancerId int
    The ID of the NodeBalancer to access.
    Status string
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    Weight int
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    Address string
    The private IP Address where this backend can be reached. This must be a private IP address.


    ConfigId int
    The ID of the NodeBalancerConfig to access.
    Label string
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    Mode string
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    NodebalancerId int
    The ID of the NodeBalancer to access.
    Status string
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    Weight int
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    address String
    The private IP Address where this backend can be reached. This must be a private IP address.


    configId Integer
    The ID of the NodeBalancerConfig to access.
    label String
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    mode String
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    nodebalancerId Integer
    The ID of the NodeBalancer to access.
    status String
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    weight Integer
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    address string
    The private IP Address where this backend can be reached. This must be a private IP address.


    configId number
    The ID of the NodeBalancerConfig to access.
    label string
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    mode string
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    nodebalancerId number
    The ID of the NodeBalancer to access.
    status string
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    weight number
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    address str
    The private IP Address where this backend can be reached. This must be a private IP address.


    config_id int
    The ID of the NodeBalancerConfig to access.
    label str
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    mode str
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    nodebalancer_id int
    The ID of the NodeBalancer to access.
    status str
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    weight int
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
    address String
    The private IP Address where this backend can be reached. This must be a private IP address.


    configId Number
    The ID of the NodeBalancerConfig to access.
    label String
    The label of the Linode NodeBalancer Node. This is for display purposes only.
    mode String
    The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
    nodebalancerId Number
    The ID of the NodeBalancer to access.
    status String
    The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
    weight Number
    Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).

    Import

    NodeBalancer Nodes can be imported using the NodeBalancer nodebalancer_id followed by the NodeBalancer Config config_id followed by the NodeBalancer Node id, separated by a comma, e.g.

    $ pulumi import linode:index/nodeBalancerNode:NodeBalancerNode https-foobar-1 1234567,7654321,9999999
    

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

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi