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

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 This property is required. string
The unique name of the resource.
args This property is required. TemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. TemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
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());
Copy
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")
Copy
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",
});
Copy
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
Copy

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:

ContainerDiskInGb This property is required. int
DockerArgs This property is required. string
Env This property is required. List<RunpodInfra.Runpod.Inputs.PodEnv>
ImageName This property is required. string
Name This property is required. string
VolumeInGb This property is required. int
ContainerRegistryAuthId string
IsPublic bool
IsServerless bool
Ports string
Readme string
StartJupyter bool
StartSsh bool
VolumeMountPath string
ContainerDiskInGb This property is required. int
DockerArgs This property is required. string
Env This property is required. []PodEnvArgs
ImageName This property is required. string
Name This property is required. string
VolumeInGb This property is required. int
ContainerRegistryAuthId string
IsPublic bool
IsServerless bool
Ports string
Readme string
StartJupyter bool
StartSsh bool
VolumeMountPath string
containerDiskInGb This property is required. Integer
dockerArgs This property is required. String
env This property is required. List<PodEnv>
imageName This property is required. String
name This property is required. String
volumeInGb This property is required. Integer
containerRegistryAuthId String
isPublic Boolean
isServerless Boolean
ports String
readme String
startJupyter Boolean
startSsh Boolean
volumeMountPath String
containerDiskInGb This property is required. number
dockerArgs This property is required. string
env This property is required. PodEnv[]
imageName This property is required. string
name This property is required. string
volumeInGb This property is required. number
containerRegistryAuthId string
isPublic boolean
isServerless boolean
ports string
readme string
startJupyter boolean
startSsh boolean
volumeMountPath string
container_disk_in_gb This property is required. int
docker_args This property is required. str
env This property is required. Sequence[PodEnvArgs]
image_name This property is required. str
name This property is required. str
volume_in_gb This property is required. int
container_registry_auth_id str
is_public bool
is_serverless bool
ports str
readme str
start_jupyter bool
start_ssh bool
volume_mount_path str
containerDiskInGb This property is required. Number
dockerArgs This property is required. String
env This property is required. List<Property Map>
imageName This property is required. String
name This property is required. String
volumeInGb This property is required. Number
containerRegistryAuthId String
isPublic Boolean
isServerless Boolean
ports String
readme String
startJupyter Boolean
startSsh Boolean
volumeMountPath String

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 This property is required. string
Value This property is required. string
Key This property is required. string
Value This property is required. string
key This property is required. String
value This property is required. String
key This property is required. string
value This property is required. string
key This property is required. str
value This property is required. str
key This property is required. String
value This property is required. String

Template
, TemplateArgs

AdvancedStart This property is required. bool
BoundEndpointId This property is required. string
Category This property is required. string
ContainerDiskInGb This property is required. int
ContainerRegistryAuthId This property is required. string
DockerArgs This property is required. string
Earned This property is required. double
Id This property is required. string
ImageName This property is required. string
IsPublic This property is required. bool
IsRunpod This property is required. bool
IsServerless This property is required. bool
Name This property is required. string
Ports This property is required. string
Readme This property is required. string
RuntimeInMin This property is required. int
StartJupyter This property is required. bool
StartScript This property is required. string
StartSsh This property is required. bool
VolumeInGb This property is required. int
VolumeMountPath This property is required. string
Env List<RunpodInfra.Runpod.Inputs.PodEnv>
AdvancedStart This property is required. bool
BoundEndpointId This property is required. string
Category This property is required. string
ContainerDiskInGb This property is required. int
ContainerRegistryAuthId This property is required. string
DockerArgs This property is required. string
Earned This property is required. float64
Id This property is required. string
ImageName This property is required. string
IsPublic This property is required. bool
IsRunpod This property is required. bool
IsServerless This property is required. bool
Name This property is required. string
Ports This property is required. string
Readme This property is required. string
RuntimeInMin This property is required. int
StartJupyter This property is required. bool
StartScript This property is required. string
StartSsh This property is required. bool
VolumeInGb This property is required. int
VolumeMountPath This property is required. string
Env []PodEnv
advancedStart This property is required. Boolean
boundEndpointId This property is required. String
category This property is required. String
containerDiskInGb This property is required. Integer
containerRegistryAuthId This property is required. String
dockerArgs This property is required. String
earned This property is required. Double
id This property is required. String
imageName This property is required. String
isPublic This property is required. Boolean
isRunpod This property is required. Boolean
isServerless This property is required. Boolean
name This property is required. String
ports This property is required. String
readme This property is required. String
runtimeInMin This property is required. Integer
startJupyter This property is required. Boolean
startScript This property is required. String
startSsh This property is required. Boolean
volumeInGb This property is required. Integer
volumeMountPath This property is required. String
env List<PodEnv>
advancedStart This property is required. boolean
boundEndpointId This property is required. string
category This property is required. string
containerDiskInGb This property is required. number
containerRegistryAuthId This property is required. string
dockerArgs This property is required. string
earned This property is required. number
id This property is required. string
imageName This property is required. string
isPublic This property is required. boolean
isRunpod This property is required. boolean
isServerless This property is required. boolean
name This property is required. string
ports This property is required. string
readme This property is required. string
runtimeInMin This property is required. number
startJupyter This property is required. boolean
startScript This property is required. string
startSsh This property is required. boolean
volumeInGb This property is required. number
volumeMountPath This property is required. string
env PodEnv[]
advanced_start This property is required. bool
bound_endpoint_id This property is required. str
category This property is required. str
container_disk_in_gb This property is required. int
container_registry_auth_id This property is required. str
docker_args This property is required. str
earned This property is required. float
id This property is required. str
image_name This property is required. str
is_public This property is required. bool
is_runpod This property is required. bool
is_serverless This property is required. bool
name This property is required. str
ports This property is required. str
readme This property is required. str
runtime_in_min This property is required. int
start_jupyter This property is required. bool
start_script This property is required. str
start_ssh This property is required. bool
volume_in_gb This property is required. int
volume_mount_path This property is required. str
env Sequence[PodEnv]
advancedStart This property is required. Boolean
boundEndpointId This property is required. String
category This property is required. String
containerDiskInGb This property is required. Number
containerRegistryAuthId This property is required. String
dockerArgs This property is required. String
earned This property is required. Number
id This property is required. String
imageName This property is required. String
isPublic This property is required. Boolean
isRunpod This property is required. Boolean
isServerless This property is required. Boolean
name This property is required. String
ports This property is required. String
readme This property is required. String
runtimeInMin This property is required. Number
startJupyter This property is required. Boolean
startScript This property is required. String
startSsh This property is required. Boolean
volumeInGb This property is required. Number
volumeMountPath This property is required. String
env List<Property Map>

Package Details

Repository
runpod runpod/pulumi-runpod-native
License
Apache-2.0