AWS Trigger

AWS Trigger
Certified
Trigger a flow when an MSK cluster reaches a target state

Polls the state of an MSK cluster at a fixed interval and fires once when the cluster reaches the configured targetState. Subsequent polls are deduplicated via persisted state so the trigger does not re-fire while the cluster remains in that state. Exposes {{ trigger.clusterArn }} and {{ trigger.clusterState }} to downstream tasks. Note: the minimum recommended poll interval is PT30S.

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

Examples

Trigger a flow when an MSK cluster becomes ACTIVE.

yaml
id: on_msk_cluster_active
namespace: company.team

triggers:
  - id: cluster_ready
    type: io.kestra.plugin.aws.msk.Trigger
    region: "{{ secret('AWS_REGION') }}"
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"
    clusterArn: "{{ secret('MSK_CLUSTER_ARN') }}"
    targetState: ACTIVE
    interval: PT1M

tasks:
  - id: notify
    type: io.kestra.plugin.core.log.Log
    message: "MSK cluster {{ trigger.clusterArn }} is now {{ trigger.clusterState }}"

Properties

clusterArn *string

Cluster ARN

The Amazon Resource Name of the MSK cluster to monitor.

targetState *string

Possible Values

ACTIVECREATINGDELETINGFAILEDHEALINGMAINTENANCEREBOOTING_BROKERUPDATINGUNKNOWN_TO_SDK_VERSION

Target state

The cluster state that triggers execution. Valid values: ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, UPDATING.

accessKeyId string

AWS access key ID

Optional static credential. If omitted, the default credentials provider chain is used.

allowConcurrent boolean

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

endpointOverride string

Endpoint override

Override the default AWS endpoint URL.

interval string

DefaultPT1M

Formatduration

Poll interval

How often to poll the cluster state. ISO-8601 duration, e.g. PT1M. Minimum recommended value: PT30S.

region string

AWS region

The AWS region for the MSK service.

secretKeyId string

AWS secret access key

Pairs with accessKeyId for static credentials.

sessionToken string

AWS session token

Session token for temporary credentials.

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

stsEndpointOverride string

STS endpoint override

Override the default STS endpoint URL.

stsRoleArn string

STS role ARN

IAM role ARN to assume via STS before making API calls.

stsRoleExternalId string

STS role external ID

External ID to pass when assuming the STS role.

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

STS role session name

Session name to use when assuming the STS role.

when string

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

Outputs

clusterArn string

Cluster ARN

The ARN of the cluster that reached the target state.

clusterState string

Cluster state

The state the cluster reached, e.g. ACTIVE.