cluster_v2s

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

Overview

Name	cluster_v2s
Type	Resource
Id	aws.kafka.cluster_v2s

Fields

The following fields are returned by SELECT queries:

describe_cluster_v2

Name	Datatype	Description
active_operation_arn	string	The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
cluster_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the cluster.
cluster_name	string	The name of the cluster.
cluster_type	string	Cluster Type. (PROVISIONED, SERVERLESS)
creation_time	string (date-time)	The time when the cluster was created.
current_version	string	The current version of the MSK cluster.
provisioned	object	Information about the provisioned cluster.
serverless	object	Information about the serverless cluster.
state	string	The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. (ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, UPDATING)
state_info	object	State Info for the Amazon MSK cluster.
tags	object	Tags attached to the cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster_v2	select	cluster_arn, region		Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
create_cluster_v2	insert	region, ClusterName		Creates a new MSK cluster.

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) that uniquely identifies the cluster.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_cluster_v2

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

SELECT
active_operation_arn,
cluster_arn,
cluster_name,
cluster_type,
creation_time,
current_version,
provisioned,
serverless,
state,
state_info,
tags
FROM aws.kafka.cluster_v2s
WHERE cluster_arn = '{{ cluster_arn }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_cluster_v2

Creates a new MSK cluster.

INSERT INTO aws.kafka.cluster_v2s (
ClusterName,
Tags,
Provisioned,
Serverless,
region
)
SELECT 
'{{ ClusterName }}' /* required */,
'{{ Tags }}',
'{{ Provisioned }}',
'{{ Serverless }}',
'{{ region }}'
RETURNING
cluster_arn,
cluster_name,
cluster_type,
state
;

Manifest

# Description fields are for documentation purposes
- name: cluster_v2s
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cluster_v2s resource.
  - name: ClusterName
    value: "{{ ClusterName }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: Provisioned
    description: |
      Provisioned cluster request.
    value:
      BrokerNodeGroupInfo:
        BrokerAZDistribution: "{{ BrokerAZDistribution }}"
        ClientSubnets:
          - "{{ ClientSubnets }}"
        InstanceType: "{{ InstanceType }}"
        SecurityGroups:
          - "{{ SecurityGroups }}"
        StorageInfo:
          EbsStorageInfo:
            ProvisionedThroughput:
              Enabled: {{ Enabled }}
              VolumeThroughput: {{ VolumeThroughput }}
            VolumeSize: {{ VolumeSize }}
        ConnectivityInfo:
          PublicAccess:
            Type: "{{ Type }}"
          VpcConnectivity:
            ClientAuthentication:
              Sasl: "{{ Sasl }}"
              Tls: "{{ Tls }}"
          NetworkType: "{{ NetworkType }}"
        ZoneIds:
          - "{{ ZoneIds }}"
      Rebalancing:
        Status: "{{ Status }}"
      ClientAuthentication:
        Sasl:
          Scram:
            Enabled: {{ Enabled }}
          Iam:
            Enabled: {{ Enabled }}
        Tls:
          CertificateAuthorityArnList:
            - "{{ CertificateAuthorityArnList }}"
          Enabled: {{ Enabled }}
        Unauthenticated:
          Enabled: {{ Enabled }}
      ConfigurationInfo:
        Arn: "{{ Arn }}"
        Revision: {{ Revision }}
      EncryptionInfo:
        EncryptionAtRest:
          DataVolumeKMSKeyId: "{{ DataVolumeKMSKeyId }}"
        EncryptionInTransit:
          ClientBroker: "{{ ClientBroker }}"
          InCluster: {{ InCluster }}
      EnhancedMonitoring: "{{ EnhancedMonitoring }}"
      OpenMonitoring:
        Prometheus:
          JmxExporter:
            EnabledInBroker: {{ EnabledInBroker }}
          NodeExporter:
            EnabledInBroker: {{ EnabledInBroker }}
      KafkaVersion: "{{ KafkaVersion }}"
      LoggingInfo:
        AuthorizerLogs:
          CloudWatchLogs:
            Enabled: {{ Enabled }}
            LogGroup: "{{ LogGroup }}"
          Firehose:
            DeliveryStream: "{{ DeliveryStream }}"
            Enabled: {{ Enabled }}
          S3:
            Bucket: "{{ Bucket }}"
            Enabled: {{ Enabled }}
            Prefix: "{{ Prefix }}"
        BrokerLogs:
          CloudWatchLogs:
            Enabled: {{ Enabled }}
            LogGroup: "{{ LogGroup }}"
          Firehose:
            DeliveryStream: "{{ DeliveryStream }}"
            Enabled: {{ Enabled }}
          S3:
            Bucket: "{{ Bucket }}"
            Enabled: {{ Enabled }}
            Prefix: "{{ Prefix }}"
      NumberOfBrokerNodes: {{ NumberOfBrokerNodes }}
      StorageMode: "{{ StorageMode }}"
  - name: Serverless
    description: |
      Serverless cluster request.
    value:
      VpcConfigs:
        - SubnetIds: "{{ SubnetIds }}"
          SecurityGroupIds: "{{ SecurityGroupIds }}"
      ClientAuthentication:
        Sasl:
          Iam:
            Enabled: {{ Enabled }}