aws-cdk-lib.aws_msk.CfnConfigurationProps

CfnConfigurationProps Struct

Properties for defining a CfnConfiguration.

Source

Generated code

Type last changed

v2.98.0 · 26 Sep 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_msk as msk } from 'aws-cdk-lib';
const cfnConfigurationProps: msk.CfnConfigurationProps = {
  name: 'name',
  serverProperties: 'serverProperties',

  // the properties below are optional
  description: 'description',
  kafkaVersionsList: ['kafkaVersionsList'],
  latestRevision: {
    creationTime: 'creationTime',
    description: 'description',
    revision: 123,
  },
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The description of the configuration.

kafkaVersionsListstring[]kafka_versions_listtyping.List[str]kafkaVersionsListList<String>KafkaVersionsListstring[]KafkaVersionsList*[]*string#

The [versions of Apache Kafka](https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html) with which you can use this MSK configuration.

notes

When you update the KafkaVersionsList property, CloudFormation recreates a new configuration with the updated property before deleting the old configuration. Such an update requires a resource replacement . To successfully update KafkaVersionsList , you must also update the Name property in the same operation.

If your configuration is attached with any clusters created using the AWS Management Console or AWS CLI , you'll need to manually delete the old configuration from the console after the update completes.

For more information, see Can’t update KafkaVersionsList in MSK configuration in the Amazon MSK Developer Guide .

latestRevisionIResolvable | CfnConfiguration.LatestRevisionPropertylatest_revisiontyping.Union[IResolvable, LatestRevisionProperty]latestRevisionIResolvableLatestRevisionIResolvableLatestRevisioninterface{}#

Latest revision of the MSK configuration.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the configuration.

Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".

serverPropertiesstringserver_propertiesstrserverPropertiesStringServerPropertiesstringServerProperties*stringrequired#

Contents of the `server.properties` file. When using the console, the SDK, or the AWS CLI , the contents of `server.properties` can be in plaintext.

Used as props by

• CfnConfiguration