Runpod v1.3.1 published on Tuesday, Jun 18, 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 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=[runpod.PodEnvArgs(
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
The Template resource accepts the following input properties:
- Container
Disk intIn Gb - Docker
Args string - Env
List<Runpod
Infra. Runpod. Inputs. Pod Env> - Image
Name string - Name string
- Volume
In intGb - 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 intIn Gb - Docker
Args string - Env
[]Pod
Env Args - Image
Name string - Name string
- Volume
In intGb - 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 IntegerIn Gb - docker
Args String - env
List<Pod
Env> - image
Name String - name String
- volume
In IntegerGb - 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 numberIn Gb - docker
Args string - env
Pod
Env[] - image
Name string - name string
- volume
In numberGb - 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_ intin_ gb - docker_
args str - env
Sequence[Pod
Env Args] - image_
name str - name str
- volume_
in_ intgb - 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 NumberIn Gb - docker
Args String - env List<Property Map>
- image
Name String - name String
- volume
In NumberGb - 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
Template, TemplateArgs
- Advanced
Start bool - Bound
Endpoint stringId - Category string
- Container
Disk intIn Gb - Container
Registry stringAuth Id - Docker
Args string - Earned double
- Id string
- Image
Name string - Is
Public bool - Is
Runpod bool - Is
Serverless bool - Name string
- Ports string
- Readme string
- Runtime
In intMin - Start
Jupyter bool - Start
Script string - Start
Ssh bool - Volume
In intGb - Volume
Mount stringPath - Env
List<Runpod
Infra. Runpod. Inputs. Pod Env>
- Advanced
Start bool - Bound
Endpoint stringId - Category string
- Container
Disk intIn Gb - Container
Registry stringAuth Id - Docker
Args string - Earned float64
- Id string
- Image
Name string - Is
Public bool - Is
Runpod bool - Is
Serverless bool - Name string
- Ports string
- Readme string
- Runtime
In intMin - Start
Jupyter bool - Start
Script string - Start
Ssh bool - Volume
In intGb - Volume
Mount stringPath - Env
[]Pod
Env
- advanced
Start Boolean - bound
Endpoint StringId - category String
- container
Disk IntegerIn Gb - container
Registry StringAuth Id - docker
Args String - earned Double
- id String
- image
Name String - is
Public Boolean - is
Runpod Boolean - is
Serverless Boolean - name String
- ports String
- readme String
- runtime
In IntegerMin - start
Jupyter Boolean - start
Script String - start
Ssh Boolean - volume
In IntegerGb - volume
Mount StringPath - env
List<Pod
Env>
- advanced
Start boolean - bound
Endpoint stringId - category string
- container
Disk numberIn Gb - container
Registry stringAuth Id - docker
Args string - earned number
- id string
- image
Name string - is
Public boolean - is
Runpod boolean - is
Serverless boolean - name string
- ports string
- readme string
- runtime
In numberMin - start
Jupyter boolean - start
Script string - start
Ssh boolean - volume
In numberGb - volume
Mount stringPath - env
Pod
Env[]
- advanced_
start bool - bound_
endpoint_ strid - category str
- container_
disk_ intin_ gb - container_
registry_ strauth_ id - docker_
args str - earned float
- id str
- image_
name str - is_
public bool - is_
runpod bool - is_
serverless bool - name str
- ports str
- readme str
- runtime_
in_ intmin - start_
jupyter bool - start_
script str - start_
ssh bool - volume_
in_ intgb - volume_
mount_ strpath - env
Sequence[Pod
Env]
- advanced
Start Boolean - bound
Endpoint StringId - category String
- container
Disk NumberIn Gb - container
Registry StringAuth Id - docker
Args String - earned Number
- id String
- image
Name String - is
Public Boolean - is
Runpod Boolean - is
Serverless Boolean - name String
- ports String
- readme String
- runtime
In NumberMin - start
Jupyter Boolean - start
Script String - start
Ssh Boolean - volume
In NumberGb - volume
Mount StringPath - env List<Property Map>
Package Details
- Repository
- runpod runpod/pulumi-runpod-native
- License
- Apache-2.0