dcloud deploy kafka bind

Bind a managed Kafka cluster as one of its users (private, in the app’s VPC)

IAM deploy:ManageBrokerBindingChanges stateAsks before it deletes (-y skips)

Generates {prefix}KAFKA_BOOTSTRAP_SERVERS (every node:9093), KAFKA_SECURITY_PROTOCOL (SASL_SSL), KAFKA_SASL_MECHANISM (SCRAM-SHA-512), KAFKA_SASL_USERNAME, KAFKA_SASL_PASSWORD (the user’s current password from Secrets) and KAFKA_SSL_CA_LOCATION (the platform CA in the container) at every rollout. Needs secrets:GetSecretValue on the user’s password. A bound user cannot be deleted. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.

Synopsis

dcloud deploy kafka bind id --cluster-id clusterId --user-name userName [flags]

Arguments

  • <id>Required

    string

    Also accepted as --id. Constraints: uuid

Flags

  • --cluster-idRequired

    string

    The managed Kafka cluster to bind

    Constraints: /^kfk-[0-9a-f]{12}$/

  • --user-nameRequired

    string

    The cluster user the app signs in as (create one with the right grants first)

    Constraints: /^[a-z][a-z0-9_.-]{0,63}$/

  • --env-prefixOptional

    string

    Put in front of every generated variable name (e.g. CACHE_ gives CACHE_REDIS_URL), so one app can hold several bindings of a kind; default empty

    Constraints: max 32 chars, /^([A-Z][A-Z0-9_]*_)?$/

  • --redeployOptional

    boolean (--redeploy / --no-redeploy)

    Also roll the live deployment onto the new configuration; default false

Example

dcloud deploy kafka bind id --cluster-id example --user-name example

Generated from the API description, the same one the API checks requests against and the CLI is built from.