cluster_policies

Creates, updates, deletes, gets or lists a cluster_policies resource.

Overview

Name	cluster_policies
Type	Resource
Id	aws.kafka.cluster_policies

Fields

The following fields are returned by SELECT queries:

get_cluster_policy

Name	Datatype	Description
current_version	string	The version of cluster policy.
policy	string	The cluster policy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cluster_policy	select	cluster_arn, region		Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
put_cluster_policy	replace	cluster_arn, region		Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
delete_cluster_policy	delete	cluster_arn, region		Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster.
region	string	AWS region (default: us-east-1)

SELECT examples

get_cluster_policy

Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.

SELECT
current_version,
policy
FROM aws.kafka.cluster_policies
WHERE cluster_arn = '{{ cluster_arn }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_cluster_policy

Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.

REPLACE aws.kafka.cluster_policies
SET 
CurrentVersion = '{{ CurrentVersion }}',
Policy = '{{ Policy }}'
WHERE 
cluster_arn = '{{ cluster_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
current_version;

DELETE examples

delete_cluster_policy

Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.

DELETE FROM aws.kafka.cluster_policies
WHERE cluster_arn = '{{ cluster_arn }}' --required
AND region = '{{ region }}' --required
;