1. Packages
  2. RunPod
  3. API Docs
  4. Endpoint
Runpod v1.9.99 published on Wednesday, Jul 3, 2024 by Runpod

runpod.Endpoint

Explore with Pulumi AI

runpod logo
Runpod v1.9.99 published on Wednesday, Jul 3, 2024 by Runpod

    Create Endpoint Resource

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

    Constructor syntax

    new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
    @overload
    def Endpoint(resource_name: str,
                 args: EndpointArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Endpoint(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 gpu_ids: Optional[str] = None,
                 name: Optional[str] = None,
                 idle_timeout: Optional[int] = None,
                 locations: Optional[str] = None,
                 network_volume_id: Optional[str] = None,
                 scaler_type: Optional[str] = None,
                 scaler_value: Optional[int] = None,
                 template_id: Optional[str] = None,
                 workers_max: Optional[int] = None,
                 workers_min: Optional[int] = None)
    func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
    public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
    public Endpoint(String name, EndpointArgs args)
    public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
    
    type: runpod:Endpoint
    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 EndpointArgs
    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 EndpointArgs
    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 EndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointArgs
    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 endpointResource = new Runpod.Endpoint("endpointResource", new()
    {
        GpuIds = "string",
        Name = "string",
        IdleTimeout = 0,
        Locations = "string",
        NetworkVolumeId = "string",
        ScalerType = "string",
        ScalerValue = 0,
        TemplateId = "string",
        WorkersMax = 0,
        WorkersMin = 0,
    });
    
    example, err := runpod.NewEndpoint(ctx, "endpointResource", &runpod.EndpointArgs{
    	GpuIds:          pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	IdleTimeout:     pulumi.Int(0),
    	Locations:       pulumi.String("string"),
    	NetworkVolumeId: pulumi.String("string"),
    	ScalerType:      pulumi.String("string"),
    	ScalerValue:     pulumi.Int(0),
    	TemplateId:      pulumi.String("string"),
    	WorkersMax:      pulumi.Int(0),
    	WorkersMin:      pulumi.Int(0),
    })
    
    var endpointResource = new Endpoint("endpointResource", EndpointArgs.builder()
        .gpuIds("string")
        .name("string")
        .idleTimeout(0)
        .locations("string")
        .networkVolumeId("string")
        .scalerType("string")
        .scalerValue(0)
        .templateId("string")
        .workersMax(0)
        .workersMin(0)
        .build());
    
    endpoint_resource = runpod.Endpoint("endpointResource",
        gpu_ids="string",
        name="string",
        idle_timeout=0,
        locations="string",
        network_volume_id="string",
        scaler_type="string",
        scaler_value=0,
        template_id="string",
        workers_max=0,
        workers_min=0)
    
    const endpointResource = new runpod.Endpoint("endpointResource", {
        gpuIds: "string",
        name: "string",
        idleTimeout: 0,
        locations: "string",
        networkVolumeId: "string",
        scalerType: "string",
        scalerValue: 0,
        templateId: "string",
        workersMax: 0,
        workersMin: 0,
    });
    
    type: runpod:Endpoint
    properties:
        gpuIds: string
        idleTimeout: 0
        locations: string
        name: string
        networkVolumeId: string
        scalerType: string
        scalerValue: 0
        templateId: string
        workersMax: 0
        workersMin: 0
    

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

    gpuIds String
    name String
    idleTimeout Integer
    locations String
    networkVolumeId String
    scalerType String
    scalerValue Integer
    templateId String
    workersMax Integer
    workersMin Integer
    gpuIds string
    name string
    idleTimeout number
    locations string
    networkVolumeId string
    scalerType string
    scalerValue number
    templateId string
    workersMax number
    workersMin number
    gpuIds String
    name String
    idleTimeout Number
    locations String
    networkVolumeId String
    scalerType String
    scalerValue Number
    templateId String
    workersMax Number
    workersMin Number

    Outputs

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

    Endpoint RunpodInfra.Runpod.Outputs.Endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    Endpoint EndpointType
    Id string
    The provider-assigned unique ID for this managed resource.
    endpoint Endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    endpoint Endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    endpoint Endpoint
    id str
    The provider-assigned unique ID for this managed resource.
    endpoint Property Map
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Endpoint, EndpointArgs

    gpuIds String
    id String
    idleTimeout Integer
    locations String
    name String
    networkVolumeId String
    scalerType String
    scalerValue Integer
    templateId String
    workersMax Integer
    workersMin Integer
    gpuIds string
    id string
    idleTimeout number
    locations string
    name string
    networkVolumeId string
    scalerType string
    scalerValue number
    templateId string
    workersMax number
    workersMin number
    gpuIds String
    id String
    idleTimeout Number
    locations String
    name String
    networkVolumeId String
    scalerType String
    scalerValue Number
    templateId String
    workersMax Number
    workersMin Number

    Package Details

    Repository
    runpod runpod/pulumi-runpod-native
    License
    Apache-2.0
    runpod logo
    Runpod v1.9.99 published on Wednesday, Jul 3, 2024 by Runpod