batch_scram_secrets

Creates, updates, deletes or gets a batch_scram_secret resource or lists batch_scram_secrets in a region

Overview

Name	batch_scram_secrets
Type	Resource
Description	Resource Type definition for AWS::MSK::BatchScramSecret
Id	aws.msk.batch_scram_secrets

Fields

Name	Datatype	Description
cluster_arn	string
secret_arn_list	array
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ClusterArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all batch_scram_secrets in a region.

SELECT
region,
cluster_arn,
secret_arn_list
FROM aws.msk.batch_scram_secrets
WHERE region = 'us-east-1';

Gets all properties from an individual batch_scram_secret.

SELECT
region,
cluster_arn,
secret_arn_list
FROM aws.msk.batch_scram_secrets
WHERE region = 'us-east-1' AND data__Identifier = '<ClusterArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.msk.batch_scram_secrets (
 ClusterArn,
 region
)
SELECT 
'{{ ClusterArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.msk.batch_scram_secrets (
 ClusterArn,
 SecretArnList,
 region
)
SELECT 
 '{{ ClusterArn }}',
 '{{ SecretArnList }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: batch_scram_secret
    props:
      - name: ClusterArn
        value: '{{ ClusterArn }}'
      - name: SecretArnList
        value:
          - '{{ SecretArnList[0] }}'

DELETE example

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

Permissions

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

Create

kafka:BatchAssociateScramSecret,
kafka:ListScramSecrets,
kms:CreateGrant,
kms:DescribeKey,
secretsmanager:GetSecretValue

Delete

kafka:BatchDisassociateScramSecret,
kafka:ListScramSecrets,
kms:CreateGrant,
kms:DescribeKey

List

kafka:ListScramSecrets,
kms:CreateGrant,
kms:DescribeKey,
secretsmanager:GetSecretValue

Read

kafka:ListScramSecrets,
kms:CreateGrant,
kms:DescribeKey,
secretsmanager:GetSecretValue

Update

kafka:BatchAssociateScramSecret,
kafka:BatchDisassociateScramSecret,
kafka:ListScramSecrets,
kms:CreateGrant,
kms:DescribeKey,
secretsmanager:GetSecretValue