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

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
cluster_arn	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual batch_scram_secret.

SELECT
  region,
  cluster_arn,
  secret_arn_list
FROM awscc.msk.batch_scram_secrets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ cluster_arn }}';

list (identifiers only)

Lists all batch_scram_secrets in a region.

SELECT
  region,
  cluster_arn
FROM awscc.msk.batch_scram_secrets_list_only
WHERE
  region = 'us-east-1';

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 awscc.msk.batch_scram_secrets (
  ClusterArn,
  region
)
SELECT
  '{{ cluster_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.msk.batch_scram_secrets (
  ClusterArn,
  SecretArnList,
  region
)
SELECT
  '{{ cluster_arn }}',
  '{{ secret_arn_list }}',
  '{{ 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: cluster_arn
        value: '{{ cluster_arn }}'
      - name: secret_arn_list
        value:
          - '{{ secret_arn_list[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.msk.batch_scram_secrets
SET PatchDocument = string('{{ {
    "SecretArnList": secret_arn_list
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cluster_arn }}';

DELETE example

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