ClusterInfo

import type { ClusterInfo } from "https://aws-api.deno.dev/v0.4/services/kafka.ts?docs=full";

Returns information about a cluster.

interface ClusterInfo {

ActiveOperationArn?: string | null;

BrokerNodeGroupInfo?: BrokerNodeGroupInfo | null;

ClientAuthentication?: ClientAuthentication | null;

ClusterArn?: string | null;

ClusterName?: string | null;

CreationTime?: Date | number | null;

CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo | null;

CurrentVersion?: string | null;

EncryptionInfo?: EncryptionInfo | null;

EnhancedMonitoring?: EnhancedMonitoring | null;

LoggingInfo?: LoggingInfo | null;

NumberOfBrokerNodes?: number | null;

OpenMonitoring?: OpenMonitoring | null;

State?: ClusterState | null;

StateInfo?: StateInfo | null;

StorageMode?: StorageMode | null;

Tags?: {

[key: string]: string | null | undefined;

} | null;

ZookeeperConnectString?: string | null;

ZookeeperConnectStringTls?: string | null;

}

§Properties

ActiveOperationArn?: string | null

[src]

Arn of active cluster operation.

BrokerNodeGroupInfo?: BrokerNodeGroupInfo | null

[src]

Information about the broker nodes.

ClientAuthentication?: ClientAuthentication | null

[src]

Includes all client authentication information.

ClusterArn?: string | null

[src]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

ClusterName?: string | null

[src]

The name of the cluster.

CreationTime?: Date | number | null

[src]

The time when the cluster was created.

CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo | null

[src]

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

CurrentVersion?: string | null

[src]

The current version of the MSK cluster.

EncryptionInfo?: EncryptionInfo | null

[src]

Includes all encryption-related information.

EnhancedMonitoring?: EnhancedMonitoring | null

[src]

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

LoggingInfo?: LoggingInfo | null

[src]

NumberOfBrokerNodes?: number | null

[src]

The number of broker nodes in the cluster.

OpenMonitoring?: OpenMonitoring | null

[src]

Settings for open monitoring using Prometheus.

State?: ClusterState | null

[src]

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

StateInfo?: StateInfo | null