Package software.amazon.awscdk.services.msk

Class CfnConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.msk.CfnConfiguration
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:45.622Z") @Stability(Stable) public class CfnConfiguration extends CfnResource implements IInspectable, IConfigurationRef
Creates a new MSK configuration.

To see an example of how to use this operation, first save the following text to a file and name the file config-file.txt .

auto.create.topics.enable = true zookeeper.connection.timeout.ms = 1000 log.roll.ms = 604800000

Now run the following Python 3.6 script in the folder where you saved config-file.txt . This script uses the properties specified in config-file.txt to create a configuration named SalesClusterConfiguration . This configuration can work with Apache Kafka versions 1.1.1 and 2.1.0. 

 import boto3 client = boto3.client('kafka') config_file = open('config-file.txt', 'r') server_properties = config_file.read() response = client.create_configuration( Name='SalesClusterConfiguration', Description='The configuration to use on all sales clusters.', KafkaVersions=['1.1.1', '2.1.0'], ServerProperties=server_properties
 ) print(response)

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.msk.*;
 CfnConfiguration cfnConfiguration = CfnConfiguration.Builder.create(this, "MyCfnConfiguration")
         .name("name")
         .serverProperties("serverProperties")
         // the properties below are optional
         .description("description")
         .kafkaVersionsList(List.of("kafkaVersionsList"))
         .latestRevision(LatestRevisionProperty.builder()
                 .creationTime("creationTime")
                 .description("description")
                 .revision(123)
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConfiguration

      protected CfnConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConfiguration

      protected CfnConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConfiguration

      @Stability(Stable) public CfnConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the configuration.

    • getAttrLatestRevisionCreationTime

      @Stability(Stable) @NotNull public String getAttrLatestRevisionCreationTime()
      The time when the configuration revision was created.

    • getAttrLatestRevisionDescription

      @Stability(Stable) @NotNull public String getAttrLatestRevisionDescription()
      The description of the configuration revision.

    • getAttrLatestRevisionRevision

      @Stability(Stable) @NotNull public Number getAttrLatestRevisionRevision()
      The revision number.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConfigurationRef

      @Stability(Stable) @NotNull public ConfigurationReference getConfigurationRef()
      A reference to a Configuration resource.
      Specified by:
      getConfigurationRef in interface IConfigurationRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the configuration.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the configuration.

    • getServerProperties

      @Stability(Stable) @NotNull public String getServerProperties()
      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.

    • setServerProperties

      @Stability(Stable) public void setServerProperties(@NotNull String value)
      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.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the configuration.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the configuration.

    • getKafkaVersionsList

      @Stability(Stable) @Nullable public List<String> getKafkaVersionsList()
      The versions of Apache Kafka with which you can use this MSK configuration.

    • setKafkaVersionsList

      @Stability(Stable) public void setKafkaVersionsList(@Nullable List<String> value)
      The versions of Apache Kafka with which you can use this MSK configuration.

    • getLatestRevision

      @Stability(Stable) @Nullable public Object getLatestRevision()
      Latest revision of the MSK configuration.

      Returns union: either IResolvable or CfnConfiguration.LatestRevisionProperty

    • setLatestRevision

      @Stability(Stable) public void setLatestRevision(@Nullable IResolvable value)
      Latest revision of the MSK configuration.

    • setLatestRevision

      @Stability(Stable) public void setLatestRevision(@Nullable CfnConfiguration.LatestRevisionProperty value)
      Latest revision of the MSK configuration.