kcp scan msk-connectors

kcp scan msk-connectors

Scan MSK-managed (MSK Connect) connectors for clusters in the state file

Synopsis

Scan Amazon MSK Connect connectors and match them to MSK clusters already present in the state file. Sensitive config values are redacted before being written to state.

kcp scan msk-connectors [flags]

Examples

  # Scan managed connectors for all discovered clusters in a region
  kcp scan msk-connectors --state-file kcp-state.json --region us-east-1

  # Scan multiple regions (repeated flag or comma-separated)
  kcp scan msk-connectors --state-file kcp-state.json --region us-east-1 --region eu-west-3

  # Scan a single cluster (region inferred from the ARN)
  kcp scan msk-connectors --state-file kcp-state.json --cluster-arn arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster/uuid

  # Also collect CloudWatch (AWS/KafkaConnect) metrics (pass --metrics-granularity)
  kcp scan msk-connectors --state-file kcp-state.json --region us-east-1 --metrics-granularity 1d

Options

      --cluster-arn strings          Scan only the specified MSK cluster ARN(s) (comma separated or repeated flag). Region is inferred from each ARN. Mutually exclusive with --region.
  -h, --help                         help for msk-connectors
      --metrics-granularity string   Collect CloudWatch (AWS/KafkaConnect) metrics at this granularity: 60s, 5m, 1h, or 1d. Omit to skip metrics collection. Max time range per granularity: 60s = 15 days, 5m = 63 days, 1h = 365 days, 1d = 365 days.
      --region strings               The AWS region(s) to scan (comma separated list or repeated flag). Scans all discovered clusters in each region. Mutually exclusive with --cluster-arn.
      --state-file string            The path to the kcp state file to update with connector information.

Options inherited from parent commands

      --verbose   Enable verbose logging to console

AWS IAM Permissions

The following policy covers scanning MSK-managed (MSK Connect) connectors.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "MSKConnectScanPermissions",
      "Effect": "Allow",
      "Action": [
        "kafkaconnect:DescribeConnector",
        "kafkaconnect:ListConnectors"
      ],
      "Resource": "*"
    },
    {
      "Sid": "MSKConnectMetricsPermissions",
      "Effect": "Allow",
      "Action": [
        "cloudwatch:GetMetricData",
        "cloudwatch:ListMetrics"
      ],
      "Resource": "*"
    }
  ]
}

SEE ALSO

• kcp scan - Scan AWS resources for migration planning