logging_configurations

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

Overview

Name	logging_configurations
Type	Resource
Id	aws.ivschat.logging_configurations

Fields

The following fields are returned by SELECT queries:

get_logging_configuration

Name	Datatype	Description
id	string	Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration. (pattern: <code>[a-zA-Z0-9]+</code>)
name	string	Logging-configuration name. This value does not need to be unique. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Logging-configuration ARN, from the request (if identifier was an ARN). (pattern: <code>arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+</code>)
create_time	string (date-time)	Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
destination_configuration	object	A complex type that describes a location where chat logs will be stored. Each member represents the configuration of one log destination. For logging, you define only one type of destination (for CloudWatch Logs, Kinesis Firehose, or S3).
state	string	The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content. (CREATING, CREATE_FAILED, DELETING, DELETE_FAILED, UPDATING, UPDATE_FAILED, ACTIVE)
tags	object	Tags attached to the resource. Array of maps, each of the form string:string (key:value).
update_time	string (date-time)	Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

list_logging_configurations

Name	Datatype	Description
logging_configurations	array	List of the matching logging configurations (summary information only). There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
next_token	string	If there are more logging configurations than maxResults, use nextToken in the request to get the next set.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_logging_configuration	select	region		Gets the specified logging configuration.
list_logging_configurations	select	region		Gets summary information about all your logging configurations in the AWS region where the API request is processed.
create_logging_configuration	insert	region, destinationConfiguration		Creates a logging configuration that allows clients to store and record sent messages.
update_logging_configuration	update	region, identifier		Updates a specified logging configuration.
delete_logging_configuration	delete	region		Deletes the specified logging configuration.

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

get_logging_configuration

Gets the specified logging configuration.

SELECT
id,
name,
arn,
create_time,
destination_configuration,
state,
tags,
update_time
FROM aws.ivschat.logging_configurations
WHERE region = '{{ region }}' -- required
;

list_logging_configurations

Gets summary information about all your logging configurations in the AWS region where the API request is processed.

SELECT
logging_configurations,
next_token
FROM aws.ivschat.logging_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_logging_configuration

Creates a logging configuration that allows clients to store and record sent messages.

INSERT INTO aws.ivschat.logging_configurations (
name,
destinationConfiguration,
tags,
region
)
SELECT 
'{{ name }}',
'{{ destinationConfiguration }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
create_time,
destination_configuration,
state,
tags,
update_time
;

Manifest

# Description fields are for documentation purposes
- name: logging_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the logging_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: destinationConfiguration
    description: |
      A complex type that describes a location where chat logs will be stored. Each member represents the configuration of one log destination. For logging, you define only one type of destination (for CloudWatch Logs, Kinesis Firehose, or S3).
    value:
      s3:
        bucketName: "{{ bucketName }}"
      cloudWatchLogs:
        logGroupName: "{{ logGroupName }}"
      firehose:
        deliveryStreamName: "{{ deliveryStreamName }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_logging_configuration

Updates a specified logging configuration.

UPDATE aws.ivschat.logging_configurations
SET 
identifier = '{{ identifier }}',
name = '{{ name }}',
destinationConfiguration = '{{ destinationConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND identifier = '{{ identifier }}' --required
RETURNING
id,
name,
arn,
create_time,
destination_configuration,
state,
tags,
update_time;

DELETE examples

delete_logging_configuration

Deletes the specified logging configuration.

DELETE FROM aws.ivschat.logging_configurations
WHERE region = '{{ region }}' --required
;