Want to learn about running containers in Lambda? Join our free hands-on workshop. Register Now

Module apiextensions/v1

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.

Resources

Others

Resources

Resource CustomResourceDefinition

class CustomResourceDefinition extends CustomResource

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

constructor

new CustomResourceDefinition(name: string, args?: CustomResourceDefinitionArgs, opts?: pulumi.CustomResourceOptions)

Create a CustomResourceDefinition resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CustomResourceDefinition

Get an existing CustomResourceDefinition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CustomResourceDefinition

Returns true if the given object is an instance of CustomResourceDefinition. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"apiextensions.k8s.io/v1">;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<"CustomResourceDefinition">;

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

property metadata

public metadata: pulumi.Output<ObjectMeta>;

property spec

public spec: pulumi.Output<CustomResourceDefinitionSpec>;

spec describes how the user wants the resources to appear

property status

public status: pulumi.Output<CustomResourceDefinitionStatus>;

status indicates the actual state of the CustomResourceDefinition

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CustomResourceDefinitionList

class CustomResourceDefinitionList extends CustomResource

CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

constructor

new CustomResourceDefinitionList(name: string, args?: CustomResourceDefinitionListArgs, opts?: pulumi.CustomResourceOptions)

Create a CustomResourceDefinitionList resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CustomResourceDefinitionList

Get an existing CustomResourceDefinitionList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CustomResourceDefinitionList

Returns true if the given object is an instance of CustomResourceDefinitionList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"apiextensions.k8s.io/v1">;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<CustomResourceDefinition[]>;

items list individual CustomResourceDefinition objects

property kind

public kind: pulumi.Output<"CustomResourceDefinitionList">;

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

property metadata

public metadata: pulumi.Output<ListMeta>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface CustomResourceDefinitionArgs

interface CustomResourceDefinitionArgs

The set of arguments for constructing a CustomResourceDefinition resource.

property apiVersion

apiVersion?: pulumi.Input<"apiextensions.k8s.io/v1">;

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

property kind

kind?: pulumi.Input<"CustomResourceDefinition">;

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

property metadata

metadata?: pulumi.Input<ObjectMeta>;

property spec

spec: pulumi.Input<CustomResourceDefinitionSpec>;

spec describes how the user wants the resources to appear

interface CustomResourceDefinitionListArgs

interface CustomResourceDefinitionListArgs

The set of arguments for constructing a CustomResourceDefinitionList resource.

property apiVersion

apiVersion?: pulumi.Input<"apiextensions.k8s.io/v1">;

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

property items

items: pulumi.Input<pulumi.Input<CustomResourceDefinition>[]>;

items list individual CustomResourceDefinition objects

property kind

kind?: pulumi.Input<"CustomResourceDefinitionList">;

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

property metadata

metadata?: pulumi.Input<ListMeta>;