Module networking/v1beta1

Resources

Resources

Resource Ingress

class Ingress extends CustomResource

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

This resource waits until it is ready before registering success for create/update and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. Ingress object exists.
  2. Endpoint objects exist with matching names for each Ingress path (except when Service type is ExternalName).
  3. Ingress entry exists for ‘.status.loadBalancer.ingress’.

If the Ingress has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource. Note that the timeout value for Delete is not yet supported. See https://github.com/pulumi/pulumi-kubernetes/issues/746 for details.

constructor

new Ingress(name: string, args?: inputs.networking.v1beta1.Ingress, opts?: pulumi.CustomResourceOptions)

Create a networking.v1beta1.Ingress 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): Ingress

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

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Ingress. 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<"networking.k8s.io/v1beta1">;

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<"Ingress">;

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<outputs.meta.v1.ObjectMeta>;

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property spec

public spec: pulumi.Output<outputs.networking.v1beta1.IngressSpec>;

Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

public status: pulumi.Output<outputs.networking.v1beta1.IngressStatus>;

Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property urn

urn: Output<URN>;

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

Resource IngressList

class IngressList extends CustomResource

IngressList is a collection of Ingress.

constructor

new IngressList(name: string, args?: inputs.networking.v1beta1.IngressList, opts?: pulumi.CustomResourceOptions)

Create a networking.v1beta1.IngressList 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): IngressList

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

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of IngressList. 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<"networking.k8s.io/v1beta1">;

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<outputs.networking.v1beta1.Ingress[]>;

Items is the list of Ingress.

property kind

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

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<outputs.meta.v1.ListMeta>;

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property urn

urn: Output<URN>;

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