Skip to content

API.md

Latest commit

 

History

History
282 lines (168 loc) · 9.23 KB

API.md

File metadata and controls

282 lines (168 loc) · 9.23 KB

API Reference

Constructs

ContainerInsight

Initializers 

import { ContainerInsight } from 'cdk-eks-container-insight'

new ContainerInsight(scope: Construct, id: string, props: ContainerInsightProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props ContainerInsightProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

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 { ContainerInsight } from 'cdk-eks-container-insight'

ContainerInsight.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
cluster aws-cdk-lib.aws_eks.Cluster No description.
adotNamespace string No description.
cloudwatchNamespace string No description.
fargateNamespace string No description.
fargateSupportMode string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

clusterRequired 
public readonly cluster: Cluster;
  • Type: aws-cdk-lib.aws_eks.Cluster
adotNamespaceOptional 
public readonly adotNamespace: string;
  • Type: string
cloudwatchNamespaceOptional 
public readonly cloudwatchNamespace: string;
  • Type: string
fargateNamespaceOptional 
public readonly fargateNamespace: string;
  • Type: string
fargateSupportModeOptional 
public readonly fargateSupportMode: string;
  • Type: string

Structs

ContainerInsightProps

Initializer 

import { ContainerInsightProps } from 'cdk-eks-container-insight'

const containerInsightProps: ContainerInsightProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.Cluster The EKS Cluster to attach to.
adotNamespace string The Kubernetes namespace to install ADOT to.
cloudwatchNamespace string The Kubernetes namespace to install CloudWatch agent to.
fargateNamespace string Fargate container insight namepsace.
fargateSupportMode FargateSupportMode Fargate support mode for NO/ONLY/BOTH.
clusterRequired 
public readonly cluster: Cluster;
  • Type: aws-cdk-lib.aws_eks.Cluster

The EKS Cluster to attach to.

adotNamespaceOptional 
public readonly adotNamespace: string;
  • Type: string
  • Default: amazon-metrics

The Kubernetes namespace to install ADOT to.

cloudwatchNamespaceOptional 
public readonly cloudwatchNamespace: string;
  • Type: string
  • Default: amazon-cloudwatch

The Kubernetes namespace to install CloudWatch agent to.

fargateNamespaceOptional 
public readonly fargateNamespace: string;
  • Type: string
  • Default: fargate-container-insights

Fargate container insight namepsace.

fargateSupportModeOptional 
public readonly fargateSupportMode: FargateSupportMode;

Fargate support mode for NO/ONLY/BOTH.

Enums

FargateSupportMode

Members

Name Description
NO No support for Fargate profile only support EC2.
ONLY Only support for Fargate profile no EC2.
BOTH Both support Fargate profile and EC2.
NO

No support for Fargate profile only support EC2.

ONLY

Only support for Fargate profile no EC2.

BOTH

Both support Fargate profile and EC2.