API.md

cdk8s-various

Holds many useful fully typed cdk8s objects..

Available objects:

1. SecurityGroupPolicy
2. Untyped ConfigMap

API Reference

Constructs

KongTcpIngress

Initializers

import { KongTcpIngress } from 'cdk8s-various'

new KongTcpIngress(scope: Construct, name: string, opts: KongTcpOptions)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
opts	KongTcpOptions	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

opts^Required

• Type: KongTcpOptions

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { KongTcpIngress } from 'cdk8s-various'

KongTcpIngress.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

SecurityGroupPolicy

Initializers

import { SecurityGroupPolicy } from 'cdk8s-various'

new SecurityGroupPolicy(scope: Construct, name: string, opts: SecurityGroupPolicyOptions)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
opts	SecurityGroupPolicyOptions	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

opts^Required

• Type: SecurityGroupPolicyOptions

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { SecurityGroupPolicy } from 'cdk8s-various'

SecurityGroupPolicy.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

UntypedConfigMap

Initializers

import { UntypedConfigMap } from 'cdk8s-various'

new UntypedConfigMap(scope: Construct, name: string, opts: UntypedConfigMapOptions)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
opts	UntypedConfigMapOptions	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

opts^Required

• Type: UntypedConfigMapOptions

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { UntypedConfigMap } from 'cdk8s-various'

UntypedConfigMap.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

Structs

KongTcpBackend

Initializer

import { KongTcpBackend } from 'cdk8s-various'

const kongTcpBackend: KongTcpBackend = { ... }

Properties

Name	Type	Description
serviceName	string	No description.
servicePort	number	No description.

---

serviceName^Required

public readonly serviceName: string;

• Type: string

---

servicePort^Required

public readonly servicePort: number;

• Type: number

---

KongTcpOptions

Initializer

import { KongTcpOptions } from 'cdk8s-various'

const kongTcpOptions: KongTcpOptions = { ... }

Properties

Name	Type	Description
annotations	{[ key: string ]: string}	No description.
rules	KongTcpRule[]	No description.

---

annotations^Optional

public readonly annotations: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

rules^Optional

public readonly rules: KongTcpRule[];

• Type: KongTcpRule[]

---

KongTcpRule

Initializer

import { KongTcpRule } from 'cdk8s-various'

const kongTcpRule: KongTcpRule = { ... }

Properties

Name	Type	Description
backend	KongTcpBackend	No description.
port	number	No description.

---

backend^Required

public readonly backend: KongTcpBackend;

• Type: KongTcpBackend

---

port^Required

public readonly port: number;

• Type: number

---

SecurityGroupPolicyOptions

Initializer

import { SecurityGroupPolicyOptions } from 'cdk8s-various'

const securityGroupPolicyOptions: SecurityGroupPolicyOptions = { ... }

Properties

Name	Type	Description
securityGroupIds	string[]	No description.
selector	{[ key: string ]: string}	No description.

---

securityGroupIds^Optional

public readonly securityGroupIds: string[];

• Type: string[]

---

selector^Optional

public readonly selector: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

UntypedConfigMapOptions

Initializer

import { UntypedConfigMapOptions } from 'cdk8s-various'

const untypedConfigMapOptions: UntypedConfigMapOptions = { ... }

Properties

Name	Type	Description
data	string	No description.
metadata	cdk8s.ApiObjectMetadata	No description.

---

data^Required

public readonly data: string;

• Type: string

---

metadata^Required

public readonly metadata: ApiObjectMetadata;

• Type: cdk8s.ApiObjectMetadata

---