DeliveryStream

firehose.services.k8s.aws/v1alpha1

Type	Link
GoDoc	firehose-controller/apis/v1alpha1#DeliveryStream

Metadata

Property	Value
Scope	Namespaced
Kind	`DeliveryStream`
ListKind	`DeliveryStreamList`
Plural	`deliverystreams`
Singular	`deliverystream`

Spec

deliveryStreamEncryptionConfiguration: 
  keyARN: string
  keyRef: 
    from: 
      name: string
      namespace: string
  keyType: string
deliveryStreamName: string
deliveryStreamType: string
httpEndpointDestinationConfiguration: 
  bufferingHints: 
    intervalInSeconds: integer
    sizeInMBs: integer
  cloudWatchLoggingOptions: 
    enabled: boolean
    logGroupName: string
    logStreamName: string
  endpointConfiguration: 
    accessKey: 
      key: string
      name: string
      namespace: string
    name: string
    url: string
  processingConfiguration: 
    enabled: boolean
    processors:
      parameters:
      - parameterName: string
        parameterValue: string
      type: string
  requestConfiguration: 
    commonAttributes:
    - attributeName: string
      attributeValue: string
    contentEncoding: string
  retryOptions: 
    durationInSeconds: integer
  roleARN: string
  roleRef: 
    from: 
      name: string
      namespace: string
  s3BackupMode: string
  s3Configuration: 
    bucketARN: string
    bucketRef: 
      from: 
        name: string
        namespace: string
    bufferingHints: 
      intervalInSeconds: integer
      sizeInMBs: integer
    cloudWatchLoggingOptions: 
      enabled: boolean
      logGroupName: string
      logStreamName: string
    compressionFormat: string
    encryptionConfiguration: 
      kmsEncryptionConfig: 
        awsKMSKeyARN: string
        awsKMSKeyRef: 
          from: 
            name: string
            namespace: string
      noEncryptionConfig: string
    errorOutputPrefix: string
    prefix: string
    roleARN: string
    roleRef: 
      from: 
        name: string
        namespace: string
  secretsManagerConfiguration: 
    enabled: boolean
    roleARN: string
    roleRef: 
      from: 
        name: string
        namespace: string
    secretARN: string
    secretRef: 
      from: 
        name: string
        namespace: string
tags:
- key: string
  value: string

Field	Description
deliveryStreamEncryptionConfiguration Optional	object Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
deliveryStreamEncryptionConfiguration.keyARN Optional	string
deliveryStreamEncryptionConfiguration.keyRef Optional	object Reference field for KeyARN
deliveryStreamEncryptionConfiguration.keyRef.from Optional	object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
deliveryStreamEncryptionConfiguration.keyRef.from.name Optional	string
deliveryStreamEncryptionConfiguration.keyRef.from.namespace Optional	string
deliveryStreamEncryptionConfiguration.keyType Optional	string
deliveryStreamName Required	string The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name. Regex Pattern: `^[a-zA-Z0-9_.-]+$`
deliveryStreamType Optional	string The Firehose stream type. This parameter can be one of the following values: * DirectPut: Provider applications access the Firehose stream directly. * KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
httpEndpointDestinationConfiguration Optional	object Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
httpEndpointDestinationConfiguration.bufferingHints Optional	object Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
httpEndpointDestinationConfiguration.bufferingHints.intervalInSeconds Optional	integer
httpEndpointDestinationConfiguration.bufferingHints.sizeInMBs Optional	integer
httpEndpointDestinationConfiguration.cloudWatchLoggingOptions Optional	object Describes the Amazon CloudWatch logging options for your Firehose stream.
httpEndpointDestinationConfiguration.cloudWatchLoggingOptions.enabled Optional	boolean
httpEndpointDestinationConfiguration.cloudWatchLoggingOptions.logGroupName Optional	string
httpEndpointDestinationConfiguration.cloudWatchLoggingOptions.logStreamName Optional	string
httpEndpointDestinationConfiguration.endpointConfiguration Optional	object Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
httpEndpointDestinationConfiguration.endpointConfiguration.accessKey Optional	object SecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret
httpEndpointDestinationConfiguration.endpointConfiguration.accessKey.key Required	string Key is the key within the secret
httpEndpointDestinationConfiguration.endpointConfiguration.accessKey.name Optional	string name is unique within a namespace to reference a secret resource.
httpEndpointDestinationConfiguration.endpointConfiguration.accessKey.namespace Optional	string namespace defines the space within which the secret name must be unique.
httpEndpointDestinationConfiguration.endpointConfiguration.name Optional	string
httpEndpointDestinationConfiguration.endpointConfiguration.url Optional	string
httpEndpointDestinationConfiguration.processingConfiguration Optional	object Describes a data processing configuration.
httpEndpointDestinationConfiguration.processingConfiguration.enabled Optional	boolean
httpEndpointDestinationConfiguration.processingConfiguration.processors Optional	array
httpEndpointDestinationConfiguration.processingConfiguration.processors.[] Required	object Describes a data processor.

If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, choose AppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord. || httpEndpointDestinationConfiguration.processingConfiguration.processors.[].parameters
Optional | array
| | httpEndpointDestinationConfiguration.processingConfiguration.processors.[].parameters.[]
Required | object
Describes the processor parameter. || httpEndpointDestinationConfiguration.processingConfiguration.processors.[].parameters.[].parameterName
Optional | string
| | httpEndpointDestinationConfiguration.processingConfiguration.processors.[].parameters.[].parameterValue
Optional | string
| | httpEndpointDestinationConfiguration.processingConfiguration.processors.[].type
Optional | string
| | httpEndpointDestinationConfiguration.requestConfiguration
Optional | object
The configuration of the HTTP endpoint request. | | httpEndpointDestinationConfiguration.requestConfiguration.commonAttributes
Optional | array
| | httpEndpointDestinationConfiguration.requestConfiguration.commonAttributes.[]
Required | object
Describes the metadata that’s delivered to the specified HTTP endpoint destination. || httpEndpointDestinationConfiguration.requestConfiguration.commonAttributes.[].attributeName
Optional | string
| | httpEndpointDestinationConfiguration.requestConfiguration.commonAttributes.[].attributeValue
Optional | string
| | httpEndpointDestinationConfiguration.requestConfiguration.contentEncoding
Optional | string
| | httpEndpointDestinationConfiguration.retryOptions
Optional | object
Describes the retry behavior in case Firehose is unable to deliver data to
the specified HTTP endpoint destination, or if it doesn’t receive a valid
acknowledgment of receipt from the specified HTTP endpoint destination. | | httpEndpointDestinationConfiguration.retryOptions.durationInSeconds
Optional | integer
| | httpEndpointDestinationConfiguration.roleARN
Optional | string
| | httpEndpointDestinationConfiguration.roleRef
Optional | object
Reference field for RoleARN | | httpEndpointDestinationConfiguration.roleRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | httpEndpointDestinationConfiguration.roleRef.from.name
Optional | string
| | httpEndpointDestinationConfiguration.roleRef.from.namespace
Optional | string
| | httpEndpointDestinationConfiguration.s3BackupMode
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration
Optional | object
Describes the configuration of a destination in Amazon S3. | | httpEndpointDestinationConfiguration.s3Configuration.bucketARN
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.bucketRef
Optional | object
Reference field for BucketARN | | httpEndpointDestinationConfiguration.s3Configuration.bucketRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | httpEndpointDestinationConfiguration.s3Configuration.bucketRef.from.name
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.bucketRef.from.namespace
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.bufferingHints
Optional | object
Describes hints for the buffering to perform before delivering data to the
destination. These options are treated as hints, and therefore Firehose might
choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds
parameters are optional. However, if specify a value for one of them, you
must also provide a value for the other. | | httpEndpointDestinationConfiguration.s3Configuration.bufferingHints.intervalInSeconds
Optional | integer
| | httpEndpointDestinationConfiguration.s3Configuration.bufferingHints.sizeInMBs
Optional | integer
| | httpEndpointDestinationConfiguration.s3Configuration.cloudWatchLoggingOptions
Optional | object
Describes the Amazon CloudWatch logging options for your Firehose stream. | | httpEndpointDestinationConfiguration.s3Configuration.cloudWatchLoggingOptions.enabled
Optional | boolean
| | httpEndpointDestinationConfiguration.s3Configuration.cloudWatchLoggingOptions.logGroupName
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.cloudWatchLoggingOptions.logStreamName
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.compressionFormat
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.encryptionConfiguration
Optional | object
Describes the encryption for a destination in Amazon S3. | | httpEndpointDestinationConfiguration.s3Configuration.encryptionConfiguration.kmsEncryptionConfig
Optional | object
Describes an encryption key for a destination in Amazon S3. | | httpEndpointDestinationConfiguration.s3Configuration.encryptionConfiguration.kmsEncryptionConfig.awsKMSKeyARN
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.encryptionConfiguration.kmsEncryptionConfig.awsKMSKeyRef
Optional | object
Reference field for AWSKMSKeyARN | | httpEndpointDestinationConfiguration.s3Configuration.encryptionConfiguration.kmsEncryptionConfig.awsKMSKeyRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | httpEndpointDestinationConfiguration.s3Configuration.encryptionConfiguration.kmsEncryptionConfig.awsKMSKeyRef.from.name
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.encryptionConfiguration.kmsEncryptionConfig.awsKMSKeyRef.from.namespace
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.encryptionConfiguration.noEncryptionConfig
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.errorOutputPrefix
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.prefix
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.roleARN
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.roleRef
Optional | object
Reference field for RoleARN | | httpEndpointDestinationConfiguration.s3Configuration.roleRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | httpEndpointDestinationConfiguration.s3Configuration.roleRef.from.name
Optional | string
| | httpEndpointDestinationConfiguration.s3Configuration.roleRef.from.namespace
Optional | string
| | httpEndpointDestinationConfiguration.secretsManagerConfiguration
Optional | object
The structure that defines how Firehose accesses the secret. | | httpEndpointDestinationConfiguration.secretsManagerConfiguration.enabled
Optional | boolean
| | httpEndpointDestinationConfiguration.secretsManagerConfiguration.roleARN
Optional | string
| | httpEndpointDestinationConfiguration.secretsManagerConfiguration.roleRef
Optional | object
Reference field for RoleARN | | httpEndpointDestinationConfiguration.secretsManagerConfiguration.roleRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | httpEndpointDestinationConfiguration.secretsManagerConfiguration.roleRef.from.name
Optional | string
| | httpEndpointDestinationConfiguration.secretsManagerConfiguration.roleRef.from.namespace
Optional | string
| | httpEndpointDestinationConfiguration.secretsManagerConfiguration.secretARN
Optional | string
| | httpEndpointDestinationConfiguration.secretsManagerConfiguration.secretRef
Optional | object
Reference field for SecretARN | | httpEndpointDestinationConfiguration.secretsManagerConfiguration.secretRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | httpEndpointDestinationConfiguration.secretsManagerConfiguration.secretRef.from.name
Optional | string
| | httpEndpointDestinationConfiguration.secretsManagerConfiguration.secretRef.from.namespace
Optional | string
| | tags
Optional | array
A set of tags to assign to the Firehose stream. A tag is a key-value pair
that you can define and assign to Amazon Web Services resources. Tags are
metadata. For example, you can add friendly names and descriptions or other
types of information that can help you distinguish the Firehose stream. For
more information about tags, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
in the Amazon Web Services Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a Firehose stream.

If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose
performs an additional authorization on the firehose:TagDeliveryStream action
to verify if users have permissions to create tags. If you do not provide
this permission, requests to create new Firehose streams with IAM resource
tags will fail with an AccessDeniedException such as following.

AccessDeniedException

User: arn:aws:sts:❌assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream
on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit
deny in an identity-based policy.

For an example IAM policy, see Tag example. (https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples) | | tags.[]
Required | object
Metadata that you can assign to a Firehose stream, consisting of a key-value pair. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createTimestamp: string
deliveryStreamEncryptionConfigurationFailureDescription: 
  details: string
  type: string
deliveryStreamEncryptionConfigurationStatus: string
deliveryStreamStatus: string
destinationID: string
lastUpdateTimestamp: string
versionID: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRs managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
createTimestamp Optional	string The date and time that the Firehose stream was created.
deliveryStreamEncryptionConfigurationFailureDescription Optional	object Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
deliveryStreamEncryptionConfigurationFailureDescription.details Optional	string
deliveryStreamEncryptionConfigurationFailureDescription.type Optional	string
deliveryStreamEncryptionConfigurationStatus Optional	string This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.
deliveryStreamStatus Optional	string The status of the Firehose stream. If the status of a Firehose stream is CREATING_FAILED, this status doesn’t change, and you can’t invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.
destinationID Optional	string The ID of the destination. Regex Pattern: `^[a-zA-Z0-9-]+$`
lastUpdateTimestamp Optional	string The date and time that the Firehose stream was last updated.
versionID Optional	string Each time the destination is updated for a Firehose stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream. Regex Pattern: `^[0-9]+$`

DeliveryStream

Metadata#

Spec#

Status#

Metadata

Spec

Status