AWS::MSK::Topic - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::MSK::Topic

Creates a new MSK topic.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MSK::Topic",
  "Properties" : {
      "ClusterArn" : String,
      "Configs" : String,
      "PartitionCount" : Integer,
      "ReplicationFactor" : Integer,
      "TopicName" : String
    }
}

YAML

Type: AWS::MSK::Topic
Properties:
  ClusterArn: String
  Configs: String
  PartitionCount: Integer
  ReplicationFactor: Integer
  TopicName: String

Properties

ClusterArn

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Required: Yes

Type: String

Update requires: Replacement

Configs

Topic configurations encoded as a Base64 string.

Required: No

Type: String

Update requires: No interruption

PartitionCount

The number of partitions for the topic.

Required: Yes

Type: Integer

Minimum: 1

Update requires: No interruption

ReplicationFactor

The replication factor for the topic.

Required: Yes

Type: Integer

Minimum: 1

Update requires: Replacement

TopicName

The name of the topic to create.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you provide the logical ID of this resource to the Ref intrinsic function, Ref returns the topic ARN.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

TopicArn

The Amazon Resource Name (ARN) of the topic.