1. Packages
  2. Volcengine
  3. API Docs
  4. veecp
  5. EdgeNode
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

volcengine.veecp.EdgeNode

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

    Provides a resource to manage veecp edge node

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.veecp.EdgeNode("foo", {
        autoCompleteConfig: {
            directAdd: true,
            directAddInstances: [{
                cloudServerIdentity: "cloudserver-wvvflw9qdns2qrk",
                instanceIdentity: "veen91912104432151420041",
            }],
            enable: true,
        },
        clusterId: "ccvmf49t1ndqeechmj8p0",
        nodePoolId: "pcvpkdn7ic26jjcjsa20g",
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.veecp.EdgeNode("foo",
        auto_complete_config=volcengine.veecp.EdgeNodeAutoCompleteConfigArgs(
            direct_add=True,
            direct_add_instances=[volcengine.veecp.EdgeNodeAutoCompleteConfigDirectAddInstanceArgs(
                cloud_server_identity="cloudserver-wvvflw9qdns2qrk",
                instance_identity="veen91912104432151420041",
            )],
            enable=True,
        ),
        cluster_id="ccvmf49t1ndqeechmj8p0",
        node_pool_id="pcvpkdn7ic26jjcjsa20g")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/veecp"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := veecp.NewEdgeNode(ctx, "foo", &veecp.EdgeNodeArgs{
    			AutoCompleteConfig: &veecp.EdgeNodeAutoCompleteConfigArgs{
    				DirectAdd: pulumi.Bool(true),
    				DirectAddInstances: veecp.EdgeNodeAutoCompleteConfigDirectAddInstanceArray{
    					&veecp.EdgeNodeAutoCompleteConfigDirectAddInstanceArgs{
    						CloudServerIdentity: pulumi.String("cloudserver-wvvflw9qdns2qrk"),
    						InstanceIdentity:    pulumi.String("veen91912104432151420041"),
    					},
    				},
    				Enable: pulumi.Bool(true),
    			},
    			ClusterId:  pulumi.String("ccvmf49t1ndqeechmj8p0"),
    			NodePoolId: pulumi.String("pcvpkdn7ic26jjcjsa20g"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Veecp.EdgeNode("foo", new()
        {
            AutoCompleteConfig = new Volcengine.Veecp.Inputs.EdgeNodeAutoCompleteConfigArgs
            {
                DirectAdd = true,
                DirectAddInstances = new[]
                {
                    new Volcengine.Veecp.Inputs.EdgeNodeAutoCompleteConfigDirectAddInstanceArgs
                    {
                        CloudServerIdentity = "cloudserver-wvvflw9qdns2qrk",
                        InstanceIdentity = "veen91912104432151420041",
                    },
                },
                Enable = true,
            },
            ClusterId = "ccvmf49t1ndqeechmj8p0",
            NodePoolId = "pcvpkdn7ic26jjcjsa20g",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.veecp.EdgeNode;
    import com.pulumi.volcengine.veecp.EdgeNodeArgs;
    import com.pulumi.volcengine.veecp.inputs.EdgeNodeAutoCompleteConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var foo = new EdgeNode("foo", EdgeNodeArgs.builder()        
                .autoCompleteConfig(EdgeNodeAutoCompleteConfigArgs.builder()
                    .directAdd(true)
                    .directAddInstances(EdgeNodeAutoCompleteConfigDirectAddInstanceArgs.builder()
                        .cloudServerIdentity("cloudserver-wvvflw9qdns2qrk")
                        .instanceIdentity("veen91912104432151420041")
                        .build())
                    .enable(true)
                    .build())
                .clusterId("ccvmf49t1ndqeechmj8p0")
                .nodePoolId("pcvpkdn7ic26jjcjsa20g")
                .build());
    
        }
    }
    
    resources:
      foo:
        type: volcengine:veecp:EdgeNode
        properties:
          autoCompleteConfig:
            directAdd: true
            directAddInstances:
              - cloudServerIdentity: cloudserver-wvvflw9qdns2qrk
                instanceIdentity: veen91912104432151420041
            enable: true
          clusterId: ccvmf49t1ndqeechmj8p0
          nodePoolId: pcvpkdn7ic26jjcjsa20g
    

    Create EdgeNode Resource

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

    Constructor syntax

    new EdgeNode(name: string, args: EdgeNodeArgs, opts?: CustomResourceOptions);
    @overload
    def EdgeNode(resource_name: str,
                 args: EdgeNodeArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def EdgeNode(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 auto_complete_config: Optional[EdgeNodeAutoCompleteConfigArgs] = None,
                 cluster_id: Optional[str] = None,
                 node_pool_id: Optional[str] = None,
                 client_token: Optional[str] = None,
                 name: Optional[str] = None)
    func NewEdgeNode(ctx *Context, name string, args EdgeNodeArgs, opts ...ResourceOption) (*EdgeNode, error)
    public EdgeNode(string name, EdgeNodeArgs args, CustomResourceOptions? opts = null)
    public EdgeNode(String name, EdgeNodeArgs args)
    public EdgeNode(String name, EdgeNodeArgs args, CustomResourceOptions options)
    
    type: volcengine:veecp:EdgeNode
    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 EdgeNodeArgs
    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 EdgeNodeArgs
    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 EdgeNodeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeNodeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeNodeArgs
    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 edgeNodeResource = new Volcengine.Veecp.EdgeNode("edgeNodeResource", new()
    {
        AutoCompleteConfig = new Volcengine.Veecp.Inputs.EdgeNodeAutoCompleteConfigArgs
        {
            Enable = false,
            Address = "string",
            DirectAdd = false,
            DirectAddInstances = new[]
            {
                new Volcengine.Veecp.Inputs.EdgeNodeAutoCompleteConfigDirectAddInstanceArgs
                {
                    CloudServerIdentity = "string",
                    InstanceIdentity = "string",
                },
            },
            MachineAuth = new Volcengine.Veecp.Inputs.EdgeNodeAutoCompleteConfigMachineAuthArgs
            {
                AuthType = "string",
                SshPort = 0,
                User = "string",
            },
        },
        ClusterId = "string",
        NodePoolId = "string",
        ClientToken = "string",
        Name = "string",
    });
    
    example, err := veecp.NewEdgeNode(ctx, "edgeNodeResource", &veecp.EdgeNodeArgs{
    	AutoCompleteConfig: &veecp.EdgeNodeAutoCompleteConfigArgs{
    		Enable:    pulumi.Bool(false),
    		Address:   pulumi.String("string"),
    		DirectAdd: pulumi.Bool(false),
    		DirectAddInstances: veecp.EdgeNodeAutoCompleteConfigDirectAddInstanceArray{
    			&veecp.EdgeNodeAutoCompleteConfigDirectAddInstanceArgs{
    				CloudServerIdentity: pulumi.String("string"),
    				InstanceIdentity:    pulumi.String("string"),
    			},
    		},
    		MachineAuth: &veecp.EdgeNodeAutoCompleteConfigMachineAuthArgs{
    			AuthType: pulumi.String("string"),
    			SshPort:  pulumi.Int(0),
    			User:     pulumi.String("string"),
    		},
    	},
    	ClusterId:   pulumi.String("string"),
    	NodePoolId:  pulumi.String("string"),
    	ClientToken: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var edgeNodeResource = new EdgeNode("edgeNodeResource", EdgeNodeArgs.builder()
        .autoCompleteConfig(EdgeNodeAutoCompleteConfigArgs.builder()
            .enable(false)
            .address("string")
            .directAdd(false)
            .directAddInstances(EdgeNodeAutoCompleteConfigDirectAddInstanceArgs.builder()
                .cloudServerIdentity("string")
                .instanceIdentity("string")
                .build())
            .machineAuth(EdgeNodeAutoCompleteConfigMachineAuthArgs.builder()
                .authType("string")
                .sshPort(0)
                .user("string")
                .build())
            .build())
        .clusterId("string")
        .nodePoolId("string")
        .clientToken("string")
        .name("string")
        .build());
    
    edge_node_resource = volcengine.veecp.EdgeNode("edgeNodeResource",
        auto_complete_config={
            "enable": False,
            "address": "string",
            "direct_add": False,
            "direct_add_instances": [{
                "cloud_server_identity": "string",
                "instance_identity": "string",
            }],
            "machine_auth": {
                "auth_type": "string",
                "ssh_port": 0,
                "user": "string",
            },
        },
        cluster_id="string",
        node_pool_id="string",
        client_token="string",
        name="string")
    
    const edgeNodeResource = new volcengine.veecp.EdgeNode("edgeNodeResource", {
        autoCompleteConfig: {
            enable: false,
            address: "string",
            directAdd: false,
            directAddInstances: [{
                cloudServerIdentity: "string",
                instanceIdentity: "string",
            }],
            machineAuth: {
                authType: "string",
                sshPort: 0,
                user: "string",
            },
        },
        clusterId: "string",
        nodePoolId: "string",
        clientToken: "string",
        name: "string",
    });
    
    type: volcengine:veecp:EdgeNode
    properties:
        autoCompleteConfig:
            address: string
            directAdd: false
            directAddInstances:
                - cloudServerIdentity: string
                  instanceIdentity: string
            enable: false
            machineAuth:
                authType: string
                sshPort: 0
                user: string
        clientToken: string
        clusterId: string
        name: string
        nodePoolId: string
    

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

    AutoCompleteConfig EdgeNodeAutoCompleteConfig
    Machine information to be managed.
    ClusterId string
    The cluster id.
    NodePoolId string
    The node pool id.
    ClientToken string
    The client token.
    Name string
    The name of node.
    AutoCompleteConfig EdgeNodeAutoCompleteConfigArgs
    Machine information to be managed.
    ClusterId string
    The cluster id.
    NodePoolId string
    The node pool id.
    ClientToken string
    The client token.
    Name string
    The name of node.
    autoCompleteConfig EdgeNodeAutoCompleteConfig
    Machine information to be managed.
    clusterId String
    The cluster id.
    nodePoolId String
    The node pool id.
    clientToken String
    The client token.
    name String
    The name of node.
    autoCompleteConfig EdgeNodeAutoCompleteConfig
    Machine information to be managed.
    clusterId string
    The cluster id.
    nodePoolId string
    The node pool id.
    clientToken string
    The client token.
    name string
    The name of node.
    auto_complete_config EdgeNodeAutoCompleteConfigArgs
    Machine information to be managed.
    cluster_id str
    The cluster id.
    node_pool_id str
    The node pool id.
    client_token str
    The client token.
    name str
    The name of node.
    autoCompleteConfig Property Map
    Machine information to be managed.
    clusterId String
    The cluster id.
    nodePoolId String
    The node pool id.
    clientToken String
    The client token.
    name String
    The name of node.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EdgeNode 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 EdgeNode Resource

    Get an existing EdgeNode 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?: EdgeNodeState, opts?: CustomResourceOptions): EdgeNode
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_complete_config: Optional[EdgeNodeAutoCompleteConfigArgs] = None,
            client_token: Optional[str] = None,
            cluster_id: Optional[str] = None,
            name: Optional[str] = None,
            node_pool_id: Optional[str] = None) -> EdgeNode
    func GetEdgeNode(ctx *Context, name string, id IDInput, state *EdgeNodeState, opts ...ResourceOption) (*EdgeNode, error)
    public static EdgeNode Get(string name, Input<string> id, EdgeNodeState? state, CustomResourceOptions? opts = null)
    public static EdgeNode get(String name, Output<String> id, EdgeNodeState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:veecp:EdgeNode    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:
    AutoCompleteConfig EdgeNodeAutoCompleteConfig
    Machine information to be managed.
    ClientToken string
    The client token.
    ClusterId string
    The cluster id.
    Name string
    The name of node.
    NodePoolId string
    The node pool id.
    AutoCompleteConfig EdgeNodeAutoCompleteConfigArgs
    Machine information to be managed.
    ClientToken string
    The client token.
    ClusterId string
    The cluster id.
    Name string
    The name of node.
    NodePoolId string
    The node pool id.
    autoCompleteConfig EdgeNodeAutoCompleteConfig
    Machine information to be managed.
    clientToken String
    The client token.
    clusterId String
    The cluster id.
    name String
    The name of node.
    nodePoolId String
    The node pool id.
    autoCompleteConfig EdgeNodeAutoCompleteConfig
    Machine information to be managed.
    clientToken string
    The client token.
    clusterId string
    The cluster id.
    name string
    The name of node.
    nodePoolId string
    The node pool id.
    auto_complete_config EdgeNodeAutoCompleteConfigArgs
    Machine information to be managed.
    client_token str
    The client token.
    cluster_id str
    The cluster id.
    name str
    The name of node.
    node_pool_id str
    The node pool id.
    autoCompleteConfig Property Map
    Machine information to be managed.
    clientToken String
    The client token.
    clusterId String
    The cluster id.
    name String
    The name of node.
    nodePoolId String
    The node pool id.

    Supporting Types

    EdgeNodeAutoCompleteConfig, EdgeNodeAutoCompleteConfigArgs

    Enable bool
    Enable/Disable automatic management.
    Address string
    The address of the machine to be managed.
    DirectAdd bool
    Directly managed through the edge computing instance ID. When it is true, there is no need to provide Address. Only DirectAddInstances needs to be provided.
    DirectAddInstances List<EdgeNodeAutoCompleteConfigDirectAddInstance>
    Edge computing instance ID on Volcano Engine.
    MachineAuth EdgeNodeAutoCompleteConfigMachineAuth
    Login credentials.
    Enable bool
    Enable/Disable automatic management.
    Address string
    The address of the machine to be managed.
    DirectAdd bool
    Directly managed through the edge computing instance ID. When it is true, there is no need to provide Address. Only DirectAddInstances needs to be provided.
    DirectAddInstances []EdgeNodeAutoCompleteConfigDirectAddInstance
    Edge computing instance ID on Volcano Engine.
    MachineAuth EdgeNodeAutoCompleteConfigMachineAuth
    Login credentials.
    enable Boolean
    Enable/Disable automatic management.
    address String
    The address of the machine to be managed.
    directAdd Boolean
    Directly managed through the edge computing instance ID. When it is true, there is no need to provide Address. Only DirectAddInstances needs to be provided.
    directAddInstances List<EdgeNodeAutoCompleteConfigDirectAddInstance>
    Edge computing instance ID on Volcano Engine.
    machineAuth EdgeNodeAutoCompleteConfigMachineAuth
    Login credentials.
    enable boolean
    Enable/Disable automatic management.
    address string
    The address of the machine to be managed.
    directAdd boolean
    Directly managed through the edge computing instance ID. When it is true, there is no need to provide Address. Only DirectAddInstances needs to be provided.
    directAddInstances EdgeNodeAutoCompleteConfigDirectAddInstance[]
    Edge computing instance ID on Volcano Engine.
    machineAuth EdgeNodeAutoCompleteConfigMachineAuth
    Login credentials.
    enable bool
    Enable/Disable automatic management.
    address str
    The address of the machine to be managed.
    direct_add bool
    Directly managed through the edge computing instance ID. When it is true, there is no need to provide Address. Only DirectAddInstances needs to be provided.
    direct_add_instances Sequence[EdgeNodeAutoCompleteConfigDirectAddInstance]
    Edge computing instance ID on Volcano Engine.
    machine_auth EdgeNodeAutoCompleteConfigMachineAuth
    Login credentials.
    enable Boolean
    Enable/Disable automatic management.
    address String
    The address of the machine to be managed.
    directAdd Boolean
    Directly managed through the edge computing instance ID. When it is true, there is no need to provide Address. Only DirectAddInstances needs to be provided.
    directAddInstances List<Property Map>
    Edge computing instance ID on Volcano Engine.
    machineAuth Property Map
    Login credentials.

    EdgeNodeAutoCompleteConfigDirectAddInstance, EdgeNodeAutoCompleteConfigDirectAddInstanceArgs

    CloudServerIdentity string
    Edge service ID.
    InstanceIdentity string
    Edge computing instance ID.
    CloudServerIdentity string
    Edge service ID.
    InstanceIdentity string
    Edge computing instance ID.
    cloudServerIdentity String
    Edge service ID.
    instanceIdentity String
    Edge computing instance ID.
    cloudServerIdentity string
    Edge service ID.
    instanceIdentity string
    Edge computing instance ID.
    cloud_server_identity str
    Edge service ID.
    instance_identity str
    Edge computing instance ID.
    cloudServerIdentity String
    Edge service ID.
    instanceIdentity String
    Edge computing instance ID.

    EdgeNodeAutoCompleteConfigMachineAuth, EdgeNodeAutoCompleteConfigMachineAuthArgs

    AuthType string
    Authentication method. Currently only Password is open.
    SshPort int
    SSH port, default 22.
    User string
    Login username.
    AuthType string
    Authentication method. Currently only Password is open.
    SshPort int
    SSH port, default 22.
    User string
    Login username.
    authType String
    Authentication method. Currently only Password is open.
    sshPort Integer
    SSH port, default 22.
    user String
    Login username.
    authType string
    Authentication method. Currently only Password is open.
    sshPort number
    SSH port, default 22.
    user string
    Login username.
    auth_type str
    Authentication method. Currently only Password is open.
    ssh_port int
    SSH port, default 22.
    user str
    Login username.
    authType String
    Authentication method. Currently only Password is open.
    sshPort Number
    SSH port, default 22.
    user String
    Login username.

    Import

    VeecpNode can be imported using the id, e.g.

    $ pulumi import volcengine:veecp/edgeNode:EdgeNode default resource_id
    

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine