@pulumi/kubernetes
Version:
[](https://github.com/pulumi/pulumi-kubernetes/actions) [](https://slack.pulumi.com) [![NPM version](https:/
98 lines • 6.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* Patch resources are used to modify existing Kubernetes resources by using
* Server-Side Apply updates. The name of the resource must be specified, but all other properties are optional. More than
* one patch may be applied to the same resource, and a random FieldManager name will be used for each Patch resource.
* Conflicts will result in an error by default, but can be forced using the "pulumi.com/patchForce" annotation. See the
* [Server-Side Apply Docs](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/managing-resources-with-server-side-apply/) for
* additional information about using Server-Side Apply to manage Kubernetes resources with Pulumi.
* 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:
*
* 1. The Job's '.status.startTime' is set, which indicates that the Job has started running.
* 2. The Job's '.status.conditions' has a status of type 'Complete', and a 'status' set
* to 'True'.
* 3. 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.
*
* By default, if a resource failed to become ready in a previous update,
* Pulumi will continue to wait for readiness on the next update. If you would prefer
* to schedule a replacement for an unready resource on the next update, you can add the
* "pulumi.com/replaceUnready": "true" annotation to the resource definition.
*/
export declare class JobPatch extends pulumi.CustomResource {
/**
* Get an existing JobPatch resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): JobPatch;
/**
* Returns true if the given object is an instance of JobPatch. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is JobPatch;
/**
* 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/sig-architecture/api-conventions.md#resources
*/
readonly apiVersion: pulumi.Output<"batch/v1">;
/**
* 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/sig-architecture/api-conventions.md#types-kinds
*/
readonly kind: pulumi.Output<"Job">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
readonly metadata: pulumi.Output<outputs.meta.v1.ObjectMetaPatch>;
/**
* 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
*/
readonly spec: pulumi.Output<outputs.batch.v1.JobSpecPatch>;
/**
* Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*/
readonly status: pulumi.Output<outputs.batch.v1.JobStatusPatch>;
/**
* Create a JobPatch resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: JobPatchArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a JobPatch resource.
*/
export interface JobPatchArgs {
/**
* 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/sig-architecture/api-conventions.md#resources
*/
apiVersion?: pulumi.Input<"batch/v1" | undefined>;
/**
* 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/sig-architecture/api-conventions.md#types-kinds
*/
kind?: pulumi.Input<"Job" | undefined>;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
metadata?: pulumi.Input<inputs.meta.v1.ObjectMetaPatch | undefined>;
/**
* 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
*/
spec?: pulumi.Input<inputs.batch.v1.JobSpecPatch | undefined>;
}
//# sourceMappingURL=jobPatch.d.ts.map