iterative 0.11.20, Apr 14 25

iterative 0.11.20 published on Monday, Apr 14, 2025 by iterative

iterative.CmlRunner

Explore with Pulumi AI

iterative 0.11.20 published on Monday, Apr 14, 2025 by iterative

Create CmlRunner Resource

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

Constructor syntax

new CmlRunner(name: string, args: CmlRunnerArgs, opts?: CustomResourceOptions);

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

@overload
def CmlRunner(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              repo: Optional[str] = None,
              driver: Optional[str] = None,
              ssh_private: Optional[str] = None,
              image: Optional[str] = None,
              cml_version: Optional[str] = None,
              docker_volumes: Optional[Sequence[str]] = None,
              cloud: Optional[str] = None,
              idle_timeout: Optional[float] = None,
              instance_type: Optional[str] = None,
              instance_gpu: Optional[str] = None,
              instance_hdd_size: Optional[float] = None,
              instance_permission_set: Optional[str] = None,
              cml_runner_id: Optional[str] = None,
              aws_subnet_id: Optional[str] = None,
              labels: Optional[str] = None,
              metadata: Optional[Mapping[str, str]] = None,
              name: Optional[str] = None,
              region: Optional[str] = None,
              aws_security_group: Optional[str] = None,
              single: Optional[bool] = None,
              spot: Optional[bool] = None,
              spot_price: Optional[float] = None,
              kubernetes_node_selector: Optional[Mapping[str, str]] = None,
              startup_script: Optional[str] = None,
              timeouts: Optional[CmlRunnerTimeoutsArgs] = None,
              token: Optional[str] = None)

func NewCmlRunner(ctx *Context, name string, args CmlRunnerArgs, opts ...ResourceOption) (*CmlRunner, error)

public CmlRunner(string name, CmlRunnerArgs args, CustomResourceOptions? opts = null)

public CmlRunner(String name, CmlRunnerArgs args)
public CmlRunner(String name, CmlRunnerArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args CmlRunnerArgs: 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 cmlRunnerResource = new Iterative.CmlRunner("cmlRunnerResource", new()
{
    Repo = "string",
    Driver = "string",
    SshPrivate = "string",
    Image = "string",
    CmlVersion = "string",
    DockerVolumes = new[]
    {
        "string",
    },
    Cloud = "string",
    IdleTimeout = 0,
    InstanceType = "string",
    InstanceGpu = "string",
    InstanceHddSize = 0,
    InstancePermissionSet = "string",
    CmlRunnerId = "string",
    AwsSubnetId = "string",
    Labels = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Region = "string",
    AwsSecurityGroup = "string",
    Single = false,
    Spot = false,
    SpotPrice = 0,
    KubernetesNodeSelector = 
    {
        { "string", "string" },
    },
    StartupScript = "string",
    Timeouts = new Iterative.Inputs.CmlRunnerTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    Token = "string",
});

example, err := iterative.NewCmlRunner(ctx, "cmlRunnerResource", &iterative.CmlRunnerArgs{
	Repo:       pulumi.String("string"),
	Driver:     pulumi.String("string"),
	SshPrivate: pulumi.String("string"),
	Image:      pulumi.String("string"),
	CmlVersion: pulumi.String("string"),
	DockerVolumes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Cloud:                 pulumi.String("string"),
	IdleTimeout:           pulumi.Float64(0),
	InstanceType:          pulumi.String("string"),
	InstanceGpu:           pulumi.String("string"),
	InstanceHddSize:       pulumi.Float64(0),
	InstancePermissionSet: pulumi.String("string"),
	CmlRunnerId:           pulumi.String("string"),
	AwsSubnetId:           pulumi.String("string"),
	Labels:                pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:             pulumi.String("string"),
	Region:           pulumi.String("string"),
	AwsSecurityGroup: pulumi.String("string"),
	Single:           pulumi.Bool(false),
	Spot:             pulumi.Bool(false),
	SpotPrice:        pulumi.Float64(0),
	KubernetesNodeSelector: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	StartupScript: pulumi.String("string"),
	Timeouts: &iterative.CmlRunnerTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	Token: pulumi.String("string"),
})

var cmlRunnerResource = new CmlRunner("cmlRunnerResource", CmlRunnerArgs.builder()
    .repo("string")
    .driver("string")
    .sshPrivate("string")
    .image("string")
    .cmlVersion("string")
    .dockerVolumes("string")
    .cloud("string")
    .idleTimeout(0)
    .instanceType("string")
    .instanceGpu("string")
    .instanceHddSize(0)
    .instancePermissionSet("string")
    .cmlRunnerId("string")
    .awsSubnetId("string")
    .labels("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .region("string")
    .awsSecurityGroup("string")
    .single(false)
    .spot(false)
    .spotPrice(0)
    .kubernetesNodeSelector(Map.of("string", "string"))
    .startupScript("string")
    .timeouts(CmlRunnerTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .token("string")
    .build());

cml_runner_resource = iterative.CmlRunner("cmlRunnerResource",
    repo="string",
    driver="string",
    ssh_private="string",
    image="string",
    cml_version="string",
    docker_volumes=["string"],
    cloud="string",
    idle_timeout=0,
    instance_type="string",
    instance_gpu="string",
    instance_hdd_size=0,
    instance_permission_set="string",
    cml_runner_id="string",
    aws_subnet_id="string",
    labels="string",
    metadata={
        "string": "string",
    },
    name="string",
    region="string",
    aws_security_group="string",
    single=False,
    spot=False,
    spot_price=0,
    kubernetes_node_selector={
        "string": "string",
    },
    startup_script="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    token="string")

const cmlRunnerResource = new iterative.CmlRunner("cmlRunnerResource", {
    repo: "string",
    driver: "string",
    sshPrivate: "string",
    image: "string",
    cmlVersion: "string",
    dockerVolumes: ["string"],
    cloud: "string",
    idleTimeout: 0,
    instanceType: "string",
    instanceGpu: "string",
    instanceHddSize: 0,
    instancePermissionSet: "string",
    cmlRunnerId: "string",
    awsSubnetId: "string",
    labels: "string",
    metadata: {
        string: "string",
    },
    name: "string",
    region: "string",
    awsSecurityGroup: "string",
    single: false,
    spot: false,
    spotPrice: 0,
    kubernetesNodeSelector: {
        string: "string",
    },
    startupScript: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    token: "string",
});

type: iterative:CmlRunner
properties:
    awsSecurityGroup: string
    awsSubnetId: string
    cloud: string
    cmlRunnerId: string
    cmlVersion: string
    dockerVolumes:
        - string
    driver: string
    idleTimeout: 0
    image: string
    instanceGpu: string
    instanceHddSize: 0
    instancePermissionSet: string
    instanceType: string
    kubernetesNodeSelector:
        string: string
    labels: string
    metadata:
        string: string
    name: string
    region: string
    repo: string
    single: false
    spot: false
    spotPrice: 0
    sshPrivate: string
    startupScript: string
    timeouts:
        create: string
        delete: string
        update: string
    token: string

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

Driver string
Repo string
AwsSecurityGroup string
AwsSubnetId string
Cloud string
CmlRunnerId string
CmlVersion string
DockerVolumes List<string>
IdleTimeout double
Image string
InstanceGpu string
InstanceHddSize double
InstancePermissionSet string
InstanceType string
KubernetesNodeSelector Dictionary<string, string>
Labels string
Metadata Dictionary<string, string>
Name string
Region string
Single bool
Spot bool
SpotPrice double
SshPrivate string
StartupScript string
Timeouts CmlRunnerTimeouts
Token string

Driver string
Repo string
AwsSecurityGroup string
AwsSubnetId string
Cloud string
CmlRunnerId string
CmlVersion string
DockerVolumes []string
IdleTimeout float64
Image string
InstanceGpu string
InstanceHddSize float64
InstancePermissionSet string
InstanceType string
KubernetesNodeSelector map[string]string
Labels string
Metadata map[string]string
Name string
Region string
Single bool
Spot bool
SpotPrice float64
SshPrivate string
StartupScript string
Timeouts CmlRunnerTimeoutsArgs
Token string

driver String
repo String
awsSecurityGroup String
awsSubnetId String
cloud String
cmlRunnerId String
cmlVersion String
dockerVolumes List<String>
idleTimeout Double
image String
instanceGpu String
instanceHddSize Double
instancePermissionSet String
instanceType String
kubernetesNodeSelector Map<String,String>
labels String
metadata Map<String,String>
name String
region String
single Boolean
spot Boolean
spotPrice Double
sshPrivate String
startupScript String
timeouts CmlRunnerTimeouts
token String

driver string
repo string
awsSecurityGroup string
awsSubnetId string
cloud string
cmlRunnerId string
cmlVersion string
dockerVolumes string[]
idleTimeout number
image string
instanceGpu string
instanceHddSize number
instancePermissionSet string
instanceType string
kubernetesNodeSelector {[key: string]: string}
labels string
metadata {[key: string]: string}
name string
region string
single boolean
spot boolean
spotPrice number
sshPrivate string
startupScript string
timeouts CmlRunnerTimeouts
token string

driver str
repo str
aws_security_group str
aws_subnet_id str
cloud str
cml_runner_id str
cml_version str
docker_volumes Sequence[str]
idle_timeout float
image str
instance_gpu str
instance_hdd_size float
instance_permission_set str
instance_type str
kubernetes_node_selector Mapping[str, str]
labels str
metadata Mapping[str, str]
name str
region str
single bool
spot bool
spot_price float
ssh_private str
startup_script str
timeouts CmlRunnerTimeoutsArgs
token str

driver String
repo String
awsSecurityGroup String
awsSubnetId String
cloud String
cmlRunnerId String
cmlVersion String
dockerVolumes List<String>
idleTimeout Number
image String
instanceGpu String
instanceHddSize Number
instancePermissionSet String
instanceType String
kubernetesNodeSelector Map<String>
labels String
metadata Map<String>
name String
region String
single Boolean
spot Boolean
spotPrice Number
sshPrivate String
startupScript String
timeouts Property Map
token String

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
InstanceIp string
InstanceLaunchTime string
SshPublic string

Id string: The provider-assigned unique ID for this managed resource.
InstanceIp string
InstanceLaunchTime string
SshPublic string

id String: The provider-assigned unique ID for this managed resource.
instanceIp String
instanceLaunchTime String
sshPublic String

id string: The provider-assigned unique ID for this managed resource.
instanceIp string
instanceLaunchTime string
sshPublic string

id str: The provider-assigned unique ID for this managed resource.
instance_ip str
instance_launch_time str
ssh_public str

id String: The provider-assigned unique ID for this managed resource.
instanceIp String
instanceLaunchTime String
sshPublic String

Look up Existing CmlRunner Resource

Get an existing CmlRunner resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CmlRunnerState, opts?: CustomResourceOptions): CmlRunner

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_security_group: Optional[str] = None,
        aws_subnet_id: Optional[str] = None,
        cloud: Optional[str] = None,
        cml_runner_id: Optional[str] = None,
        cml_version: Optional[str] = None,
        docker_volumes: Optional[Sequence[str]] = None,
        driver: Optional[str] = None,
        idle_timeout: Optional[float] = None,
        image: Optional[str] = None,
        instance_gpu: Optional[str] = None,
        instance_hdd_size: Optional[float] = None,
        instance_ip: Optional[str] = None,
        instance_launch_time: Optional[str] = None,
        instance_permission_set: Optional[str] = None,
        instance_type: Optional[str] = None,
        kubernetes_node_selector: Optional[Mapping[str, str]] = None,
        labels: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        repo: Optional[str] = None,
        single: Optional[bool] = None,
        spot: Optional[bool] = None,
        spot_price: Optional[float] = None,
        ssh_private: Optional[str] = None,
        ssh_public: Optional[str] = None,
        startup_script: Optional[str] = None,
        timeouts: Optional[CmlRunnerTimeoutsArgs] = None,
        token: Optional[str] = None) -> CmlRunner

func GetCmlRunner(ctx *Context, name string, id IDInput, state *CmlRunnerState, opts ...ResourceOption) (*CmlRunner, error)

public static CmlRunner Get(string name, Input<string> id, CmlRunnerState? state, CustomResourceOptions? opts = null)

public static CmlRunner get(String name, Output<String> id, CmlRunnerState state, CustomResourceOptions options)

resources:  _:    type: iterative:CmlRunner    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AwsSecurityGroup string
AwsSubnetId string
Cloud string
CmlRunnerId string
CmlVersion string
DockerVolumes List<string>
Driver string
IdleTimeout double
Image string
InstanceGpu string
InstanceHddSize double
InstanceIp string
InstanceLaunchTime string
InstancePermissionSet string
InstanceType string
KubernetesNodeSelector Dictionary<string, string>
Labels string
Metadata Dictionary<string, string>
Name string
Region string
Repo string
Single bool
Spot bool
SpotPrice double
SshPrivate string
SshPublic string
StartupScript string
Timeouts CmlRunnerTimeouts
Token string

AwsSecurityGroup string
AwsSubnetId string
Cloud string
CmlRunnerId string
CmlVersion string
DockerVolumes []string
Driver string
IdleTimeout float64
Image string
InstanceGpu string
InstanceHddSize float64
InstanceIp string
InstanceLaunchTime string
InstancePermissionSet string
InstanceType string
KubernetesNodeSelector map[string]string
Labels string
Metadata map[string]string
Name string
Region string
Repo string
Single bool
Spot bool
SpotPrice float64
SshPrivate string
SshPublic string
StartupScript string
Timeouts CmlRunnerTimeoutsArgs
Token string

awsSecurityGroup String
awsSubnetId String
cloud String
cmlRunnerId String
cmlVersion String
dockerVolumes List<String>
driver String
idleTimeout Double
image String
instanceGpu String
instanceHddSize Double
instanceIp String
instanceLaunchTime String
instancePermissionSet String
instanceType String
kubernetesNodeSelector Map<String,String>
labels String
metadata Map<String,String>
name String
region String
repo String
single Boolean
spot Boolean
spotPrice Double
sshPrivate String
sshPublic String
startupScript String
timeouts CmlRunnerTimeouts
token String

awsSecurityGroup string
awsSubnetId string
cloud string
cmlRunnerId string
cmlVersion string
dockerVolumes string[]
driver string
idleTimeout number
image string
instanceGpu string
instanceHddSize number
instanceIp string
instanceLaunchTime string
instancePermissionSet string
instanceType string
kubernetesNodeSelector {[key: string]: string}
labels string
metadata {[key: string]: string}
name string
region string
repo string
single boolean
spot boolean
spotPrice number
sshPrivate string
sshPublic string
startupScript string
timeouts CmlRunnerTimeouts
token string

aws_security_group str
aws_subnet_id str
cloud str
cml_runner_id str
cml_version str
docker_volumes Sequence[str]
driver str
idle_timeout float
image str
instance_gpu str
instance_hdd_size float
instance_ip str
instance_launch_time str
instance_permission_set str
instance_type str
kubernetes_node_selector Mapping[str, str]
labels str
metadata Mapping[str, str]
name str
region str
repo str
single bool
spot bool
spot_price float
ssh_private str
ssh_public str
startup_script str
timeouts CmlRunnerTimeoutsArgs
token str

awsSecurityGroup String
awsSubnetId String
cloud String
cmlRunnerId String
cmlVersion String
dockerVolumes List<String>
driver String
idleTimeout Number
image String
instanceGpu String
instanceHddSize Number
instanceIp String
instanceLaunchTime String
instancePermissionSet String
instanceType String
kubernetesNodeSelector Map<String>
labels String
metadata Map<String>
name String
region String
repo String
single Boolean
spot Boolean
spotPrice Number
sshPrivate String
sshPublic String
startupScript String
timeouts Property Map
token String

Supporting Types

CmlRunnerTimeouts, CmlRunnerTimeoutsArgs

Create string
Delete string
Update string

Create string
Delete string
Update string

create String
delete String
update String

create string
delete string
update string

create str
delete str
update str

create String
delete String
update String

Package Details

Repository: iterative iterative/terraform-provider-iterative
License
Notes: This Pulumi package is based on the iterative Terraform Provider.

iterative 0.11.20 published on Monday, Apr 14, 2025 by iterative

iterative/terraform-provider-iterative

iterative.CmlRunner

On this page

On this page

Create CmlRunner Resource

Constructor syntax

Parameters

Constructor example

CmlRunner Resource Properties

Inputs

Outputs

Look up Existing CmlRunner Resource

Supporting Types

CmlRunnerTimeouts, CmlRunnerTimeoutsArgs

Package Details

On this page

On this page