2.233.0

class CfnClusterLogsMixin

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.EKS.Mixins.CfnClusterLogsMixin
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awseks/mixins#CfnClusterLogsMixin
Javasoftware.amazon.awscdk.mixins.preview.services.eks.mixins.CfnClusterLogsMixin
Pythonaws_cdk.mixins_preview.aws_eks.mixins.CfnClusterLogsMixin
TypeScript @aws-cdk/mixins-preview » aws_eks » mixins » CfnClusterLogsMixin

Implements IMixin

Extends Mixin

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS , and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an ELB Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support kubectl exec , logs , and proxy data flows).

Amazon EKS nodes run in your AWS account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.

You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. The endpoint domain name and IP address family depends on the value of the ipFamily for the cluster. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing .

In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Allowing users to access your cluster and Launching Amazon EKS nodes in the Amazon EKS User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from '@aws-cdk/mixins-preview';
import { mixins as eks_mixins } from '@aws-cdk/mixins-preview/aws-eks';

declare const logsDelivery: logs.ILogsDelivery;
const cfnClusterLogsMixin = new eks_mixins.CfnClusterLogsMixin('logType', logsDelivery);

Initializer

new CfnClusterLogsMixin(logType: string, logDelivery: ILogsDelivery)

Parameters

  • logType string — Type of logs that are getting vended.
  • logDelivery ILogsDelivery — Object in charge of setting up the delivery source, delivery destination, and delivery connection.

Create a mixin to enable vended logs for AWS::EKS::Cluster.

Properties

NameTypeDescription
logDeliveryILogsDelivery
logTypestring
static AUTO_MODE_BLOCK_STORAGE_LOGSCfnClusterAutoModeBlockStorageLogs
static AUTO_MODE_COMPUTE_LOGSCfnClusterAutoModeComputeLogs
static AUTO_MODE_IPAM_LOGSCfnClusterAutoModeIpamLogs
static AUTO_MODE_LOAD_BALANCING_LOGSCfnClusterAutoModeLoadBalancingLogs

logDelivery

Type: ILogsDelivery

logType

Type: string

static AUTO_MODE_BLOCK_STORAGE_LOGS

Type: CfnClusterAutoModeBlockStorageLogs

static AUTO_MODE_COMPUTE_LOGS

Type: CfnClusterAutoModeComputeLogs

static AUTO_MODE_IPAM_LOGS

Type: CfnClusterAutoModeIpamLogs

static AUTO_MODE_LOAD_BALANCING_LOGS

Type: CfnClusterAutoModeLoadBalancingLogs

Methods

NameDescription
applyTo(resource)Apply vended logs configuration to the construct.
supports(construct)Check if this mixin supports the given construct (has vendedLogs property).

applyTo(resource)

public applyTo(resource: IConstruct): IConstruct

Parameters

Returns

Apply vended logs configuration to the construct.

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

Returns

  • boolean

Check if this mixin supports the given construct (has vendedLogs property).

← PreviousNext →