serverless_clusters

Creates, updates, deletes or gets a serverless_cluster resource or lists serverless_clusters in a region

Overview

Name	serverless_clusters
Type	Resource
Description	Resource Type definition for AWS::MSK::ServerlessCluster
Id	aws.msk.serverless_clusters

Fields

Name	Datatype	Description
arn	string
cluster_name	string
vpc_configs	array
client_authentication	object
tags	object	A key-value pair to associate with a resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ClusterName, VpcConfigs, ClientAuthentication, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all serverless_clusters in a region.

SELECT
region,
arn,
cluster_name,
vpc_configs,
client_authentication,
tags
FROM aws.msk.serverless_clusters
WHERE region = 'us-east-1';

Gets all properties from an individual serverless_cluster.

SELECT
region,
arn,
cluster_name,
vpc_configs,
client_authentication,
tags
FROM aws.msk.serverless_clusters
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.msk.serverless_clusters (
 ClusterName,
 VpcConfigs,
 ClientAuthentication,
 region
)
SELECT 
'{{ ClusterName }}',
 '{{ VpcConfigs }}',
 '{{ ClientAuthentication }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.msk.serverless_clusters (
 ClusterName,
 VpcConfigs,
 ClientAuthentication,
 Tags,
 region
)
SELECT 
 '{{ ClusterName }}',
 '{{ VpcConfigs }}',
 '{{ ClientAuthentication }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: serverless_cluster
    props:
      - name: ClusterName
        value: '{{ ClusterName }}'
      - name: VpcConfigs
        value:
          - SecurityGroups:
              - '{{ SecurityGroups[0] }}'
            SubnetIds:
              - '{{ SubnetIds[0] }}'
      - name: ClientAuthentication
        value:
          Sasl:
            Iam:
              Enabled: '{{ Enabled }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.msk.serverless_clusters
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

kafka:CreateClusterV2,
kafka:TagResource,
kafka:DescribeClusterV2,
ec2:CreateVpcEndpoint,
ec2:CreateTags,
ec2:DescribeVpcAttribute,
ec2:DescribeSubnets,
ec2:DescribeVpcEndpoints,
ec2:DescribeVpcs,
ec2:DescribeSecurityGroups

Read

kafka:DescribeClusterV2

Delete

kafka:DeleteCluster,
kafka:DescribeClusterV2,
ec2:DeleteVpcEndpoints

List

kafka:ListClustersV2