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	awscc.msk.serverless_clusters

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	serverless_clusters	INSERT	ClusterName, VpcConfigs, ClientAuthentication, region
delete_resource	serverless_clusters	DELETE	Identifier, region
list_resources	serverless_clusters_list_only	SELECT	region
get_resource	serverless_clusters	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual serverless_cluster.

SELECT
  region,
  arn,
  cluster_name,
  vpc_configs,
  client_authentication,
  tags
FROM awscc.msk.serverless_clusters
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all serverless_clusters in a region.

SELECT
  region,
  arn
FROM awscc.msk.serverless_clusters_list_only
WHERE
  region = '{{ region }}';

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 awscc.msk.serverless_clusters (
  ClusterName,
  VpcConfigs,
  ClientAuthentication,
  region
)
SELECT
  '{{ cluster_name }}',
  '{{ vpc_configs }}',
  '{{ client_authentication }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.msk.serverless_clusters (
  ClusterName,
  VpcConfigs,
  ClientAuthentication,
  Tags,
  region
)
SELECT
  '{{ cluster_name }}',
  '{{ vpc_configs }}',
  '{{ client_authentication }}',
  '{{ tags }}',
  '{{ 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: serverless_cluster
  props:
    - name: cluster_name
      value: '{{ cluster_name }}'
    - name: vpc_configs
      value:
        - security_groups:
            - '{{ security_groups[0] }}'
          subnet_ids:
            - '{{ subnet_ids[0] }}'
    - name: client_authentication
      value:
        sasl:
          iam:
            enabled: '{{ enabled }}'
    - name: tags
      value: {}

DELETE example

/*+ delete */
DELETE FROM awscc.msk.serverless_clusters
WHERE
  Identifier = '{{ 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 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