AWS AWSCloudFormation documentation change
Summary
Added detailed documentation for creating an MSK configuration, including a Python example, property descriptions, and return value details
Security assessment
The changes provide general documentation improvements and examples but do not specifically address security vulnerabilities or introduce new security features. The server properties configuration is part of standard cluster setup.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.md index 46d6cff41..64c0f7510 100644 --- a/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.md +++ b/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.md @@ -7 +7,28 @@ SyntaxPropertiesReturn values -The `AWS::MSK::Configuration` resource Property description not available. for MSK. +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) @@ -47 +74 @@ To declare this entity in your AWS CloudFormation template, use the following sy -Property description not available. +The description of the configuration. @@ -58 +85 @@ _Required_ : No -Property description not available. +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. @@ -69 +96 @@ _Required_ : No -Property description not available. +Latest revision of the MSK configuration. @@ -80 +107 @@ _Required_ : No -Property description not available. +The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$". @@ -91 +118 @@ _Required_ : Yes -Property description not available. +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. @@ -102,0 +130,2 @@ _Required_ : Yes +When you provide the logical ID of this resource to the `Ref` intrinsic function, it returns the MSK configuration. + @@ -104,0 +134,2 @@ _Required_ : Yes +`Fn::GetAtt` returns a value for a specified attribute of this type. The following are the available attributes and sample return values. + @@ -110 +141 @@ _Required_ : Yes -Property description not available. +The Amazon Resource Name (ARN) of the configuration. @@ -115 +146 @@ Property description not available. -Property description not available. +The time when the configuration revision was created. @@ -120 +151 @@ Property description not available. -Property description not available. +The description of the configuration revision. @@ -125 +156 @@ Property description not available. -Property description not available. +The revision number.