syslog_configurations

Creates, updates, deletes, gets or lists a syslog_configurations resource.

Overview

Name	syslog_configurations
Type	Resource
Id	aws.logs.syslog_configurations

Fields

The following fields are returned by SELECT queries:

list_syslog_configurations

Name	Datatype	Description
next_token	string	The token for the next set of items to return. The token expires after 24 hours.
syslog_configurations	array	The list of syslog configurations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_syslog_configurations	select	region		Returns a list of syslog configurations. You can optionally filter the results by log group or VPC endpoint.
put_syslog_configuration	replace	region, logGroupIdentifier		Creates or updates a syslog configuration for a log group. This enables ingestion of syslog data through the specified VPC endpoint into the log group.
delete_syslog_configuration	delete	region		Deletes a syslog configuration for a log group. After deletion, syslog data is no longer ingested through the specified VPC endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_syslog_configurations

Returns a list of syslog configurations. You can optionally filter the results by log group or VPC endpoint.

SELECT
next_token,
syslog_configurations
FROM aws.logs.syslog_configurations
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_syslog_configuration

Creates or updates a syslog configuration for a log group. This enables ingestion of syslog data through the specified VPC endpoint into the log group.

REPLACE aws.logs.syslog_configurations
SET 
logGroupIdentifier = '{{ logGroupIdentifier }}',
vpcEndpointId = '{{ vpcEndpointId }}'
WHERE 
region = '{{ region }}' --required
AND logGroupIdentifier = '{{ logGroupIdentifier }}' --required;

DELETE examples

delete_syslog_configuration

Deletes a syslog configuration for a log group. After deletion, syslog data is no longer ingested through the specified VPC endpoint.

DELETE FROM aws.logs.syslog_configurations
WHERE region = '{{ region }}' --required
;