AWS AWSCloudFormation documentation change
Summary
Added detailed documentation for creating an MSK cluster, including a Python example, property descriptions, and return value details
Security assessment
The changes add general documentation improvements and examples but do not specifically address security vulnerabilities or introduce new security features. The encryption information mentioned is part of standard cluster configuration.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.md index 890cc1d73..58e165ed1 100644 --- a/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.md +++ b/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.md @@ -7 +7,37 @@ SyntaxPropertiesReturn values -The `AWS::MSK::Cluster` resource Property description not available. for MSK. +Creates a new MSK cluster. + +The following Python 3.6 example shows how you can create a cluster that's distributed across two [Availability Zones](https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-availability-zones.html). Before you run this Python script, replace the example subnet and security-group IDs with the IDs of your subnets and security group. + +When you create an MSK cluster, its brokers get evenly distributed across a number of Availability Zones that's equal to the number of subnets that you specify in the `BrokerNodeGroupInfo` parameter. In the following example, you can add a third subnet to get a cluster that's distributed across three Availability Zones. + + + import boto3 + + client = boto3.client('kafka') + + response = client.create_cluster( + BrokerNodeGroupInfo={ + 'BrokerAZDistribution': 'DEFAULT', + 'ClientSubnets': [ + 'subnet-012345678901fedcba', + 'subnet-9876543210abcdef01' + ], + 'InstanceType': 'kafka.m5.large', + 'SecurityGroups': [ + 'sg-012345abcdef789789' + ] + }, + ClusterName='SalesCluster', + EncryptionInfo={ + 'EncryptionInTransit': { + 'ClientBroker': 'TLS_PLAINTEXT', + 'InCluster': True + } + }, + EnhancedMonitoring='PER_TOPIC_PER_BROKER', + KafkaVersion='2.2.1', + NumberOfBrokerNodes=2 + ) + + print(response) + @@ -68 +104 @@ To declare this entity in your AWS CloudFormation template, use the following sy -Property description not available. +Information about the broker nodes in the cluster. @@ -79 +115 @@ _Required_ : Yes -Property description not available. +Includes all client authentication related information. @@ -90 +126 @@ _Required_ : No -Property description not available. +The name of the cluster. @@ -105 +141 @@ _Required_ : Yes -Property description not available. +Represents the configuration that you want MSK to use for the cluster. @@ -116 +152 @@ _Required_ : No -Property description not available. +The version of the cluster that you want to update. @@ -127 +163 @@ _Required_ : No -Property description not available. +Includes all encryption-related information. @@ -138 +174 @@ _Required_ : No -Property description not available. +Specifies the level of monitoring for the MSK cluster. @@ -155 +191 @@ _Required_ : No -Property description not available. +The version of Apache Kafka. You can use Amazon MSK to create clusters that use [supported Apache Kafka versions](https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html). @@ -170 +206 @@ _Required_ : Yes -Property description not available. +Logging info details for the cluster. @@ -181 +217 @@ _Required_ : No -Property description not available. +The number of broker nodes in the cluster. @@ -192 +228 @@ _Required_ : Yes -Property description not available. +The settings for open monitoring. @@ -203 +239 @@ _Required_ : No -Property description not available. +This controls storage mode for supported storage tiers. @@ -220 +256 @@ _Required_ : No -Property description not available. +An arbitrary set of tags (key-value pairs) for the cluster. @@ -233,0 +270,2 @@ _Update requires_ : [No interruption](https://docs.aws.amazon.com/AWSCloudFormat +When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the ARN of the created MSK cluster. For example, `arn:aws:kafka:us-east-1:123456789012:cluster/myCluster/abcd1234-abcd-dcba-4321-a1b2abcd9f9f-2`. + @@ -235,0 +274,2 @@ _Update requires_ : [No interruption](https://docs.aws.amazon.com/AWSCloudFormat +`Fn::GetAtt` returns a value for a specified attribute of this type. The following are the available attributes and sample return values. + @@ -241 +281 @@ _Update requires_ : [No interruption](https://docs.aws.amazon.com/AWSCloudFormat -Property description not available. +The Amazon Resource Name (ARN) of the MSK cluster.