EventBridge Pipes

1 resource kind. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

EventBridgePipe # GA

EventBridgePipe is the Schema for managing EventBridge Pipes.

kubectl get eventbridgepipes · example on GitHub

Example

# EventBridgePipe — EventBridge Pipes
# 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/pipes.html#eventbridgepipe
apiVersion: aws.konfig.io/v1alpha1
kind: EventBridgePipe
metadata:
  name: example-eventbridgepipe
  namespace: default
spec:
  description: Managed by konfig-konector
  desiredState: RUNNING
  enrichment: example
  name: example-eventbridgepipe
  providerRef:
    name: example-eventbridgepipe
    region: us-east-1
  roleArn: arn:aws:iam::123456789012:role/example-role
  source: example
  tags:
    environment: dev
    team: platform
  target: example

Spec

Field	Type	Required	Description
`description`	string	—	Description is an optional description of the pipe.
`desiredState`	enum	—	DesiredState is the state the pipe should be in. Allowed: `RUNNING, STOPPED`
`enrichment`	string	—	Enrichment is the ARN of the enrichment resource.
`name`	string	yes	Name is the name of the pipe.
`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.
`roleArn`	string	yes	RoleARN is the ARN of the IAM role that allows the pipe to send data to the target.
`source`	string	yes	Source is the ARN of the source resource.
`tags`	map<string>	—	Tags are metadata tags for the pipe.
`target`	string	yes	Target is the ARN of the target resource.

Status

Field	Type	Required	Description
`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.
`pipeArn`	string	—	PipeARN is the ARN of the pipe.
`pipeState`	string	—	PipeState is the current state of the pipe.