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.meta.v1.Status(resource_name, opts=None, code=None, details=None, message=None, metadata=None, reason=None, __name__=None, __opts__=None)¶ Status is a return value for calls that don’t return other objects.
Create a Status 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.
code (pulumi.Input[int]) – Suggested HTTP return code for this status, 0 if not set.
details (pulumi.Input[dict]) – Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
message (pulumi.Input[str]) – A human-readable description of the status of this operation.
metadata (pulumi.Input[dict]) – Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
reason (pulumi.Input[str]) – A machine-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
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
code: pulumi.Output[int] = None¶Suggested HTTP return code for this status, 0 if not set.
details: pulumi.Output[dict] = None¶Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
message: pulumi.Output[str] = None¶A human-readable description of the status of this operation.
metadata: pulumi.Output[dict] = None¶Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
reason: pulumi.Output[str] = None¶A machine-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
status: pulumi.Output[str] = None¶Status of the operation. One of: “Success” or “Failure”. 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
Statusresource, 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