API Reference

Classes

Name	Description
AWSLoadBalancerControllerObject	No description
IntOrString	No description

Structs

Name	Description
AWSLoadBalancerControllerProps	No description
HttpIngressPath	HTTPIngressPath associates a path regex with a backend.
HttpIngressRuleValue	HTTPIngressRuleValue is a list of http selectors pointing to backends.
IngressBackend	IngressBackend describes all endpoints for a given service and port.
IngressRule	IngressRule represents the rules mapping the paths under a specified host to the related backend services.
IngressSpec	IngressSpec describes the Ingress the user wishes to exist.
IngressTls	IngressTLS describes the transport layer security associated with an Ingress.
Initializer	Initializer is information about an initializer that has not yet completed.
Initializers	Initializers tracks the progress of initialization.
KubeStatusProps	Status is a return value for calls that don't return other objects.
ListMeta	ListMeta describes metadata that synthetic resources must have, including lists and various status objects.
ManagedFieldsEntry	ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
ObjectMeta	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
OwnerReference	OwnerReference contains enough information to let you identify an owning object.
StatusCause	StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
StatusDetails	StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response.

class AWSLoadBalancerControllerObject 🔹

Implements: IConstruct, IDependable Extends: ApiObject

Initializer

Defines an "extentions" API object for AWS Load Balancer Controller - https://github.com/kubernetes-sigs/aws-load-balancer-controller.

new AWSLoadBalancerControllerObject(scope: Construct, id: string, props?: AWSLoadBalancerControllerProps)

scope (Construct) the scope in which to define this object.
id (string) a scope-local name for the object.
props (AWSLoadBalancerControllerProps) initialization props.
- metadata (ObjectMeta) Standard object's metadata. Optional
- spec (IngressSpec) Spec defines the behavior of the ingress. Optional

Properties

Name	Type	Description
static GVK🔹	`GroupVersionKind`

Methods

static manifest(props?)🔹

Renders a Kubernetes manifest for an ingress object. https://github.com/kubernetes-sigs/aws-load-balancer-controller.

This can be used to inline resource manifests inside other objects (e.g. as templates).

static manifest(props?: AWSLoadBalancerControllerProps): any

props (AWSLoadBalancerControllerProps) initialization props.
- metadata (ObjectMeta) Standard object's metadata. Optional
- spec (IngressSpec) Spec defines the behavior of the ingress. Optional

Returns:

any

class IntOrString 🔹

Methods

static fromNumber(value)🔹

static fromNumber(value: number): IntOrString

value (number) No description

Returns:

IntOrString

static fromString(value)🔹

static fromString(value: string): IntOrString

value (string) No description

Returns:

IntOrString

struct AWSLoadBalancerControllerProps 🔹

Name	Type	Description
metadata?🔹	`ObjectMeta`	Standard object's metadata. *Optional*
spec?🔹	`IngressSpec`	Spec defines the behavior of the ingress. *Optional*

struct HttpIngressPath 🔹

HTTPIngressPath associates a path regex with a backend.

Incoming urls matching the path are forwarded to the backend.

Name	Type	Description
backend🔹	`IngressBackend`	Backend defines the referenced service endpoint to which the traffic will be forwarded to.
path?🔹	`string`	Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend. *Optional*

struct HttpIngressRuleValue 🔹

HTTPIngressRuleValue is a list of http selectors pointing to backends.

In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.

Name	Type	Description
paths🔹	`Array<HttpIngressPath>`	A collection of paths that map requests to backends.

struct IngressBackend 🔹

IngressBackend describes all endpoints for a given service and port.

Name	Type	Description
serviceName🔹	`string`	Specifies the name of the referenced service.
servicePort🔹	`IntOrString`	Specifies the port of the referenced service.

struct IngressRule 🔹

IngressRule represents the rules mapping the paths under a specified host to the related backend services.

Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.

Name	Type	Description
host?🔹	`string`	Host is the fully qualified domain name of a network host, as defined by RFC 3986. *Optional*
http?🔹	`HttpIngressRuleValue`	*Optional*

struct IngressSpec 🔹

IngressSpec describes the Ingress the user wishes to exist.

Name	Type	Description
backend?🔹	`IngressBackend`	A default backend capable of servicing requests that don't match any rule. *Optional*
rules?🔹	`Array<IngressRule>`	A list of host rules used to configure the Ingress. *Optional*
tls?🔹	`Array<IngressTls>`	TLS configuration. *Optional*

struct IngressTls 🔹

IngressTLS describes the transport layer security associated with an Ingress.

Name	Type	Description
hosts?🔹	`Array`	Hosts are a list of hosts included in the TLS certificate. *Default*: the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
secretName?🔹	`string`	SecretName is the name of the secret used to terminate SSL traffic on 443. *Optional*

struct Initializer 🔹

Initializer is information about an initializer that has not yet completed.

Name	Type	Description
name🔹	`string`	name of the process that is responsible for initializing this object.

struct Initializers 🔹

Initializers tracks the progress of initialization.

Name	Type	Description
pending🔹	`Array<Initializer>`	Pending is a list of initializers that must execute in order before this object is visible.
result?🔹	`KubeStatusProps`	If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion. *Optional*

struct KubeStatusProps 🔹

Status is a return value for calls that don't return other objects.

Name	Type	Description
code?🔹	`number`	Suggested HTTP return code for this status, 0 if not set. *Optional*
details?🔹	`StatusDetails`	Extended data associated with the reason. *Optional*
message?🔹	`string`	A human-readable description of the status of this operation. *Optional*
metadata?🔹	`ListMeta`	Standard list metadata. *Optional*
reason?🔹	`string`	A machine-readable description of why this operation is in the "Failure" status. *Optional*

struct ListMeta 🔹

ListMeta describes metadata that synthetic resources must have, including lists and various status objects.

A resource may have only one of {ObjectMeta, ListMeta}.

Name	Type	Description
continue?🔹	`string`	continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. *Optional*
remainingItemCount?🔹	`number`	remainingItemCount is the number of subsequent items in the list which are not included in this list response. *Optional*
resourceVersion?🔹	`string`	String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. *Optional*
selfLink?🔹	`string`	selfLink is a URL representing this object. *Optional*

struct ManagedFieldsEntry 🔹

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Name	Type	Description
apiVersion?🔹	`string`	APIVersion defines the version of this resource that this field set applies to. *Optional*
fields?🔹	`any`	Fields identifies a set of fields. *Optional*
manager?🔹	`string`	Manager is an identifier of the workflow managing these fields. *Optional*
operation?🔹	`string`	Operation is the type of operation which lead to this ManagedFieldsEntry being created. *Optional*
time?🔹	`date`	Time is timestamp of when these fields were set. *Optional*

struct ObjectMeta 🔹

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Name	Type	Description
annotations?🔹	`Map<string, string>`	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. *Optional*
clusterName?🔹	`string`	The name of the cluster which the object belongs to. *Optional*
creationTimestamp?🔹	`date`	CreationTimestamp is a timestamp representing the server time when this object was created. *Optional*
deletionGracePeriodSeconds?🔹	`number`	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. *Optional*
deletionTimestamp?🔹	`date`	DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. *Optional*
finalizers?🔹	`Array`	Must be empty before the object is deleted from the registry. *Optional*
generateName?🔹	`string`	GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. *Optional*
generation?🔹	`number`	A sequence number representing a specific generation of the desired state. *Optional*
initializers?🔹	`Initializers`	An initializer is a controller which enforces some system invariant at object creation time. *Optional*
labels?🔹	`Map<string, string>`	Map of string keys and values that can be used to organize and categorize (scope and select) objects. *Optional*
managedFields?🔹	`Array<ManagedFieldsEntry>`	ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. *Optional*
name?🔹	`string`	Name must be unique within a namespace. *Optional*
namespace?🔹	`string`	Namespace defines the space within each name must be unique. *Optional*
ownerReferences?🔹	`Array<OwnerReference>`	List of objects depended by this object. *Optional*
resourceVersion?🔹	`string`	An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. *Optional*
selfLink?🔹	`string`	SelfLink is a URL representing this object. *Optional*
uid?🔹	`string`	UID is the unique in time and space value for this object. *Optional*

struct OwnerReference 🔹

OwnerReference contains enough information to let you identify an owning object.

An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Name	Type	Description
apiVersion🔹	`string`	API version of the referent.
kind🔹	`string`	Kind of the referent.
name🔹	`string`	Name of the referent.
uid🔹	`string`	UID of the referent.
blockOwnerDeletion?🔹	`boolean`	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. *Default*: false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller?🔹	`boolean`	If true, this reference points to the managing controller. *Optional*

struct StatusCause 🔹

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Name	Type	Description
field?🔹	`string`	The field of the resource that has caused this error, as named by its JSON serialization. *Optional*
message?🔹	`string`	A human-readable description of the cause of the error. *Optional*
reason?🔹	`string`	A machine-readable description of the cause of the error. *Optional*

struct StatusDetails 🔹

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response.

The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Name	Type	Description
causes?🔹	`Array<StatusCause>`	The Causes array includes more details associated with the StatusReason failure. *Optional*
group?🔹	`string`	The group attribute of the resource associated with the status StatusReason. *Optional*
kind?🔹	`string`	The kind attribute of the resource associated with the status StatusReason. *Optional*
name?🔹	`string`	The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). *Optional*
retryAfterSeconds?🔹	`number`	If specified, the time in seconds before the operation should be retried. *Optional*
uid?🔹	`string`	UID of the resource. *Optional*

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API.md

API.md

API Reference

class AWSLoadBalancerControllerObject 🔹

Initializer

Properties

Methods

static manifest(props?)🔹

class IntOrString 🔹

Methods

static fromNumber(value)🔹

static fromString(value)🔹

struct AWSLoadBalancerControllerProps 🔹

struct HttpIngressPath 🔹

struct HttpIngressRuleValue 🔹

struct IngressBackend 🔹

struct IngressRule 🔹

struct IngressSpec 🔹

struct IngressTls 🔹

struct Initializer 🔹

struct Initializers 🔹

struct KubeStatusProps 🔹

struct ListMeta 🔹

struct ManagedFieldsEntry 🔹

struct ObjectMeta 🔹

struct OwnerReference 🔹

struct StatusCause 🔹

struct StatusDetails 🔹

Files

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

class AWSLoadBalancerControllerObject 🔹

Initializer

Properties

Methods

static manifest(props?)🔹

class IntOrString 🔹

Methods

static fromNumber(value)🔹

static fromString(value)🔹

struct AWSLoadBalancerControllerProps 🔹

struct HttpIngressPath 🔹

struct HttpIngressRuleValue 🔹

struct IngressBackend 🔹

struct IngressRule 🔹

struct IngressSpec 🔹

struct IngressTls 🔹

struct Initializer 🔹

struct Initializers 🔹

struct KubeStatusProps 🔹

struct ListMeta 🔹

struct ManagedFieldsEntry 🔹

struct ObjectMeta 🔹

struct OwnerReference 🔹

struct StatusCause 🔹

struct StatusDetails 🔹