AWS::MSK::ClusterPolicy - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::MSK::ClusterPolicy

Create or update cluster policy.

Syntax

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

JSON

{
  "Type" : "AWS::MSK::ClusterPolicy",
  "Properties" : {
      "ClusterArn" : String,
      "Policy" : Json
    }
}

YAML

Type: AWS::MSK::ClusterPolicy
Properties:
  ClusterArn: String
  Policy: Json

Properties

ClusterArn

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

Required: Yes

Type: String

Pattern: ^arn:[\w-]+:kafka:[\w-]+:\d+:cluster.*\Z

Update requires: Replacement

Policy

Resource policy for the cluster. The maximum size supported for a resource-based policy document is 20 KB.

Required: Yes

Type: Json

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the cluster for the resource policy.

For Amazon MSK cluster policy MyClusterPolicy, Ref returns the cluster ARN for the resource policy whose logical ID is MyClusterPolicy.

For more information about using the Ref function, see Ref.

Fn::GetAtt

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

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CurrentVersion

The current version of the policy attached to the specified cluster.