AWS ListClusters

AWS ListClusters
Certified
List Amazon MSK clusters

Returns MSK clusters in the configured AWS region with optional name filtering. Paginates automatically. Results are capped at 100 entries; for larger accounts use the AWS Console or CLI for full enumeration.

yaml
type: io.kestra.plugin.aws.msk.ListClusters

Examples

List all MSK clusters and log the count.

yaml
id: msk_list_clusters
namespace: company.team

tasks:
  - id: list_clusters
    type: io.kestra.plugin.aws.msk.ListClusters
    region: "{{ secret('AWS_REGION') }}"
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"

  - id: log_results
    type: io.kestra.plugin.core.log.Log
    message: "Found {{ outputs.list_clusters.total }} MSK clusters"

Properties

accessKeyId string

Access Key Id in order to connect to AWS

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

clusterNameFilter string

Cluster name filter

Optional substring filter on cluster name.

compatibilityMode booleanstring

Enable compatibility mode

Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.

endpointOverride string

The endpoint with which the SDK should communicate

This property allows you to use a different S3 compatible storage backend.

forcePathStyle booleanstring

Force path style access

Must only be used when compatibilityMode is enabled.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

region string

AWS region with which the SDK should communicate

secretKeyId string

Secret Key Id in order to connect to AWS

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

sessionToken string

AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

stsEndpointOverride string

The AWS STS endpoint with which the SDKClient should communicate

stsRoleArn string

AWS STS Role

The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

stsRoleExternalId string

AWS STS External Id

A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.

stsRoleSessionDuration string

DefaultPT15M

AWS STS Session duration

The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.

stsRoleSessionName string

AWS STS Session name

This property is only used when an stsRoleArn is defined.

Outputs

clusters array

SubTypeobject

Clusters

List of MSK cluster entries (capped at 100), each containing clusterArn, clusterName, state, kafkaVersion, numberOfBrokerNodes, and creationTime.