CfnConfigurationProps¶
-
class
aws_cdk.aws_msk.
CfnConfigurationProps
(*, name, server_properties, description=None, kafka_versions_list=None)¶ Bases:
object
Properties for defining a
CfnConfiguration
.- Parameters
name (
str
) – The name of the configuration. Configuration names are strings that match the regex “^[0-9A-Za-z][0-9A-Za-z-]{0,}$”.server_properties (
str
) – Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the CLI, the contents of server.properties can be in plaintext.description (
Optional
[str
]) – The description of the configuration.kafka_versions_list (
Optional
[Sequence
[str
]]) – A list of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this list.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_msk as msk cfn_configuration_props = msk.CfnConfigurationProps( name="name", server_properties="serverProperties", # the properties below are optional description="description", kafka_versions_list=["kafkaVersionsList"] )
Attributes
-
description
¶ The description of the configuration.
-
kafka_versions_list
¶ A list of the versions of Apache Kafka with which you can use this MSK configuration.
You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this list.
- Link
- Return type
Optional
[List
[str
]]
-
name
¶ The name of the configuration.
Configuration names are strings that match the regex “^[0-9A-Za-z][0-9A-Za-z-]{0,}$”.
-
server_properties
¶ Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the CLI, the contents of server.properties can be in plaintext.