---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_msk_cluster{% #aws_msk_cluster %}

## `account_id`{% #account_id %}

**Type**: `STRING`

## `active_operation_arn`{% #active_operation_arn %}

**Type**: `STRING`**Provider name**: `ActiveOperationArn`**Description**: The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.

## `cluster_arn`{% #cluster_arn %}

**Type**: `STRING`**Provider name**: `ClusterArn`**Description**: The Amazon Resource Name (ARN) that uniquely identifies the cluster.

## `cluster_name`{% #cluster_name %}

**Type**: `STRING`**Provider name**: `ClusterName`**Description**: The name of the cluster.

## `cluster_type`{% #cluster_type %}

**Type**: `STRING`**Provider name**: `ClusterType`**Description**: Cluster Type.

## `creation_time`{% #creation_time %}

**Type**: `TIMESTAMP`**Provider name**: `CreationTime`**Description**: The time when the cluster was created.

## `current_version`{% #current_version %}

**Type**: `STRING`**Provider name**: `CurrentVersion`**Description**: The current version of the MSK cluster.

## `provisioned`{% #provisioned %}

**Type**: `STRUCT`**Provider name**: `Provisioned`**Description**: Information about the provisioned cluster.

- `broker_node_group_info`**Type**: `STRUCT`**Provider name**: `BrokerNodeGroupInfo`**Description**: Information about the brokers.
  - `broker_az_distribution`**Type**: `STRING`**Provider name**: `BrokerAZDistribution`**Description**: The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
  - `client_subnets`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ClientSubnets`**Description**: The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.
  - `connectivity_info`**Type**: `STRUCT`**Provider name**: `ConnectivityInfo`**Description**: Information about the broker access configuration.
    - `public_access`**Type**: `STRUCT`**Provider name**: `PublicAccess`**Description**: Public access control for brokers.
      - `type`**Type**: `STRING`**Provider name**: `Type`**Description**: The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    - `vpc_connectivity`**Type**: `STRUCT`**Provider name**: `VpcConnectivity`**Description**: VPC connectivity access control for brokers.
      - `client_authentication`**Type**: `STRUCT`**Provider name**: `ClientAuthentication`**Description**: Includes all client authentication information for VPC connectivity.
        - `sasl`**Type**: `STRUCT`**Provider name**: `Sasl`**Description**: SASL authentication type details for VPC connectivity.
          - `iam`**Type**: `STRUCT`**Provider name**: `Iam`**Description**: Details for SASL/IAM client authentication for VPC connectivity.
            - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: SASL/IAM authentication is on or off for VPC connectivity.
          - `scram`**Type**: `STRUCT`**Provider name**: `Scram`**Description**: Details for SASL/SCRAM client authentication for VPC connectivity.
            - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: SASL/SCRAM authentication is on or off for VPC connectivity.
        - `tls`**Type**: `STRUCT`**Provider name**: `Tls`**Description**: TLS authentication type details for VPC connectivity.
          - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: TLS authentication is on or off for VPC connectivity.
  - `instance_type`**Type**: `STRING`**Provider name**: `InstanceType`**Description**: The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
  - `security_groups`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `SecurityGroups`**Description**: The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
  - `storage_info`**Type**: `STRUCT`**Provider name**: `StorageInfo`**Description**: Contains information about storage volumes attached to MSK broker nodes.
    - `ebs_storage_info`**Type**: `STRUCT`**Provider name**: `EbsStorageInfo`**Description**: EBS volume information.
      - `provisioned_throughput`**Type**: `STRUCT`**Provider name**: `ProvisionedThroughput`**Description**: EBS volume provisioned throughput information.
        - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: Provisioned throughput is enabled or not.
        - `volume_throughput`**Type**: `INT32`**Provider name**: `VolumeThroughput`**Description**: Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
      - `volume_size`**Type**: `INT32`**Provider name**: `VolumeSize`**Description**: The size in GiB of the EBS volume for the data drive on each broker node.
  - `zone_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ZoneIds`**Description**: The list of zoneIds for the cluster in the virtual private cloud (VPC).
- `client_authentication`**Type**: `STRUCT`**Provider name**: `ClientAuthentication`**Description**: Includes all client authentication information.
  - `sasl`**Type**: `STRUCT`**Provider name**: `Sasl`**Description**: Details for ClientAuthentication using SASL.
    - `iam`**Type**: `STRUCT`**Provider name**: `Iam`**Description**: Indicates whether IAM access control is enabled.
      - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: Indicates whether IAM access control is enabled.
    - `scram`**Type**: `STRUCT`**Provider name**: `Scram`**Description**: Details for SASL/SCRAM client authentication.
      - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: SASL/SCRAM authentication is enabled or not.
  - `tls`**Type**: `STRUCT`**Provider name**: `Tls`**Description**: Details for ClientAuthentication using TLS.
    - `certificate_authority_arn_list`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `CertificateAuthorityArnList`**Description**: List of ACM Certificate Authority ARNs.
    - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: Specifies whether you want to turn on or turn off TLS authentication.
  - `unauthenticated`**Type**: `STRUCT`**Provider name**: `Unauthenticated`**Description**: Contains information about unauthenticated traffic to the cluster.
    - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
- `current_broker_software_info`**Type**: `STRUCT`**Provider name**: `CurrentBrokerSoftwareInfo`**Description**: Information about the Apache Kafka version deployed on the brokers.
  - `configuration_arn`**Type**: `STRING`**Provider name**: `ConfigurationArn`**Description**: The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
  - `configuration_revision`**Type**: `INT64`**Provider name**: `ConfigurationRevision`**Description**: The revision of the configuration to use. This field isn't visible in this preview release.
  - `kafka_version`**Type**: `STRING`**Provider name**: `KafkaVersion`**Description**: The version of Apache Kafka.
- `customer_action_status`**Type**: `STRING`**Provider name**: `CustomerActionStatus`**Description**: Determines if there is an action required from the customer.
- `encryption_info`**Type**: `STRUCT`**Provider name**: `EncryptionInfo`**Description**: Includes all encryption-related information.
  - `encryption_at_rest`**Type**: `STRUCT`**Provider name**: `EncryptionAtRest`**Description**: The data-volume encryption details.
    - `data_volume_kms_key_id`**Type**: `STRING`**Provider name**: `DataVolumeKMSKeyId`**Description**: The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
  - `encryption_in_transit`**Type**: `STRUCT`**Provider name**: `EncryptionInTransit`**Description**: The details for encryption in transit.
    - `client_broker`**Type**: `STRING`**Provider name**: `ClientBroker`**Description**: Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT.
    - `in_cluster`**Type**: `BOOLEAN`**Provider name**: `InCluster`**Description**: When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true.
- `enhanced_monitoring`**Type**: `STRING`**Provider name**: `EnhancedMonitoring`**Description**: Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
- `logging_info`**Type**: `STRUCT`**Provider name**: `LoggingInfo`**Description**: Log delivery information for the cluster.
  - `broker_logs`**Type**: `STRUCT`**Provider name**: `BrokerLogs`
    - `cloud_watch_logs`**Type**: `STRUCT`**Provider name**: `CloudWatchLogs`
      - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`
      - `log_group`**Type**: `STRING`**Provider name**: `LogGroup`
    - `firehose`**Type**: `STRUCT`**Provider name**: `Firehose`
      - `delivery_stream`**Type**: `STRING`**Provider name**: `DeliveryStream`
      - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`
    - `s3`**Type**: `STRUCT`**Provider name**: `S3`
      - `bucket`**Type**: `STRING`**Provider name**: `Bucket`
      - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`
      - `prefix`**Type**: `STRING`**Provider name**: `Prefix`
- `number_of_broker_nodes`**Type**: `INT32`**Provider name**: `NumberOfBrokerNodes`**Description**: The number of broker nodes in the cluster.
- `open_monitoring`**Type**: `STRUCT`**Provider name**: `OpenMonitoring`**Description**: The settings for open monitoring.
  - `prometheus`**Type**: `STRUCT`**Provider name**: `Prometheus`**Description**: Prometheus settings.
    - `jmx_exporter`**Type**: `STRUCT`**Provider name**: `JmxExporter`**Description**: Indicates whether you want to turn on or turn off the JMX Exporter.
      - `enabled_in_broker`**Type**: `BOOLEAN`**Provider name**: `EnabledInBroker`**Description**: Indicates whether you want to turn on or turn off the JMX Exporter.
    - `node_exporter`**Type**: `STRUCT`**Provider name**: `NodeExporter`**Description**: Indicates whether you want to turn on or turn off the Node Exporter.
      - `enabled_in_broker`**Type**: `BOOLEAN`**Provider name**: `EnabledInBroker`**Description**: Indicates whether you want to turn on or turn off the Node Exporter.
- `storage_mode`**Type**: `STRING`**Provider name**: `StorageMode`**Description**: This controls storage mode for supported storage tiers.
- `zookeeper_connect_string`**Type**: `STRING`**Provider name**: `ZookeeperConnectString`**Description**: The connection string to use to connect to the Apache ZooKeeper cluster.
- `zookeeper_connect_string_tls`**Type**: `STRING`**Provider name**: `ZookeeperConnectStringTls`**Description**: The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.

## `serverless`{% #serverless %}

**Type**: `STRUCT`**Provider name**: `Serverless`**Description**: Information about the serverless cluster.

- `client_authentication`**Type**: `STRUCT`**Provider name**: `ClientAuthentication`**Description**: Includes all client authentication information.
  - `sasl`**Type**: `STRUCT`**Provider name**: `Sasl`**Description**: Details for ClientAuthentication using SASL.
    - `iam`**Type**: `STRUCT`**Provider name**: `Iam`**Description**: Indicates whether IAM access control is enabled.
      - `enabled`**Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: Indicates whether IAM access control is enabled.
- `vpc_configs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `VpcConfigs`**Description**: The configuration of the Amazon VPCs for the cluster.
  - `security_group_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `SecurityGroupIds`**Description**: The IDs of the security groups associated with the cluster.
  - `subnet_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `SubnetIds`**Description**: The IDs of the subnets associated with the cluster.

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `State`**Description**: The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

## `state_info`{% #state_info %}

**Type**: `STRUCT`**Provider name**: `StateInfo`**Description**: State Info for the Amazon MSK cluster.

- `code`**Type**: `STRING`**Provider name**: `Code`
- `message`**Type**: `STRING`**Provider name**: `Message`

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`