@pulumi/kubernetes
Version:
[](https://github.com/pulumi/pulumi-kubernetes/actions) [](https://slack.pulumi.com) [ • 4.17 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* ResourceClaim describes a request for access to resources in the cluster, for use by workloads. For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.
*
* This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
*/
export declare class ResourceClaim extends pulumi.CustomResource {
/**
* Get an existing ResourceClaim 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): ResourceClaim;
/**
* Returns true if the given object is an instance of ResourceClaim. 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 ResourceClaim;
/**
* 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<"resource.k8s.io/v1alpha3">;
/**
* 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<"ResourceClaim">;
/**
* Standard object metadata
*/
readonly metadata: pulumi.Output<outputs.meta.v1.ObjectMeta>;
/**
* Spec describes what is being requested and how to configure it. The spec is immutable.
*/
readonly spec: pulumi.Output<outputs.resource.v1alpha3.ResourceClaimSpec>;
/**
* Status describes whether the claim is ready to use and what has been allocated.
*/
readonly status: pulumi.Output<outputs.resource.v1alpha3.ResourceClaimStatus>;
/**
* Create a ResourceClaim 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?: ResourceClaimArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ResourceClaim resource.
*/
export interface ResourceClaimArgs {
/**
* 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<"resource.k8s.io/v1alpha3">;
/**
* 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<"ResourceClaim">;
/**
* Standard object metadata
*/
metadata?: pulumi.Input<inputs.meta.v1.ObjectMeta>;
/**
* Spec describes what is being requested and how to configure it. The spec is immutable.
*/
spec: pulumi.Input<inputs.resource.v1alpha3.ResourceClaimSpec>;
}