logging_configurations

Creates, updates, deletes or gets a logging_configuration resource or lists logging_configurations in a region

Overview

Name	logging_configurations
Type	Resource
Description	Resource type definition for AWS::IVSChat::LoggingConfiguration.
Id	aws.ivschat.logging_configurations

Fields

Name	Datatype	Description
arn	string	LoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
id	string	The system-generated ID of the logging configuration.
destination_configuration	object	Destination configuration for IVS Chat logging.
name	string	The name of the logging configuration. The value does not need to be unique.
state	string	The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DestinationConfiguration, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all logging_configurations in a region.

SELECT
region,
arn,
id,
destination_configuration,
name,
state,
tags
FROM aws.ivschat.logging_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual logging_configuration.

SELECT
region,
arn,
id,
destination_configuration,
name,
state,
tags
FROM aws.ivschat.logging_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new logging_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ivschat.logging_configurations (
 DestinationConfiguration,
 region
)
SELECT 
'{{ DestinationConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivschat.logging_configurations (
 DestinationConfiguration,
 Name,
 Tags,
 region
)
SELECT 
 '{{ DestinationConfiguration }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: logging_configuration
    props:
      - name: DestinationConfiguration
        value:
          CloudWatchLogs:
            LogGroupName: '{{ LogGroupName }}'
          Firehose:
            DeliveryStreamName: '{{ DeliveryStreamName }}'
          S3:
            BucketName: '{{ BucketName }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ivschat.logging_configurations
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the logging_configurations resource, the following permissions are required:

Create

ivschat:CreateLoggingConfiguration,
ivschat:GetLoggingConfiguration,
logs:CreateLogDelivery,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
s3:PutBucketPolicy,
s3:GetBucketPolicy,
iam:CreateServiceLinkedRole,
firehose:TagDeliveryStream,
ivschat:TagResource

Read

ivschat:GetLoggingConfiguration,
ivschat:ListTagsForResource

Update

ivschat:UpdateLoggingConfiguration,
ivschat:GetLoggingConfiguration,
ivschat:TagResource,
ivschat:UntagResource,
ivschat:ListTagsForResource,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
s3:PutBucketPolicy,
s3:GetBucketPolicy,
iam:CreateServiceLinkedRole,
firehose:TagDeliveryStream

Delete

ivschat:DeleteLoggingConfiguration,
ivschat:GetLoggingConfiguration,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
ivschat:UntagResource,
logs:GetLogDelivery

List

ivschat:ListLoggingConfigurations,
ivschat:ListTagsForResource