Data Firehose

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

API Group: aws.konfig.io/v1alpha1

FirehoseDeliveryStream # GA

FirehoseDeliveryStream is the Schema for managing Kinesis Firehose delivery streams.

kubectl get firehosedeliverystreams · example on GitHub

Example

# FirehoseDeliveryStream — Data Firehose
# 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/firehose.html#firehosedeliverystream
apiVersion: aws.konfig.io/v1alpha1
kind: FirehoseDeliveryStream
metadata:
  name: example-firehosedeliverystream
  namespace: default
spec:
  deliveryStreamName: example-firehosedeliverystream
  deliveryStreamType: DirectPut
  providerRef:
    name: example-firehosedeliverystream
    region: us-east-1
  s3DestinationConfiguration:
    bucketARN: arn:aws:iam::123456789012:role/example-role
    bufferingIntervalSeconds: 300
    bufferingSizeMBs: 2
    prefix: example
    roleARN: arn:aws:iam::123456789012:role/example-role
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
deliveryStreamNamestringyesDeliveryStreamName is the name of the delivery stream.
deliveryStreamTypeenum—DeliveryStreamType specifies the source type (DirectPut or KinesisStreamAsSource). Allowed: DirectPut, KinesisStreamAsSource
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
s3DestinationConfigurationobject—S3DestinationConfiguration defines an S3 destination.
s3DestinationConfiguration.bucketARNstringyesBucketARN is the ARN of the S3 bucket.
s3DestinationConfiguration.bufferingIntervalSecondsinteger—BufferingIntervalSeconds is the buffering interval in seconds (60–900).
s3DestinationConfiguration.bufferingSizeMBsinteger—BufferingSizeMBs is the buffering size in MBs (1–128).
s3DestinationConfiguration.prefixstring—Prefix is the S3 prefix for delivered objects.
s3DestinationConfiguration.roleARNstringyesRoleARN is the IAM role ARN that grants Firehose access to S3.
tagsmap<string>—Tags are metadata tags for the delivery stream.

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
deliveryStreamARNstring—DeliveryStreamARN is the ARN of the delivery stream.
deliveryStreamStatusstring—DeliveryStreamStatus is the current status (CREATING, DELETING, ACTIVE).
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.