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	awscc.ivschat.logging_configurations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	LoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
region	string	AWS region.

For more information, see AWS::IVSChat::LoggingConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	logging_configurations	INSERT	DestinationConfiguration, region
delete_resource	logging_configurations	DELETE	Identifier, region
update_resource	logging_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	logging_configurations_list_only	SELECT	region
get_resource	logging_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual logging_configuration.

SELECT
  region,
  arn,
  id,
  destination_configuration,
  name,
  state,
  tags
FROM awscc.ivschat.logging_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all logging_configurations in a region.

SELECT
  region,
  arn
FROM awscc.ivschat.logging_configurations_list_only
WHERE
  region = '{{ region }}';

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 awscc.ivschat.logging_configurations (
  DestinationConfiguration,
  region
)
SELECT
  '{{ destination_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ivschat.logging_configurations (
  DestinationConfiguration,
  Name,
  Tags,
  region
)
SELECT
  '{{ destination_configuration }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: logging_configuration
  props:
    - name: destination_configuration
      value:
        cloud_watch_logs:
          log_group_name: '{{ log_group_name }}'
        firehose:
          delivery_stream_name: '{{ delivery_stream_name }}'
        s3:
          bucket_name: '{{ bucket_name }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivschat.logging_configurations
SET PatchDocument = string('{{ {
    "DestinationConfiguration": destination_configuration,
    "Name": name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ivschat.logging_configurations
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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