EventBridge Scheduler

2 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

Schedule # GA

Schedule is the Schema for managing EventBridge Scheduler schedules.

kubectl get schedules · example on GitHub

Example

# Schedule — EventBridge Scheduler
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/scheduler.html#schedule
apiVersion: aws.konfig.io/v1alpha1
kind: Schedule
metadata:
  name: example-schedule
  namespace: default
spec:
  description: Managed by konfig-konector
  flexibleTimeWindow:
    maximumWindowInMinutes: 1
    mode: 'OFF'
  groupRef:
    groupName: example-schedule
    name: example-schedule
  name: example-schedule
  providerRef:
    name: example-schedule
    region: us-east-1
  scheduleExpression: example
  state: ENABLED
  target:
    arn: arn:aws:iam::123456789012:role/example-role
    deadLetterArn: arn:aws:iam::123456789012:role/example-role
    input: example
    retryPolicy:
      maximumEventAgeInSeconds: 60
      maximumRetryAttempts: 1
    roleRef:
      name: example-role
  timezone: example

Spec

Field	Type	Required	Description
`description`	string	—	Description of the schedule.
`flexibleTimeWindow`	object	yes	FlexibleTimeWindow configures the invocation window.
`flexibleTimeWindow.maximumWindowInMinutes`	integer	—	MaximumWindowInMinutes is the maximum window when mode is FLEXIBLE.
`flexibleTimeWindow.mode`	enum	yes	Mode is OFF or FLEXIBLE. Allowed: `OFF, FLEXIBLE`
`groupRef`	object	—	GroupRef references the schedule group.
`groupRef.groupName`	string	—	GroupName is a direct AWS schedule group name, bypassing CR lookup.
`groupRef.name`	string	—	Name of a ScheduleGroup CR in the same namespace.
`name`	string	yes	Name is the name of the schedule.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`scheduleExpression`	string	yes	ScheduleExpression, e.g.
`state`	enum	—	State is ENABLED or DISABLED. Allowed: `ENABLED, DISABLED`
`target`	object	yes	Target is the resource invoked by the schedule.
`target.arn`	string	yes	ARN of the target resource (Lambda function, SQS queue, ECS cluster...).
`target.deadLetterArn`	string	—	DeadLetterARN is the ARN of an SQS queue for failed invocations.
`target.input`	string	—	Input is a static JSON payload passed to the target.
`target.retryPolicy`	object	—	RetryPolicy for target invocation.
`target.retryPolicy.maximumEventAgeInSeconds`	integer	—	MaximumEventAgeInSeconds is the maximum age of an event to retry.
`target.retryPolicy.maximumRetryAttempts`	integer	—	MaximumRetryAttempts before the invocation is dropped or dead-lettered.
`target.roleRef`	object	yes	RoleRef references the IAM role EventBridge Scheduler assumes to invoke the target (by CR name or direct ARN).
`target.roleRef.arn`	string	—	ARN is a direct AWS IAM role ARN.
`target.roleRef.name`	string	—	Name of an IAMRole CR in the same namespace.
`target.roleRef.namespace`	string	—	Namespace of the IAMRole CR.
`timezone`	string	—	Timezone for the schedule expression, e.g.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the schedule.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

ScheduleGroup # GA

ScheduleGroup is the Schema for managing EventBridge Scheduler schedule groups.

kubectl get schedulegroups · example on GitHub

Example

# ScheduleGroup — EventBridge Scheduler
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/scheduler.html#schedulegroup
apiVersion: aws.konfig.io/v1alpha1
kind: ScheduleGroup
metadata:
  name: example-schedulegroup
  namespace: default
spec:
  name: example-schedulegroup
  providerRef:
    name: example-schedulegroup
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`name`	string	yes	Name is the name of the schedule group.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the schedule group.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.