AWS DescribeCluster
CertifiedDescribe an Amazon MSK cluster
AWS DescribeCluster
Describe an Amazon MSK cluster
Returns the current state, broker count, Kafka version, ARN, and Zookeeper connection string
for an MSK cluster. Use this after CreateCluster to poll for ACTIVE status.
type: io.kestra.plugin.aws.msk.DescribeClusterExamples
Describe an MSK cluster by ARN.
id: msk_describe_cluster
namespace: company.team
tasks:
- id: describe_cluster
type: io.kestra.plugin.aws.msk.DescribeCluster
region: "{{ secret('AWS_REGION') }}"
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"
clusterArn: "{{ secret('MSK_CLUSTER_ARN') }}"
- id: log_state
type: io.kestra.plugin.core.log.Log
message: "Cluster state: {{ outputs.describe_cluster.state }}"
Properties
clusterArn *Requiredstring
Cluster ARN
The Amazon Resource Name of the MSK cluster.
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.
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 Non-dynamicstring
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
PT15MAWS 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
clusterArn string
Cluster ARN
The Amazon Resource Name of the cluster.
clusterName string
Cluster name
The name of the cluster.
creationTime string
Creation time
ISO-8601 timestamp when the cluster was created.
currentVersion string
Current version
The current version of the cluster used for updates.
kafkaVersion string
Kafka version
The Apache Kafka version running on the cluster.
numberOfBrokerNodes integer
Number of broker nodes
The number of broker nodes in the cluster.
state string
State
Current cluster state. One of: ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, UPDATING.
zookeeperConnectString string
Zookeeper connect string
Zookeeper connection string (plaintext).
