Get started with Pulumi in a free one hour introductory workshop. Register Now

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.apiextensions.v1.CustomResourceDefinition(resource_name, opts=None, spec=None, metadata=None, __name__=None, __opts__=None)

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

Create a CustomResourceDefinition 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.

  • spec (pulumi.Input[dict]) – spec describes how the user wants the resources to appear

  • metadata (pulumi.Input[dict]) –

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

spec: pulumi.Output[dict] = None

spec describes how the user wants the resources to appear

status: pulumi.Output[dict] = None

status indicates the actual state of the CustomResourceDefinition

static get(resource_name, id, opts=None)

Get the state of an existing CustomResourceDefinition resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as 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.apiextensions.v1.CustomResourceDefinitionList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)

CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

Create a CustomResourceDefinitionList 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 list individual CustomResourceDefinition objects

  • metadata (pulumi.Input[dict]) –

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 list individual CustomResourceDefinition objects

static get(resource_name, id, opts=None)

Get the state of an existing CustomResourceDefinitionList resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as 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