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

volcengine.veecp.BatchEdgeMachine

Explore with Pulumi AI

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

    Provides a resource to manage veecp batch edge machine

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.veecp.BatchEdgeMachine("foo", {
        clusterId: "ccvmb0c66t101fnob3dhg",
        nodePoolId: "pcvn3alfic26jjcjsa1r0",
        ttlHours: 1,
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.veecp.BatchEdgeMachine("foo",
        cluster_id="ccvmb0c66t101fnob3dhg",
        node_pool_id="pcvn3alfic26jjcjsa1r0",
        ttl_hours=1)
    
    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.NewBatchEdgeMachine(ctx, "foo", &veecp.BatchEdgeMachineArgs{
    			ClusterId:  pulumi.String("ccvmb0c66t101fnob3dhg"),
    			NodePoolId: pulumi.String("pcvn3alfic26jjcjsa1r0"),
    			TtlHours:   pulumi.Int(1),
    		})
    		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.BatchEdgeMachine("foo", new()
        {
            ClusterId = "ccvmb0c66t101fnob3dhg",
            NodePoolId = "pcvn3alfic26jjcjsa1r0",
            TtlHours = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.veecp.BatchEdgeMachine;
    import com.pulumi.volcengine.veecp.BatchEdgeMachineArgs;
    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 BatchEdgeMachine("foo", BatchEdgeMachineArgs.builder()        
                .clusterId("ccvmb0c66t101fnob3dhg")
                .nodePoolId("pcvn3alfic26jjcjsa1r0")
                .ttlHours(1)
                .build());
    
        }
    }
    
    resources:
      foo:
        type: volcengine:veecp:BatchEdgeMachine
        properties:
          clusterId: ccvmb0c66t101fnob3dhg
          nodePoolId: pcvn3alfic26jjcjsa1r0
          ttlHours: 1
    

    Create BatchEdgeMachine Resource

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

    Constructor syntax

    new BatchEdgeMachine(name: string, args: BatchEdgeMachineArgs, opts?: CustomResourceOptions);
    @overload
    def BatchEdgeMachine(resource_name: str,
                         args: BatchEdgeMachineArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def BatchEdgeMachine(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         cluster_id: Optional[str] = None,
                         node_pool_id: Optional[str] = None,
                         ttl_hours: Optional[int] = None,
                         client_token: Optional[str] = None,
                         expiration_date: Optional[int] = None,
                         name: Optional[str] = None)
    func NewBatchEdgeMachine(ctx *Context, name string, args BatchEdgeMachineArgs, opts ...ResourceOption) (*BatchEdgeMachine, error)
    public BatchEdgeMachine(string name, BatchEdgeMachineArgs args, CustomResourceOptions? opts = null)
    public BatchEdgeMachine(String name, BatchEdgeMachineArgs args)
    public BatchEdgeMachine(String name, BatchEdgeMachineArgs args, CustomResourceOptions options)
    
    type: volcengine:veecp:BatchEdgeMachine
    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 BatchEdgeMachineArgs
    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 BatchEdgeMachineArgs
    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 BatchEdgeMachineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BatchEdgeMachineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BatchEdgeMachineArgs
    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 batchEdgeMachineResource = new Volcengine.Veecp.BatchEdgeMachine("batchEdgeMachineResource", new()
    {
        ClusterId = "string",
        NodePoolId = "string",
        TtlHours = 0,
        ClientToken = "string",
        ExpirationDate = 0,
        Name = "string",
    });
    
    example, err := veecp.NewBatchEdgeMachine(ctx, "batchEdgeMachineResource", &veecp.BatchEdgeMachineArgs{
    	ClusterId:      pulumi.String("string"),
    	NodePoolId:     pulumi.String("string"),
    	TtlHours:       pulumi.Int(0),
    	ClientToken:    pulumi.String("string"),
    	ExpirationDate: pulumi.Int(0),
    	Name:           pulumi.String("string"),
    })
    
    var batchEdgeMachineResource = new BatchEdgeMachine("batchEdgeMachineResource", BatchEdgeMachineArgs.builder()
        .clusterId("string")
        .nodePoolId("string")
        .ttlHours(0)
        .clientToken("string")
        .expirationDate(0)
        .name("string")
        .build());
    
    batch_edge_machine_resource = volcengine.veecp.BatchEdgeMachine("batchEdgeMachineResource",
        cluster_id="string",
        node_pool_id="string",
        ttl_hours=0,
        client_token="string",
        expiration_date=0,
        name="string")
    
    const batchEdgeMachineResource = new volcengine.veecp.BatchEdgeMachine("batchEdgeMachineResource", {
        clusterId: "string",
        nodePoolId: "string",
        ttlHours: 0,
        clientToken: "string",
        expirationDate: 0,
        name: "string",
    });
    
    type: volcengine:veecp:BatchEdgeMachine
    properties:
        clientToken: string
        clusterId: string
        expirationDate: 0
        name: string
        nodePoolId: string
        ttlHours: 0
    

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

    ClusterId string
    The cluster id.
    NodePoolId string
    The node pool id.
    TtlHours int
    Effective hours of the managed script are counted from the creation time.
    ClientToken string
    The client token.
    ExpirationDate int
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    Name string
    The name of the node.
    ClusterId string
    The cluster id.
    NodePoolId string
    The node pool id.
    TtlHours int
    Effective hours of the managed script are counted from the creation time.
    ClientToken string
    The client token.
    ExpirationDate int
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    Name string
    The name of the node.
    clusterId String
    The cluster id.
    nodePoolId String
    The node pool id.
    ttlHours Integer
    Effective hours of the managed script are counted from the creation time.
    clientToken String
    The client token.
    expirationDate Integer
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    name String
    The name of the node.
    clusterId string
    The cluster id.
    nodePoolId string
    The node pool id.
    ttlHours number
    Effective hours of the managed script are counted from the creation time.
    clientToken string
    The client token.
    expirationDate number
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    name string
    The name of the node.
    cluster_id str
    The cluster id.
    node_pool_id str
    The node pool id.
    ttl_hours int
    Effective hours of the managed script are counted from the creation time.
    client_token str
    The client token.
    expiration_date int
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    name str
    The name of the node.
    clusterId String
    The cluster id.
    nodePoolId String
    The node pool id.
    ttlHours Number
    Effective hours of the managed script are counted from the creation time.
    clientToken String
    The client token.
    expirationDate Number
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    name String
    The name of the node.

    Outputs

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

    Get an existing BatchEdgeMachine 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?: BatchEdgeMachineState, opts?: CustomResourceOptions): BatchEdgeMachine
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            client_token: Optional[str] = None,
            cluster_id: Optional[str] = None,
            expiration_date: Optional[int] = None,
            name: Optional[str] = None,
            node_pool_id: Optional[str] = None,
            ttl_hours: Optional[int] = None) -> BatchEdgeMachine
    func GetBatchEdgeMachine(ctx *Context, name string, id IDInput, state *BatchEdgeMachineState, opts ...ResourceOption) (*BatchEdgeMachine, error)
    public static BatchEdgeMachine Get(string name, Input<string> id, BatchEdgeMachineState? state, CustomResourceOptions? opts = null)
    public static BatchEdgeMachine get(String name, Output<String> id, BatchEdgeMachineState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:veecp:BatchEdgeMachine    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:
    ClientToken string
    The client token.
    ClusterId string
    The cluster id.
    ExpirationDate int
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    Name string
    The name of the node.
    NodePoolId string
    The node pool id.
    TtlHours int
    Effective hours of the managed script are counted from the creation time.
    ClientToken string
    The client token.
    ClusterId string
    The cluster id.
    ExpirationDate int
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    Name string
    The name of the node.
    NodePoolId string
    The node pool id.
    TtlHours int
    Effective hours of the managed script are counted from the creation time.
    clientToken String
    The client token.
    clusterId String
    The cluster id.
    expirationDate Integer
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    name String
    The name of the node.
    nodePoolId String
    The node pool id.
    ttlHours Integer
    Effective hours of the managed script are counted from the creation time.
    clientToken string
    The client token.
    clusterId string
    The cluster id.
    expirationDate number
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    name string
    The name of the node.
    nodePoolId string
    The node pool id.
    ttlHours number
    Effective hours of the managed script are counted from the creation time.
    client_token str
    The client token.
    cluster_id str
    The cluster id.
    expiration_date int
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    name str
    The name of the node.
    node_pool_id str
    The node pool id.
    ttl_hours int
    Effective hours of the managed script are counted from the creation time.
    clientToken String
    The client token.
    clusterId String
    The cluster id.
    expirationDate Number
    Expiration date of the managed script, UTC time point, in seconds. If the expiration time is set, TTLHours will be ignored.
    name String
    The name of the node.
    nodePoolId String
    The node pool id.
    ttlHours Number
    Effective hours of the managed script are counted from the creation time.

    Import

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

    $ pulumi import volcengine:veecp/batchEdgeMachine:BatchEdgeMachine 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