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.
v1beta1¶
- class
pulumi_kubernetes.events.v1beta1.Event(resource_name, opts=None, event_time=None, action=None, deprecated_count=None, deprecated_first_timestamp=None, deprecated_last_timestamp=None, deprecated_source=None, metadata=None, note=None, reason=None, regarding=None, related=None, reporting_controller=None, reporting_instance=None, series=None, type=None, __name__=None, __opts__=None)¶ Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.
Create a Event 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.
event_time (pulumi.Input[str]) – Required. Time when this Event was first observed.
action (pulumi.Input[str]) – What action was taken/failed regarding to the regarding object.
deprecated_count (pulumi.Input[int]) – Deprecated field assuring backward compatibility with core.v1 Event type
deprecated_first_timestamp (pulumi.Input[str]) – Deprecated field assuring backward compatibility with core.v1 Event type
deprecated_last_timestamp (pulumi.Input[str]) – Deprecated field assuring backward compatibility with core.v1 Event type
deprecated_source (pulumi.Input[dict]) – Deprecated field assuring backward compatibility with core.v1 Event type
metadata (pulumi.Input[dict]) –
note (pulumi.Input[str]) – Optional. A human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
reason (pulumi.Input[str]) – Why the action was taken.
regarding (pulumi.Input[dict]) – The object this Event is about. In most cases it’s an Object reporting controller implements. E.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
related (pulumi.Input[dict]) – Optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
reporting_controller (pulumi.Input[str]) – Name of the controller that emitted this Event, e.g.
kubernetes.io/kubelet.reporting_instance (pulumi.Input[str]) – ID of the controller instance, e.g.
kubelet-xyzf.series (pulumi.Input[dict]) – Data about the Event series this event represents or nil if it’s a singleton Event.
type (pulumi.Input[str]) – Type of this event (Normal, Warning), new types could be added in the future.
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
action: pulumi.Output[str] = None¶What action was taken/failed regarding to the regarding object.
deprecated_count: pulumi.Output[int] = None¶Deprecated field assuring backward compatibility with core.v1 Event type
deprecated_first_timestamp: pulumi.Output[str] = None¶Deprecated field assuring backward compatibility with core.v1 Event type
deprecated_last_timestamp: pulumi.Output[str] = None¶Deprecated field assuring backward compatibility with core.v1 Event type
deprecated_source: pulumi.Output[dict] = None¶Deprecated field assuring backward compatibility with core.v1 Event type
event_time: pulumi.Output[str] = None¶Required. Time when this Event was first observed.
note: pulumi.Output[str] = None¶Optional. A human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
reason: pulumi.Output[str] = None¶Why the action was taken.
regarding: pulumi.Output[dict] = None¶The object this Event is about. In most cases it’s an Object reporting controller implements. E.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
Optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
reporting_controller: pulumi.Output[str] = None¶Name of the controller that emitted this Event, e.g.
kubernetes.io/kubelet.
reporting_instance: pulumi.Output[str] = None¶ID of the controller instance, e.g.
kubelet-xyzf.
series: pulumi.Output[dict] = None¶Data about the Event series this event represents or nil if it’s a singleton Event.
type: pulumi.Output[str] = None¶Type of this event (Normal, Warning), new types could be added in the future.
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
Eventresource, 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.events.v1beta1.EventList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶ EventList is a list of Event objects.
Create a EventList 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 a list of schema objects.
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 a list of schema objects.
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
EventListresource, 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