interface CfnClusterMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.MSK.Mixins.CfnClusterMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsmsk/mixins#CfnClusterMixinProps
Java	software.amazon.awscdk.mixins.preview.services.msk.mixins.CfnClusterMixinProps
Python	aws_cdk.mixins_preview.aws_msk.mixins.CfnClusterMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_msk » mixins » CfnClusterMixinProps

Properties for CfnClusterPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as msk_mixins } from '@aws-cdk/mixins-preview/aws-msk';
const cfnClusterMixinProps: msk_mixins.CfnClusterMixinProps = {
  brokerNodeGroupInfo: {
    brokerAzDistribution: 'brokerAzDistribution',
    clientSubnets: ['clientSubnets'],
    connectivityInfo: {
      networkType: 'networkType',
      publicAccess: {
        type: 'type',
      },
      vpcConnectivity: {
        clientAuthentication: {
          sasl: {
            iam: {
              enabled: false,
            },
            scram: {
              enabled: false,
            },
          },
          tls: {
            enabled: false,
          },
        },
      },
    },
    instanceType: 'instanceType',
    securityGroups: ['securityGroups'],
    storageInfo: {
      ebsStorageInfo: {
        provisionedThroughput: {
          enabled: false,
          volumeThroughput: 123,
        },
        volumeSize: 123,
      },
    },
  },
  clientAuthentication: {
    sasl: {
      iam: {
        enabled: false,
      },
      scram: {
        enabled: false,
      },
    },
    tls: {
      certificateAuthorityArnList: ['certificateAuthorityArnList'],
      enabled: false,
    },
    unauthenticated: {
      enabled: false,
    },
  },
  clusterName: 'clusterName',
  configurationInfo: {
    arn: 'arn',
    revision: 123,
  },
  currentVersion: 'currentVersion',
  encryptionInfo: {
    encryptionAtRest: {
      dataVolumeKmsKeyId: 'dataVolumeKmsKeyId',
    },
    encryptionInTransit: {
      clientBroker: 'clientBroker',
      inCluster: false,
    },
  },
  enhancedMonitoring: 'enhancedMonitoring',
  kafkaVersion: 'kafkaVersion',
  loggingInfo: {
    brokerLogs: {
      cloudWatchLogs: {
        enabled: false,
        logGroup: 'logGroup',
      },
      firehose: {
        deliveryStream: 'deliveryStream',
        enabled: false,
      },
      s3: {
        bucket: 'bucket',
        enabled: false,
        prefix: 'prefix',
      },
    },
  },
  numberOfBrokerNodes: 123,
  openMonitoring: {
    prometheus: {
      jmxExporter: {
        enabledInBroker: false,
      },
      nodeExporter: {
        enabledInBroker: false,
      },
    },
  },
  rebalancing: {
    status: 'status',
  },
  storageMode: 'storageMode',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
brokerNodeGroupInfo?	IResolvable | BrokerNodeGroupInfoProperty	Information about the broker nodes in the cluster.
clientAuthentication?	IResolvable | ClientAuthenticationProperty	Includes all client authentication related information.
clusterName?	string	The name of the cluster.
configurationInfo?	IResolvable | ConfigurationInfoProperty	Represents the configuration that you want MSK to use for the cluster.
currentVersion?	string
encryptionInfo?	IResolvable | EncryptionInfoProperty	Includes all encryption-related information.
enhancedMonitoring?	string	Specifies the level of monitoring for the MSK cluster.
kafkaVersion?	string	The version of Apache Kafka.
loggingInfo?	IResolvable | LoggingInfoProperty	Logging info details for the cluster.
numberOfBrokerNodes?	number	The number of broker nodes in the cluster.
openMonitoring?	IResolvable | OpenMonitoringProperty	The settings for open monitoring.
rebalancing?	IResolvable | RebalancingProperty
storageMode?	string	This controls storage mode for supported storage tiers.
tags?	{ [string]: string }	An arbitrary set of tags (key-value pairs) for the cluster.

---

brokerNodeGroupInfo?

Type: IResolvable | BrokerNodeGroupInfoProperty (optional)

Information about the broker nodes in the cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-brokernodegroupinfo

---

clientAuthentication?

Type: IResolvable | ClientAuthenticationProperty (optional)

Includes all client authentication related information.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clientauthentication

---

clusterName?

Type: string (optional)

The name of the cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clustername

---

configurationInfo?

Type: IResolvable | ConfigurationInfoProperty (optional)

Represents the configuration that you want MSK to use for the cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-configurationinfo

---

currentVersion?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-currentversion

---

encryptionInfo?

Type: IResolvable | EncryptionInfoProperty (optional)

Includes all encryption-related information.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-encryptioninfo

---

enhancedMonitoring?

Type: string (optional)

Specifies the level of monitoring for the MSK cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-enhancedmonitoring

---

kafkaVersion?

Type: string (optional)

The version of Apache Kafka.

You can use Amazon MSK to create clusters that use supported Apache Kafka versions .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-kafkaversion

---

loggingInfo?

Type: IResolvable | LoggingInfoProperty (optional)

Logging info details for the cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-logginginfo

---

numberOfBrokerNodes?

Type: number (optional)

The number of broker nodes in the cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-numberofbrokernodes

---

openMonitoring?

Type: IResolvable | OpenMonitoringProperty (optional)

The settings for open monitoring.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-openmonitoring

---

rebalancing?

Type: IResolvable | RebalancingProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-rebalancing

---

storageMode?

Type: string (optional)

This controls storage mode for supported storage tiers.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-storagemode

---

tags?

Type: { [string]: string } (optional)

An arbitrary set of tags (key-value pairs) for the cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-tags