WebService::Fastly::LoggingKinesisApi

Load the API package

use WebService::Fastly::Object::LoggingKinesisApi;

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

LoggingKinesisResponse create_log_kinesis(service_id => $service_id, version_id => $version_id, name => $name, placement => $placement, format => $format, topic => $topic, region => $region, secret_key => $secret_key, access_key => $access_key, iam_role => $iam_role, format_version => $format_version)

Create an Amazon Kinesis log endpoint

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

Example

use Data::Dumper;
use WebService::Fastly::LoggingKinesisApi;
my $api_instance = WebService::Fastly::LoggingKinesisApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $name = "name_example"; # string | The name for the real-time logging configuration.
my $placement = new WebService::Fastly.LoggingPlacement(); # LoggingPlacement | 
my $format = '{"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)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}'; # string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Kinesis can ingest.
my $topic = "topic_example"; # string | The Amazon Kinesis stream to send logs to. Required.
my $region = new WebService::Fastly.AwsRegion(); # AwsRegion | 
my $secret_key = "secret_key_example"; # string | The secret key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.
my $access_key = "access_key_example"; # string | The access key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.
my $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.
my $format_version = 2; # int | 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`. 

eval {
    my $result = $api_instance->create_log_kinesis(service_id => $service_id, version_id => $version_id, name => $name, placement => $placement, format => $format, topic => $topic, region => $region, secret_key => $secret_key, access_key => $access_key, iam_role => $iam_role, format_version => $format_version);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingKinesisApi->create_log_kinesis: $@\n";
}

Parameters

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
version_id	int	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. Must produce valid JSON that Kinesis can ingest.	[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	int	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 2]

Return type

LoggingKinesisResponse

Authorization

token

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

delete_log_kinesis

InlineResponse200 delete_log_kinesis(service_id => $service_id, version_id => $version_id, logging_kinesis_name => $logging_kinesis_name)

Delete the Amazon Kinesis log endpoint

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

Example

use Data::Dumper;
use WebService::Fastly::LoggingKinesisApi;
my $api_instance = WebService::Fastly::LoggingKinesisApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_kinesis_name = "logging_kinesis_name_example"; # string | The name for the real-time logging configuration.

eval {
    my $result = $api_instance->delete_log_kinesis(service_id => $service_id, version_id => $version_id, logging_kinesis_name => $logging_kinesis_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingKinesisApi->delete_log_kinesis: $@\n";
}

Parameters

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

Return type

InlineResponse200

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_log_kinesis

LoggingKinesisResponse get_log_kinesis(service_id => $service_id, version_id => $version_id, logging_kinesis_name => $logging_kinesis_name)

Get an Amazon Kinesis log endpoint

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

Example

use Data::Dumper;
use WebService::Fastly::LoggingKinesisApi;
my $api_instance = WebService::Fastly::LoggingKinesisApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_kinesis_name = "logging_kinesis_name_example"; # string | The name for the real-time logging configuration.

eval {
    my $result = $api_instance->get_log_kinesis(service_id => $service_id, version_id => $version_id, logging_kinesis_name => $logging_kinesis_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingKinesisApi->get_log_kinesis: $@\n";
}

Parameters

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

Return type

LoggingKinesisResponse

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_log_kinesis

ARRAY[LoggingKinesisResponse] list_log_kinesis(service_id => $service_id, version_id => $version_id)

List Amazon Kinesis log endpoints

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

Example

use Data::Dumper;
use WebService::Fastly::LoggingKinesisApi;
my $api_instance = WebService::Fastly::LoggingKinesisApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.

eval {
    my $result = $api_instance->list_log_kinesis(service_id => $service_id, version_id => $version_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingKinesisApi->list_log_kinesis: $@\n";
}

Parameters

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

Return type

ARRAY[LoggingKinesisResponse]

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

update_log_kinesis

LoggingKinesisResponse update_log_kinesis(service_id => $service_id, version_id => $version_id, logging_kinesis_name => $logging_kinesis_name)

Update the Amazon Kinesis log endpoint

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

Example

use Data::Dumper;
use WebService::Fastly::LoggingKinesisApi;
my $api_instance = WebService::Fastly::LoggingKinesisApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_kinesis_name = "logging_kinesis_name_example"; # string | The name for the real-time logging configuration.

eval {
    my $result = $api_instance->update_log_kinesis(service_id => $service_id, version_id => $version_id, logging_kinesis_name => $logging_kinesis_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingKinesisApi->update_log_kinesis: $@\n";
}

Parameters

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

Return type

LoggingKinesisResponse

Authorization

token

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LoggingKinesisApi.md

LoggingKinesisApi.md

WebService::Fastly::LoggingKinesisApi

Load the API package

create_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

delete_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

get_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

list_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

update_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

Files

LoggingKinesisApi.md

Latest commit

History

LoggingKinesisApi.md

File metadata and controls

WebService::Fastly::LoggingKinesisApi

Load the API package

create_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

delete_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

get_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

list_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

update_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers