runpod.Pod

Explore with Pulumi AI

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

Create Pod Resource

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

Constructor syntax

new Pod(name: string, args: PodArgs, opts?: CustomResourceOptions);

@overload
def Pod(resource_name: str,
        args: PodArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Pod(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        gpu_count: Optional[int] = None,
        image_name: Optional[str] = None,
        gpu_type_id: Optional[str] = None,
        min_upload: Optional[int] = None,
        docker_args: Optional[str] = None,
        min_vcpu_count: Optional[int] = None,
        deploy_cost: Optional[float] = None,
        name: Optional[str] = None,
        env: Optional[Sequence[PodEnvArgs]] = None,
        country_code: Optional[str] = None,
        container_disk_in_gb: Optional[int] = None,
        gpu_type_id_list: Optional[Sequence[str]] = None,
        cloud_type: Optional[str] = None,
        min_disk: Optional[int] = None,
        network_volume_id: Optional[str] = None,
        min_memory_in_gb: Optional[int] = None,
        ai_api_id: Optional[str] = None,
        data_center_id: Optional[str] = None,
        cuda_version: Optional[str] = None,
        min_download: Optional[int] = None,
        port: Optional[int] = None,
        ports: Optional[str] = None,
        savings_plan: Optional[SavingsPlanInputArgs] = None,
        start_jupyter: Optional[bool] = None,
        start_ssh: Optional[bool] = None,
        stop_after: Optional[str] = None,
        support_public_ip: Optional[bool] = None,
        template_id: Optional[str] = None,
        terminate_after: Optional[str] = None,
        volume_in_gb: Optional[int] = None,
        volume_key: Optional[str] = None,
        volume_mount_path: Optional[str] = None)

func NewPod(ctx *Context, name string, args PodArgs, opts ...ResourceOption) (*Pod, error)

public Pod(string name, PodArgs args, CustomResourceOptions? opts = null)

public Pod(String name, PodArgs args)
public Pod(String name, PodArgs args, CustomResourceOptions options)

type: runpod:Pod
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 PodArgs: 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 PodArgs: 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 PodArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PodArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PodArgs: 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 podResource = new Runpod.Pod("podResource", new()
{
    GpuCount = 0,
    ImageName = "string",
    GpuTypeId = "string",
    MinUpload = 0,
    DockerArgs = "string",
    MinVcpuCount = 0,
    DeployCost = 0,
    Name = "string",
    Env = new[]
    {
        new Runpod.Inputs.PodEnvArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    CountryCode = "string",
    ContainerDiskInGb = 0,
    GpuTypeIdList = new[]
    {
        "string",
    },
    CloudType = "string",
    MinDisk = 0,
    NetworkVolumeId = "string",
    MinMemoryInGb = 0,
    AiApiId = "string",
    DataCenterId = "string",
    CudaVersion = "string",
    MinDownload = 0,
    Port = 0,
    Ports = "string",
    SavingsPlan = new Runpod.Inputs.SavingsPlanInputArgs
    {
        PlanLength = "string",
        UpfrontCost = 0,
    },
    StartJupyter = false,
    StartSsh = false,
    StopAfter = "string",
    SupportPublicIp = false,
    TemplateId = "string",
    TerminateAfter = "string",
    VolumeInGb = 0,
    VolumeKey = "string",
    VolumeMountPath = "string",
});

example, err := runpod.NewPod(ctx, "podResource", &runpod.PodArgs{
	GpuCount:     pulumi.Int(0),
	ImageName:    pulumi.String("string"),
	GpuTypeId:    pulumi.String("string"),
	MinUpload:    pulumi.Int(0),
	DockerArgs:   pulumi.String("string"),
	MinVcpuCount: pulumi.Int(0),
	DeployCost:   pulumi.Float64(0),
	Name:         pulumi.String("string"),
	Env: runpod.PodEnvArray{
		&runpod.PodEnvArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	CountryCode:       pulumi.String("string"),
	ContainerDiskInGb: pulumi.Int(0),
	GpuTypeIdList: pulumi.StringArray{
		pulumi.String("string"),
	},
	CloudType:       pulumi.String("string"),
	MinDisk:         pulumi.Int(0),
	NetworkVolumeId: pulumi.String("string"),
	MinMemoryInGb:   pulumi.Int(0),
	AiApiId:         pulumi.String("string"),
	DataCenterId:    pulumi.String("string"),
	CudaVersion:     pulumi.String("string"),
	MinDownload:     pulumi.Int(0),
	Port:            pulumi.Int(0),
	Ports:           pulumi.String("string"),
	SavingsPlan: &runpod.SavingsPlanInputArgs{
		PlanLength:  pulumi.String("string"),
		UpfrontCost: pulumi.Float64(0),
	},
	StartJupyter:    pulumi.Bool(false),
	StartSsh:        pulumi.Bool(false),
	StopAfter:       pulumi.String("string"),
	SupportPublicIp: pulumi.Bool(false),
	TemplateId:      pulumi.String("string"),
	TerminateAfter:  pulumi.String("string"),
	VolumeInGb:      pulumi.Int(0),
	VolumeKey:       pulumi.String("string"),
	VolumeMountPath: pulumi.String("string"),
})

var podResource = new Pod("podResource", PodArgs.builder()
    .gpuCount(0)
    .imageName("string")
    .gpuTypeId("string")
    .minUpload(0)
    .dockerArgs("string")
    .minVcpuCount(0)
    .deployCost(0)
    .name("string")
    .env(PodEnvArgs.builder()
        .key("string")
        .value("string")
        .build())
    .countryCode("string")
    .containerDiskInGb(0)
    .gpuTypeIdList("string")
    .cloudType("string")
    .minDisk(0)
    .networkVolumeId("string")
    .minMemoryInGb(0)
    .aiApiId("string")
    .dataCenterId("string")
    .cudaVersion("string")
    .minDownload(0)
    .port(0)
    .ports("string")
    .savingsPlan(SavingsPlanInputArgs.builder()
        .planLength("string")
        .upfrontCost(0)
        .build())
    .startJupyter(false)
    .startSsh(false)
    .stopAfter("string")
    .supportPublicIp(false)
    .templateId("string")
    .terminateAfter("string")
    .volumeInGb(0)
    .volumeKey("string")
    .volumeMountPath("string")
    .build());

pod_resource = runpod.Pod("podResource",
    gpu_count=0,
    image_name="string",
    gpu_type_id="string",
    min_upload=0,
    docker_args="string",
    min_vcpu_count=0,
    deploy_cost=0,
    name="string",
    env=[{
        "key": "string",
        "value": "string",
    }],
    country_code="string",
    container_disk_in_gb=0,
    gpu_type_id_list=["string"],
    cloud_type="string",
    min_disk=0,
    network_volume_id="string",
    min_memory_in_gb=0,
    ai_api_id="string",
    data_center_id="string",
    cuda_version="string",
    min_download=0,
    port=0,
    ports="string",
    savings_plan={
        "plan_length": "string",
        "upfront_cost": 0,
    },
    start_jupyter=False,
    start_ssh=False,
    stop_after="string",
    support_public_ip=False,
    template_id="string",
    terminate_after="string",
    volume_in_gb=0,
    volume_key="string",
    volume_mount_path="string")

const podResource = new runpod.Pod("podResource", {
    gpuCount: 0,
    imageName: "string",
    gpuTypeId: "string",
    minUpload: 0,
    dockerArgs: "string",
    minVcpuCount: 0,
    deployCost: 0,
    name: "string",
    env: [{
        key: "string",
        value: "string",
    }],
    countryCode: "string",
    containerDiskInGb: 0,
    gpuTypeIdList: ["string"],
    cloudType: "string",
    minDisk: 0,
    networkVolumeId: "string",
    minMemoryInGb: 0,
    aiApiId: "string",
    dataCenterId: "string",
    cudaVersion: "string",
    minDownload: 0,
    port: 0,
    ports: "string",
    savingsPlan: {
        planLength: "string",
        upfrontCost: 0,
    },
    startJupyter: false,
    startSsh: false,
    stopAfter: "string",
    supportPublicIp: false,
    templateId: "string",
    terminateAfter: "string",
    volumeInGb: 0,
    volumeKey: "string",
    volumeMountPath: "string",
});

type: runpod:Pod
properties:
    aiApiId: string
    cloudType: string
    containerDiskInGb: 0
    countryCode: string
    cudaVersion: string
    dataCenterId: string
    deployCost: 0
    dockerArgs: string
    env:
        - key: string
          value: string
    gpuCount: 0
    gpuTypeId: string
    gpuTypeIdList:
        - string
    imageName: string
    minDisk: 0
    minDownload: 0
    minMemoryInGb: 0
    minUpload: 0
    minVcpuCount: 0
    name: string
    networkVolumeId: string
    port: 0
    ports: string
    savingsPlan:
        planLength: string
        upfrontCost: 0
    startJupyter: false
    startSsh: false
    stopAfter: string
    supportPublicIp: false
    templateId: string
    terminateAfter: string
    volumeInGb: 0
    volumeKey: string
    volumeMountPath: string