Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
crossplane-contrib/provider-aws@v0.49.1
DeliveryStream
firehose.aws.crossplane.io
DeliveryStream
crossplane-contrib/provider-aws@v0.49.1firehose.aws.crossplane.io

DeliveryStream is the Schema for the DeliveryStreams API

Type

CRD

Group

firehose.aws.crossplane.io

Version

v1alpha1

apiVersion: firehose.aws.crossplane.io/v1alpha1

kind: DeliveryStream

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

DeliveryStreamSpec defines the desired state of DeliveryStream

forProvider
requiredobject
requiredobject

DeliveryStreamParameters defines the desired state of DeliveryStream

object

The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

object

Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

indexName
string
object

Describes a data processing configuration.

enabled
boolean
array

No description provided.

array

No description provided.

type_
string
object

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

roleARN
string
object

Describes the configuration of a destination in Amazon S3.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
object

The details of the VPC of the Amazon ES destination.

roleARN
string
array

No description provided.

array

No description provided.

object

The destination in Amazon OpenSearch Service. You can specify only one destination.

object

Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

domainARN
string
indexName
string
object

Describes a data processing configuration.

enabled
boolean
array

No description provided.

array

No description provided.

type_
string
object

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

roleARN
string
object

Describes the configuration of a destination in Amazon S3.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
typeName
string
object

The details of the VPC of the Amazon ES destination.

roleARN
string
array

No description provided.

array

No description provided.

object

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

keyARN
string
keyType
string
deliveryStreamName
requiredstring
object

The destination in Amazon ES. You can specify only one destination.

object

Describes the buffering to perform before delivering data to the Amazon ES destination.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

domainARN
string
indexName
string
object

Describes a data processing configuration.

enabled
boolean
array

No description provided.

array

No description provided.

type_
string
object

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.

roleARN
string
object

Describes the configuration of a destination in Amazon S3.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
typeName
string
object

The details of the VPC of the Amazon ES destination.

roleARN
string
array

No description provided.

array

No description provided.

object

The destination in Amazon S3. You can specify only one destination.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion (https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html).

enabled
boolean
object

Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.

object

The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe (https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON) and the OpenX JSON SerDe (https://github.com/rcongiu/Hive-JSON-Serde).

object

The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

array

No description provided.

object

The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

object

Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

object

The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html) and the Parquet SerDe (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html).

orcSerDe
object
object

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC (https://orc.apache.org/docs/).

object

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet (https://parquet.apache.org/documentation/latest/).

object

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

catalogID
string
region
string
roleARN
string
tableName
string
versionID
string
object

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

enabled
boolean
object

The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
object

Describes a data processing configuration.

enabled
boolean
array

No description provided.

array

No description provided.

type_
string
roleARN
string
object

Describes the configuration of a destination in Amazon S3.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
object

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

object

Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.

accessKey
string
name
string
url
string
object

Describes a data processing configuration.

enabled
boolean
array

No description provided.

array

No description provided.

type_
string
object

The configuration of the HTTP endpoint request.

array

No description provided.

object

Describes the retry behavior in case Kinesis Data 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.

roleARN
string
object

Describes the configuration of a destination in Amazon S3.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
object

When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

kmsKeyARN
string
object

A Reference to a named object.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

A Selector selects an object.

policy
object
object

Policies for selection.

resolve
string
object

The destination in Amazon Redshift. You can specify only one destination.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes a COPY command for Amazon Redshift.

password
string
object

Describes a data processing configuration.

enabled
boolean
array

No description provided.

array

No description provided.

type_
string
object

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.

roleARN
string
object

Describes the configuration of a destination in Amazon S3.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
object

Describes the configuration of a destination in Amazon S3.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
username
string
region
requiredstring
object

[Deprecated] The destination in Amazon S3. You can specify only one destination.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
object

The destination in Splunk. You can specify only one destination.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

hECToken
string
object

Describes a data processing configuration.

enabled
boolean
array

No description provided.

array

No description provided.

type_
string
object

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.

object

Describes the configuration of a destination in Amazon S3.

bucketARN
string
object

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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.

object

Describes the Amazon CloudWatch logging options for your delivery stream.

object

Describes the encryption for a destination in Amazon S3.

object

Describes an encryption key for a destination in Amazon S3.

prefix
string
roleARN
string
tags
array
array

A set of tags to assign to the delivery 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 delivery 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 delivery stream.

key
string
value
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

DeliveryStreamStatus defines the observed state of DeliveryStream.

object

DeliveryStreamObservation defines the observed state of DeliveryStream

array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.