This documentation is for an unreleased version of Apache Flink. We recommend you use the latest stable version.
Amazon Kinesis Data Firehose SQL Connector #
Sink: Batch Sink: Streaming Append Mode
The Kinesis Data Firehose connector allows for writing data into Amazon Kinesis Data Firehose (KDF).
Dependencies #
Only available for stable versions.
How to create a Kinesis Data Firehose table #
Follow the instructions from the Amazon Kinesis Data Firehose Developer Guide to set up a Kinesis Data Firehose delivery stream. The following example shows how to create a table backed by a Kinesis Data Firehose delivery stream with minimum required options:
CREATE TABLE FirehoseTable (
`user_id` BIGINT,
`item_id` BIGINT,
`category_id` BIGINT,
`behavior` STRING
)
WITH (
'connector' = 'firehose',
'delivery-stream' = 'user_behavior',
'aws.region' = 'us-east-2',
'format' = 'csv'
);
Connector Options #
Option | Required | Default | Type | Description |
---|---|---|---|---|
Common Options | ||||
connector |
required | (none) | String | Specify what connector to use. For Kinesis Data Firehose use 'firehose' . |
delivery-stream |
required | (none) | String | Name of the Kinesis Data Firehose delivery stream backing this table. |
format |
required | (none) | String | The format used to deserialize and serialize Kinesis Data Firehose records. See Data Type Mapping for details. |
aws.region |
required | (none) | String | The AWS region where the delivery stream is defined. This option is required for KinesisFirehoseSink creation. |
aws.endpoint |
optional | (none) | String | The AWS endpoint for Amazon Kinesis Data Firehose. |
aws.trust.all.certificates |
optional | false | Boolean | If true accepts all SSL certificates. |
Authentication Options | ||||
aws.credentials.provider |
optional | AUTO | String | A credentials provider to use when authenticating against the Kinesis endpoint. See Authentication for details. |
aws.credentials.basic.accesskeyid |
optional | (none) | String | The AWS access key ID to use when setting credentials provider type to BASIC. |
aws.credentials.basic.secretkey |
optional | (none) | String | The AWS secret key to use when setting credentials provider type to BASIC. |
aws.credentials.profile.path |
optional | (none) | String | Optional configuration for profile path if credential provider type is set to be PROFILE. |
aws.credentials.profile.name |
optional | (none) | String | Optional configuration for profile name if credential provider type is set to be PROFILE. |
aws.credentials.role.arn |
optional | (none) | String | The role ARN to use when credential provider type is set to ASSUME_ROLE or WEB_IDENTITY_TOKEN. |
aws.credentials.role.sessionName |
optional | (none) | String | The role session name to use when credential provider type is set to ASSUME_ROLE or WEB_IDENTITY_TOKEN. |
aws.credentials.role.externalId |
optional | (none) | String | The external ID to use when credential provider type is set to ASSUME_ROLE. |
aws.credentials.role.stsEndpoint |
optional | (none) | String | The AWS endpoint for STS (derived from the AWS region setting if not set) to use when credential provider type is set to ASSUME_ROLE. |
aws.credentials.role.provider |
optional | (none) | String | The credentials provider that provides credentials for assuming the role when credential provider type is set to ASSUME_ROLE. Roles can be nested, so this value can again be set to ASSUME_ROLE |
aws.credentials.webIdentityToken.file |
optional | (none) | String | The absolute path to the web identity token file that should be used if provider type is set to WEB_IDENTITY_TOKEN. |
aws.credentials.custom.class |
required only if credential provider is set to CUSTOM | (none) | String | The full path (in Java package notation) to the user provided class to use if credential provider type is set to be CUSTOM e.g. org.user_company.auth.CustomAwsCredentialsProvider. |
Sink Options | ||||
sink.http-client.max-concurrency |
optional | 10000 | Integer |
Maximum number of allowed concurrent requests by FirehoseAsyncClient to be delivered to delivery stream.
|
sink.http-client.read-timeout |
optional | 360000 | Integer |
Maximum amount of time in ms for requests to be sent by FirehoseAsyncClient to delivery stream before failure.
|
sink.http-client.protocol.version |
optional | HTTP2 | String | Http version used by FirehoseAsyncClient . |
sink.batch.max-size |
optional | 500 | Integer | Maximum batch size of elements to be passed to FirehoseAsyncClient to be written downstream to delivery stream. |
sink.requests.max-inflight |
optional | 16 | Integer | Request threshold for uncompleted requests by FirehoseAsyncClient before blocking new write requests. |
sink.requests.max-buffered |
optional | 10000 | String | request buffer threshold by FirehoseAsyncClient before blocking new write requests. |
sink.flush-buffer.size |
optional | 5242880 | Long | Threshold value in bytes for writer buffer in FirehoseAsyncClient before flushing. |
sink.flush-buffer.timeout |
optional | 5000 | Long | Threshold time in ms for an element to be in a buffer of FirehoseAsyncClient before flushing. |
sink.fail-on-error |
optional | false | Boolean | Flag used for retrying failed requests. If set any request failure will not be retried and will fail the job. |
Authorization #
Make sure to create an appropriate IAM policy to allow reading writing to the Kinesis Data Firehose delivery stream.
Authentication #
Depending on your deployment you would choose a different Credentials Provider to allow access to Kinesis Data Firehose.
By default, the AUTO
Credentials Provider is used.
If the access key ID and secret key are set in the deployment configuration, this results in using the BASIC
provider.
A specific AWSCredentialsProvider can be optionally set using the aws.credentials.provider
setting.
Supported values are:
AUTO
- Use the default AWS Credentials Provider chain that searches for credentials in the following order:ENV_VARS
,SYS_PROPS
,WEB_IDENTITY_TOKEN
,PROFILE
, and EC2/ECS credentials provider.BASIC
- Use access key ID and secret key supplied as configuration.ENV_VAR
- UseAWS_ACCESS_KEY_ID
&AWS_SECRET_ACCESS_KEY
environment variables.SYS_PROP
- Use Java system propertiesaws.accessKeyId
andaws.secretKey
.PROFILE
- Use an AWS credentials profile to create the AWS credentials.ASSUME_ROLE
- Create AWS credentials by assuming a role. The credentials for assuming the role must be supplied.WEB_IDENTITY_TOKEN
- Create AWS credentials by assuming a role using Web Identity Token.CUSTOM
- Provide a custom class that implements the interfaceAWSCredentialsProvider
and has a constructorMyCustomClass(java.util.Properties config)
. All connector properties will be passed down to this custom credential provider class via the constructor.-
Data Type Mapping #
Kinesis Data Firehose stores records as Base64-encoded binary data objects, so it doesn’t have a notion of internal record structure.
Instead, Kinesis Data Firehose records are deserialized and serialized by formats, e.g. ‘avro’, ‘csv’, or ‘json’.
To determine the data type of the messages in your Kinesis Data Firehose backed tables, pick a suitable Flink format with the format
keyword.
Please refer to the Formats pages for more details.
Notice #
The current implementation for the Kinesis Data Firehose SQL connector only supports Kinesis Data Firehose backed sinks and doesn’t provide an implementation for source queries. Queries similar to:
SELECT * FROM FirehoseTable;
should result in an error similar to
Connector firehose can only be used as a sink. It cannot be used as a source.