This page documents the language specification for the kubernetes package. If you're looking for help working with the inputs, outputs, or functions of kubernetes resources in a Pulumi program, please see the resource documentation for examples and API reference.
v1¶
- class
pulumi_kubernetes.batch.v1.Job(resource_name, opts=None, metadata=None, spec=None, __name__=None, __opts__=None)¶ Job represents the configuration of a single job.
This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:
The Job’s ‘.status.startTime’ is set, which indicates that the Job has started running.
The Job’s ‘.status.conditions’ has a status of type ‘Complete’, and a ‘status’ set to ‘True’.
- The Job’s ‘.status.conditions’ do not have a status of type ‘Failed’, with a
‘status’ set to ‘True’. If this condition is set, we should fail the Job immediately.
If the Job has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.
Create a Job resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
metadata (pulumi.Input[dict]) – Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (pulumi.Input[dict]) – Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata: pulumi.Output[dict] = None¶Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec: pulumi.Output[dict] = None¶Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status: pulumi.Output[dict] = None¶Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
Jobresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_kubernetes.batch.v1.JobList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶ JobList is a collection of jobs.
Create a JobList resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
items (pulumi.Input[list]) – items is the list of Jobs.
metadata (pulumi.Input[dict]) – Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
items: pulumi.Output[list] = None¶items is the list of Jobs.
metadata: pulumi.Output[dict] = None¶Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
JobListresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str