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",
});
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:
- Container
Disk In Gb This property is required. int - Docker
Args This property is required. string - Env
This property is required. List<RunpodInfra. Runpod. Inputs. Pod Env> - Image
Name This property is required. string - Name
This property is required. string - Volume
In Gb This property is required. int - Container
Registry stringAuth Id - Is
Public bool - Is
Serverless bool - Ports string
- Readme string
- Start
Jupyter bool - Start
Ssh bool - Volume
Mount stringPath
- Container
Disk In Gb This property is required. int - Docker
Args This property is required. string - Env
This property is required. []PodEnv Args - Image
Name This property is required. string - Name
This property is required. string - Volume
In Gb This property is required. int - Container
Registry stringAuth Id - Is
Public bool - Is
Serverless bool - Ports string
- Readme string
- Start
Jupyter bool - Start
Ssh bool - Volume
Mount stringPath
- container
Disk In Gb This property is required. Integer - docker
Args This property is required. String - env
This property is required. List<PodEnv> - image
Name This property is required. String - name
This property is required. String - volume
In Gb This property is required. Integer - container
Registry StringAuth Id - is
Public Boolean - is
Serverless Boolean - ports String
- readme String
- start
Jupyter Boolean - start
Ssh Boolean - volume
Mount StringPath
- container
Disk In Gb This property is required. number - docker
Args This property is required. string - env
This property is required. PodEnv[] - image
Name This property is required. string - name
This property is required. string - volume
In Gb This property is required. number - container
Registry stringAuth Id - is
Public boolean - is
Serverless boolean - ports string
- readme string
- start
Jupyter boolean - start
Ssh boolean - volume
Mount stringPath
- container_
disk_ in_ gb This property is required. int - docker_
args This property is required. str - env
This property is required. Sequence[PodEnv Args] - image_
name This property is required. str - name
This property is required. str - volume_
in_ gb This property is required. int - container_
registry_ strauth_ id - is_
public bool - is_
serverless bool - ports str
- readme str
- start_
jupyter bool - start_
ssh bool - volume_
mount_ strpath
- container
Disk In Gb This property is required. Number - docker
Args This property is required. String - env
This property is required. List<Property Map> - image
Name This property is required. String - name
This property is required. String - volume
In Gb This property is required. Number - container
Registry StringAuth Id - is
Public Boolean - is
Serverless Boolean - ports String
- readme String
- start
Jupyter Boolean - start
Ssh Boolean - volume
Mount StringPath
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
Runpod
Infra. Runpod. Outputs. Template
- Id string
- The provider-assigned unique ID for this managed resource.
- Template
Template
Type
- id String
- The provider-assigned unique ID for this managed resource.
- template Property Map
Supporting Types
PodEnv, PodEnvArgs
, PodEnvArgs
Template, TemplateArgs
, TemplateArgs
- Advanced
Start This property is required. bool - Bound
Endpoint Id This property is required. string - Category
This property is required. string - Container
Disk In Gb This property is required. int - Container
Registry Auth Id This property is required. string - Docker
Args This property is required. string - Earned
This property is required. double - Id
This property is required. string - Image
Name This property is required. string - 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. string - Ports
This property is required. string - Readme
This property is required. string - Runtime
In Min This property is required. int - Start
Jupyter This property is required. bool - Start
Script This property is required. string - Start
Ssh This property is required. bool - Volume
In Gb This property is required. int - Volume
Mount Path This property is required. string - Env
List<Runpod
Infra. Runpod. Inputs. Pod Env>
- Advanced
Start This property is required. bool - Bound
Endpoint Id This property is required. string - Category
This property is required. string - Container
Disk In Gb This property is required. int - Container
Registry Auth Id This property is required. string - Docker
Args This property is required. string - Earned
This property is required. float64 - Id
This property is required. string - Image
Name This property is required. string - 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. string - Ports
This property is required. string - Readme
This property is required. string - Runtime
In Min This property is required. int - Start
Jupyter This property is required. bool - Start
Script This property is required. string - Start
Ssh This property is required. bool - Volume
In Gb This property is required. int - Volume
Mount Path This property is required. string - Env
[]Pod
Env
- advanced
Start This property is required. Boolean - bound
Endpoint Id This property is required. String - category
This property is required. String - container
Disk In Gb This property is required. Integer - container
Registry Auth Id This property is required. String - docker
Args This property is required. String - earned
This property is required. Double - id
This property is required. String - image
Name This property is required. String - is
Public This property is required. Boolean - is
Runpod This property is required. Boolean - is
Serverless This property is required. Boolean - name
This property is required. String - ports
This property is required. String - readme
This property is required. String - runtime
In Min This property is required. Integer - start
Jupyter This property is required. Boolean - start
Script This property is required. String - start
Ssh This property is required. Boolean - volume
In Gb This property is required. Integer - volume
Mount Path This property is required. String - env
List<Pod
Env>
- advanced
Start This property is required. boolean - bound
Endpoint Id This property is required. string - category
This property is required. string - container
Disk In Gb This property is required. number - container
Registry Auth Id This property is required. string - docker
Args This property is required. string - earned
This property is required. number - id
This property is required. string - image
Name This property is required. string - is
Public This property is required. boolean - is
Runpod This property is required. boolean - is
Serverless This property is required. boolean - name
This property is required. string - ports
This property is required. string - readme
This property is required. string - runtime
In Min This property is required. number - start
Jupyter This property is required. boolean - start
Script This property is required. string - start
Ssh This property is required. boolean - volume
In Gb This property is required. number - volume
Mount Path This property is required. string - env
Pod
Env[]
- 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[Pod
Env]
- advanced
Start This property is required. Boolean - bound
Endpoint Id This property is required. String - category
This property is required. String - container
Disk In Gb This property is required. Number - container
Registry Auth Id This property is required. String - docker
Args This property is required. String - earned
This property is required. Number - id
This property is required. String - image
Name This property is required. String - is
Public This property is required. Boolean - is
Runpod This property is required. Boolean - is
Serverless This property is required. Boolean - name
This property is required. String - ports
This property is required. String - readme
This property is required. String - runtime
In Min This property is required. Number - start
Jupyter This property is required. Boolean - start
Script This property is required. String - start
Ssh This property is required. Boolean - volume
In Gb This property is required. Number - volume
Mount Path This property is required. String - env List<Property Map>
Package Details
- Repository
- runpod runpod/pulumi-runpod-native
- License
- Apache-2.0