Kinesis

WARNING: This information is part of a limited availability release. Portions of this API may be subject to changes and improvements over time. Fields marked deprecated may be removed in the future and their use is discouraged. For more information, see our product and feature lifecycle descriptions.

Fastly will publish log messages to an Amazon Kinesis stream in the format specified in the Amazon Kinesis Data Streams logging object.

Data model

access_keystringThe access key associated with the target Amazon Kinesis stream. Not required if iam_role is specified.
created_atstringDate and time in ISO 8601 format.
deleted_atstringDate and time in ISO 8601 format.
formatstringA Fastly log format string.
format_versionintegerThe version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1.
iam_rolestringThe ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if access_key and secret_key are provided.
namestringThe name for the real-time logging configuration.
placementstringWhere in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver.
regionstringThe AWS region to stream logs to.
secret_keystringThe secret key associated with the target Amazon Kinesis stream. Not required if iam_role is specified.
service_idstringAlphanumeric string identifying the service.
topicstringThe Amazon Kinesis stream to send logs to. Required.
updated_atstringDate and time in ISO 8601 format.
versionintegerInteger identifying a service version.

Endpoints

List Amazon Kinesis log endpoints

GET/service/service_id/version/version_id/logging/kinesis

Create an Amazon Kinesis log endpoint

POST/service/service_id/version/version_id/logging/kinesis

Get an Amazon Kinesis log endpoint

GET/service/service_id/version/version_id/logging/kinesis/logging_kinesis_name

Update the Amazon Kinesis log endpoint

PUT/service/service_id/version/version_id/logging/kinesis/logging_kinesis_name

Delete the Amazon Kinesis log endpoint

DELETE/service/service_id/version/version_id/logging/kinesis/logging_kinesis_name