apiextensions

Documentation

Index

• type CustomResource
  • func GetCustomResource(ctx *pulumi.Context, name string, id pulumi.IDInput, ...) (*CustomResource, error)
  • func NewCustomResource(ctx *pulumi.Context, name string, args *CustomResourceArgs, ...) (*CustomResource, error)
• type CustomResourceArgs
  • func (CustomResourceArgs) ElementType() reflect.Type
• type CustomResourcePatch
  • func NewCustomResourcePatch(ctx *pulumi.Context, name string, args *CustomResourcePatchArgs, ...) (*CustomResourcePatch, error)
• type CustomResourcePatchArgs
  • func (CustomResourcePatchArgs) ElementType() reflect.Type
• type CustomResourceState
  • func (CustomResourceState) ElementType() reflect.Type

Types

type CustomResource

type CustomResource struct {
	pulumi.CustomResourceState

	// 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.StringOutput `pulumi:"apiVersion"`
	// 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.StringOutput `pulumi:"kind"`
	// Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
	Metadata metav1.ObjectMetaPtrOutput `pulumi:"metadata"`
	// Untyped map that holds any user-defined fields.
	OtherFields pulumi.MapOutput `pulumi:""`
}

CustomResource represents a resource definition we'd use to create an instance of a Kubernetes CustomResourceDefinition (CRD). For example, the CoreOS Prometheus operator exposes a CRD `monitoring.coreos.com/ServiceMonitor`; to create a `ServiceMonitor`, we'd pass a `CustomResourceArgs` containing the `ServiceMonitor` definition to `apiextensions.CustomResource`.

func GetCustomResource

func GetCustomResource(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CustomResourceState, opts ...pulumi.ResourceOption) (*CustomResource, error)

GetCustomResource gets an existing CustomResource resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCustomResource

func NewCustomResource(ctx *pulumi.Context,
	name string, args *CustomResourceArgs, opts ...pulumi.ResourceOption) (*CustomResource, error)

NewCustomResource registers a new resource with the given unique name, arguments, and options.

type CustomResourceArgs

type CustomResourceArgs struct {
	// 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.StringInput
	// 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.StringInput
	// Standard object metadata.
	Metadata metav1.ObjectMetaPtrInput
	// Untyped map that holds any user-defined fields.
	OtherFields kubernetes.UntypedArgs
}

The set of arguments for constructing a CustomResource resource.

func (CustomResourceArgs) ElementType

func (CustomResourceArgs) ElementType() reflect.Type

type CustomResourcePatch

type CustomResourcePatch struct {
	pulumi.CustomResourceState

	// 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.StringOutput `pulumi:"apiVersion"`
	// 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.StringOutput `pulumi:"kind"`
	// Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
	Metadata metav1.ObjectMetaPtrOutput `pulumi:"metadata"`
	// Untyped map that holds any user-defined fields.
	OtherFields pulumi.MapOutput `pulumi:""`
}

CustomResourcePatch represents a resource definition we'd use to create an instance of a Kubernetes CustomResourceDefinition (CRD). For example, the CoreOS Prometheus operator exposes a CRD `monitoring.coreos.com/ServiceMonitor`; to create a `ServiceMonitor`, we'd pass a `CustomResourceArgs` containing the `ServiceMonitor` definition to `apiextensions.CustomResourcePatch`.

func NewCustomResourcePatch

func NewCustomResourcePatch(ctx *pulumi.Context,
	name string, args *CustomResourcePatchArgs, opts ...pulumi.ResourceOption) (*CustomResourcePatch, error)

NewCustomResourcePatch registers a new resource with the given unique name, arguments, and options.

type CustomResourcePatchArgs

type CustomResourcePatchArgs struct {
	// 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.StringInput
	// 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.StringInput
	// Standard object metadata.
	Metadata metav1.ObjectMetaPtrInput
	// Untyped map that holds any user-defined fields.
	OtherFields kubernetes.UntypedArgs
}

The set of arguments for constructing a CustomResourcePatch resource.

func (CustomResourcePatchArgs) ElementType

func (CustomResourcePatchArgs) ElementType() reflect.Type

type CustomResourceState

type CustomResourceState struct {
	// 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.StringPtrInput
	// 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.StringPtrInput
	// Standard object metadata.
	Metadata metav1.ObjectMetaPtrInput
}

func (CustomResourceState) ElementType

func (CustomResourceState) ElementType() reflect.Type