Package software.amazon.awscdk.services.msk

Interface CfnConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:16.570Z")
@Stability(Stable)
public interface CfnConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConfiguration.

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.*;
 CfnConfigurationProps cfnConfigurationProps = CfnConfigurationProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigurationProps.Builder	A builder for CfnConfigurationProps
static final class	CfnConfigurationProps.Jsii$Proxy	An implementation for CfnConfigurationProps

Method Summary

Modifier and Type	Method	Description
static CfnConfigurationProps.Builder	builder()
default String	getDescription()	The description of the configuration.
default List<String>	getKafkaVersionsList()	The versions of Apache Kafka with which you can use this MSK configuration.
default Object	getLatestRevision()	Latest revision of the MSK configuration.
String	getName()	The name of the configuration.
String	getServerProperties()	Contents of the server.properties file.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the configuration.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-name

getServerProperties

@Stability(Stable)
@NotNull
String getServerProperties()

Contents of the server.properties file. When using this property, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the AWS CLI , the contents of server.properties can be in plaintext.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-serverproperties

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-description

getKafkaVersionsList

@Stability(Stable)
@Nullable
default List<String> getKafkaVersionsList()

The versions of Apache Kafka with which you can use this MSK configuration.

When you update the KafkaVersionsList property, AWS 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-kafkaversionslist

getLatestRevision

@Stability(Stable)
@Nullable
default Object getLatestRevision()

Latest revision of the MSK configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-latestrevision

builder

@Stability(Stable)
static CfnConfigurationProps.Builder builder()

Returns:

a CfnConfigurationProps.Builder of CfnConfigurationProps