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

runpod.Template

Explore with Pulumi AI

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

    Create Template Resource

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

    Constructor syntax

    new Template(name: string, args: TemplateArgs, opts?: CustomResourceOptions);
    @overload
    def Template(resource_name: str,
                 args: TemplateArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Template(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 container_disk_in_gb: Optional[int] = None,
                 volume_in_gb: Optional[int] = None,
                 docker_args: Optional[str] = None,
                 env: Optional[Sequence[PodEnvArgs]] = None,
                 image_name: Optional[str] = None,
                 name: Optional[str] = None,
                 is_serverless: Optional[bool] = None,
                 is_public: Optional[bool] = None,
                 ports: Optional[str] = None,
                 readme: Optional[str] = None,
                 start_jupyter: Optional[bool] = None,
                 start_ssh: Optional[bool] = None,
                 container_registry_auth_id: Optional[str] = None,
                 volume_mount_path: Optional[str] = None)
    func NewTemplate(ctx *Context, name string, args TemplateArgs, opts ...ResourceOption) (*Template, error)
    public Template(string name, TemplateArgs args, CustomResourceOptions? opts = null)
    public Template(String name, TemplateArgs args)
    public Template(String name, TemplateArgs args, CustomResourceOptions options)
    
    type: runpod:Template
    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 TemplateArgs
    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 TemplateArgs
    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 TemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TemplateArgs
    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 templateResource = new Runpod.Template("templateResource", new()
    {
        ContainerDiskInGb = 0,
        VolumeInGb = 0,
        DockerArgs = "string",
        Env = new[]
        {
            new Runpod.Inputs.PodEnvArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        ImageName = "string",
        Name = "string",
        IsServerless = false,
        IsPublic = false,
        Ports = "string",
        Readme = "string",
        StartJupyter = false,
        StartSsh = false,
        ContainerRegistryAuthId = "string",
        VolumeMountPath = "string",
    });
    
    example, err := runpod.NewTemplate(ctx, "templateResource", &runpod.TemplateArgs{
    	ContainerDiskInGb: pulumi.Int(0),
    	VolumeInGb:        pulumi.Int(0),
    	DockerArgs:        pulumi.String("string"),
    	Env: runpod.PodEnvArray{
    		&runpod.PodEnvArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	ImageName:               pulumi.String("string"),
    	Name:                    pulumi.String("string"),
    	IsServerless:            pulumi.Bool(false),
    	IsPublic:                pulumi.Bool(false),
    	Ports:                   pulumi.String("string"),
    	Readme:                  pulumi.String("string"),
    	StartJupyter:            pulumi.Bool(false),
    	StartSsh:                pulumi.Bool(false),
    	ContainerRegistryAuthId: pulumi.String("string"),
    	VolumeMountPath:         pulumi.String("string"),
    })
    
    var templateResource = new Template("templateResource", TemplateArgs.builder()
        .containerDiskInGb(0)
        .volumeInGb(0)
        .dockerArgs("string")
        .env(PodEnvArgs.builder()
            .key("string")
            .value("string")
            .build())
        .imageName("string")
        .name("string")
        .isServerless(false)
        .isPublic(false)
        .ports("string")
        .readme("string")
        .startJupyter(false)
        .startSsh(false)
        .containerRegistryAuthId("string")
        .volumeMountPath("string")
        .build());
    
    template_resource = runpod.Template("templateResource",
        container_disk_in_gb=0,
        volume_in_gb=0,
        docker_args="string",
        env=[{
            "key": "string",
            "value": "string",
        }],
        image_name="string",
        name="string",
        is_serverless=False,
        is_public=False,
        ports="string",
        readme="string",
        start_jupyter=False,
        start_ssh=False,
        container_registry_auth_id="string",
        volume_mount_path="string")
    
    const templateResource = new runpod.Template("templateResource", {
        containerDiskInGb: 0,
        volumeInGb: 0,
        dockerArgs: "string",
        env: [{
            key: "string",
            value: "string",
        }],
        imageName: "string",
        name: "string",
        isServerless: false,
        isPublic: false,
        ports: "string",
        readme: "string",
        startJupyter: false,
        startSsh: false,
        containerRegistryAuthId: "string",
        volumeMountPath: "string",
    });
    
    type: runpod:Template
    properties:
        containerDiskInGb: 0
        containerRegistryAuthId: string
        dockerArgs: string
        env:
            - key: string
              value: string
        imageName: string
        isPublic: false
        isServerless: false
        name: string
        ports: string
        readme: string
        startJupyter: false
        startSsh: false
        volumeInGb: 0
        volumeMountPath: string
    

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Template RunpodInfra.Runpod.Outputs.Template
    Id string
    The provider-assigned unique ID for this managed resource.
    Template TemplateType
    id String
    The provider-assigned unique ID for this managed resource.
    template Template
    id string
    The provider-assigned unique ID for this managed resource.
    template Template
    id str
    The provider-assigned unique ID for this managed resource.
    template Template
    id String
    The provider-assigned unique ID for this managed resource.
    template Property Map

    Supporting Types

    PodEnv, PodEnvArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Template, TemplateArgs

    advancedStart Boolean
    boundEndpointId String
    category String
    containerDiskInGb Integer
    containerRegistryAuthId String
    dockerArgs String
    earned Double
    id String
    imageName String
    isPublic Boolean
    isRunpod Boolean
    isServerless Boolean
    name String
    ports String
    readme String
    runtimeInMin Integer
    startJupyter Boolean
    startScript String
    startSsh Boolean
    volumeInGb Integer
    volumeMountPath String
    env List<PodEnv>
    advancedStart boolean
    boundEndpointId string
    category string
    containerDiskInGb number
    containerRegistryAuthId string
    dockerArgs string
    earned number
    id string
    imageName string
    isPublic boolean
    isRunpod boolean
    isServerless boolean
    name string
    ports string
    readme string
    runtimeInMin number
    startJupyter boolean
    startScript string
    startSsh boolean
    volumeInGb number
    volumeMountPath string
    env PodEnv[]

    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