cluster_policies

Creates, updates, deletes or gets a cluster_policy resource or lists cluster_policies in a region

Overview

Name	cluster_policies
Type	Resource
Description	Resource Type definition for AWS::MSK::ClusterPolicy
Id	awscc.msk.cluster_policies

Fields

get (all properties)

Name	Datatype	Description
policy	object	A policy document containing permissions to add to the specified cluster.
cluster_arn	string	The arn of the cluster for the resource policy.
current_version	string	The current version of the policy attached to the specified cluster
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
cluster_arn	string	The arn of the cluster for the resource policy.
region	string	AWS region.

For more information, see AWS::MSK::ClusterPolicy.

Methods

Name	Resource	Accessible by	Required Params
create_resource	cluster_policies	INSERT	Policy, ClusterArn, region
delete_resource	cluster_policies	DELETE	Identifier, region
update_resource	cluster_policies	UPDATE	Identifier, PatchDocument, region
list_resources	cluster_policies_list_only	SELECT	region
get_resource	cluster_policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual cluster_policy.

SELECT
  region,
  policy,
  cluster_arn,
  current_version
FROM awscc.msk.cluster_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cluster_arn }}';

list (identifiers only)

Lists all cluster_policies in a region.

SELECT
  region,
  cluster_arn
FROM awscc.msk.cluster_policies_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new cluster_policy resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.msk.cluster_policies (
  Policy,
  ClusterArn,
  region
)
SELECT
  '{{ policy }}',
  '{{ cluster_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.msk.cluster_policies (
  Policy,
  ClusterArn,
  region
)
SELECT
  '{{ policy }}',
  '{{ cluster_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: cluster_policy
  props:
    - name: policy
      value: {}
    - name: cluster_arn
      value: '{{ cluster_arn }}'

UPDATE example

Use the following StackQL query and manifest file to update a cluster_policy resource, using stack-deploy.

/*+ update */
UPDATE awscc.msk.cluster_policies
SET PatchDocument = string('{{ {
    "Policy": policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cluster_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.msk.cluster_policies
WHERE
  Identifier = '{{ cluster_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the cluster_policies resource, the following permissions are required:

Create

kafka:PutClusterPolicy,
kafka:GetClusterPolicy

Read

kafka:GetClusterPolicy

List

kafka:GetClusterPolicy

Update

kafka:PutClusterPolicy,
kafka:GetClusterPolicy

Delete

kafka:DeleteClusterPolicy,
kafka:GetClusterPolicy