LoggingKinesisApi.md

Fastly::LoggingKinesisApi

require 'fastly'
api_instance = Fastly::LoggingKinesisApi.new

Methods

Note

All URIs are relative to https://api.fastly.com

Method	HTTP request	Description
create_log_kinesis	POST /service/{service_id}/version/{version_id}/logging/kinesis	Create an Amazon Kinesis log endpoint
delete_log_kinesis	DELETE /service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}	Delete the Amazon Kinesis log endpoint
get_log_kinesis	GET /service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}	Get an Amazon Kinesis log endpoint
list_log_kinesis	GET /service/{service_id}/version/{version_id}/logging/kinesis	List Amazon Kinesis log endpoints
update_log_kinesis	PUT /service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}	Update the Amazon Kinesis log endpoint

create_log_kinesis()

create_log_kinesis(opts): <LoggingKinesisResponse> # Create  an Amazon Kinesis log endpoint

Create an Amazon Kinesis Data Streams logging object for a particular service and version.

Examples

api_instance = Fastly::LoggingKinesisApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
    name: 'name_example', # String | The name for the real-time logging configuration.
    placement: Fastly::LoggingPlacement::NONE, # LoggingPlacement | 
    format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
    topic: 'topic_example', # String | The Amazon Kinesis stream to send logs to. Required.
    region: Fastly::AwsRegion::US_EAST_1, # AwsRegion | 
    secret_key: 'secret_key_example', # String | The secret key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.
    access_key: 'access_key_example', # String | The access key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.
    iam_role: 'iam_role_example', # String | The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if `access_key` and `secret_key` are provided.
    format_version: 1, # Integer | The 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`. 
}

begin
  # Create  an Amazon Kinesis log endpoint
  result = api_instance.create_log_kinesis(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingKinesisApi->create_log_kinesis: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
version_id	Integer	Integer identifying a service version.
name	String	The name for the real-time logging configuration.	[optional]
placement	LoggingPlacement		[optional]
format	String	A Fastly log format string.	[optional][default to '{"timestamp":"%{begin:%Y-%m-%dT%H:%M:%S}t","time_elapsed":"%{time.elapsed.usec}V","is_tls":"%{if(req.is_ssl, \"true\", \"false\")}V","client_ip":"%{req.http.Fastly-Client-IP}V","geo_city":"%{client.geo.city}V","geo_country_code":"%{client.geo.country_code}V","request":"%{req.request}V","host":"%{req.http.Fastly-Orig-Host}V","url":"%{json.escape(req.url)}V","request_referer":"%{json.escape(req.http.Referer)}V","request_user_agent":"%{json.escape(req.http.User-Agent)}V","request_accept_language":"%{json.escape(req.http.Accept-Language)}V","request_accept_charset":"%{json.escape(req.http.Accept-Charset)}V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)
topic	String	The Amazon Kinesis stream to send logs to. Required.	[optional]
region	AwsRegion		[optional]
secret_key	String	The secret key associated with the target Amazon Kinesis stream. Not required if iam_role is specified.	[optional]
access_key	String	The access key associated with the target Amazon Kinesis stream. Not required if iam_role is specified.	[optional]
iam_role	String	The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if access_key and secret_key are provided.	[optional]
format_version	Integer	The 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.	[optional][default to FORMAT_VERSION::v2]

Return type

LoggingKinesisResponse

[Back to top] [Back to API list] [Back to README]

delete_log_kinesis()

delete_log_kinesis(opts): <InlineResponse200> # Delete the Amazon Kinesis log endpoint

Delete an Amazon Kinesis Data Streams logging object for a particular service and version.

Examples

api_instance = Fastly::LoggingKinesisApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
    logging_kinesis_name: 'logging_kinesis_name_example', # String | The name for the real-time logging configuration.
}

begin
  # Delete the Amazon Kinesis log endpoint
  result = api_instance.delete_log_kinesis(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingKinesisApi->delete_log_kinesis: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
version_id	Integer	Integer identifying a service version.
logging_kinesis_name	String	The name for the real-time logging configuration.

Return type

InlineResponse200

[Back to top] [Back to API list] [Back to README]

get_log_kinesis()

get_log_kinesis(opts): <LoggingKinesisResponse> # Get an Amazon Kinesis log endpoint

Get the details for an Amazon Kinesis Data Streams logging object for a particular service and version.

Examples

api_instance = Fastly::LoggingKinesisApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
    logging_kinesis_name: 'logging_kinesis_name_example', # String | The name for the real-time logging configuration.
}

begin
  # Get an Amazon Kinesis log endpoint
  result = api_instance.get_log_kinesis(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingKinesisApi->get_log_kinesis: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
version_id	Integer	Integer identifying a service version.
logging_kinesis_name	String	The name for the real-time logging configuration.

Return type

LoggingKinesisResponse

[Back to top] [Back to API list] [Back to README]

list_log_kinesis()

list_log_kinesis(opts): <Array<LoggingKinesisResponse>> # List Amazon Kinesis log endpoints

List all of the Amazon Kinesis Data Streams logging objects for a particular service and version.

Examples

api_instance = Fastly::LoggingKinesisApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
}

begin
  # List Amazon Kinesis log endpoints
  result = api_instance.list_log_kinesis(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingKinesisApi->list_log_kinesis: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
version_id	Integer	Integer identifying a service version.

Return type

Array<LoggingKinesisResponse>

[Back to top] [Back to API list] [Back to README]

update_log_kinesis()

update_log_kinesis(opts): <LoggingKinesisResponse> # Update the Amazon Kinesis log endpoint

Update an Amazon Kinesis Data Streams logging object for a particular service and version.

Examples

api_instance = Fastly::LoggingKinesisApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
    logging_kinesis_name: 'logging_kinesis_name_example', # String | The name for the real-time logging configuration.
}

begin
  # Update the Amazon Kinesis log endpoint
  result = api_instance.update_log_kinesis(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingKinesisApi->update_log_kinesis: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
version_id	Integer	Integer identifying a service version.
logging_kinesis_name	String	The name for the real-time logging configuration.

Return type

LoggingKinesisResponse

[Back to top] [Back to API list] [Back to README]