AWS::IVSChat::LoggingConfiguration - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


The AWS::IVSChat::LoggingConfiguration resource specifies an Amazon IVS logging configuration that allows clients to store and record sent messages. For more information, see CreateLoggingConfiguration in the Amazon Interactive Video Service Chat API Reference.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::IVSChat::LoggingConfiguration", "Properties" : { "DestinationConfiguration" : DestinationConfiguration, "Name" : String, "Tags" : [ Tag, ... ] } }


Type: AWS::IVSChat::LoggingConfiguration Properties: DestinationConfiguration: DestinationConfiguration Name: String Tags: - Tag



The DestinationConfiguration is a complex type that contains information about where chat content will be logged.

Required: Yes

Type: DestinationConfiguration

Update requires: No interruption


Logging-configuration name. The value does not need to be unique.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9-_]*$

Minimum: 0

Maximum: 128

Update requires: No interruption


An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the logging-configuration ARN. For example:

{ "Ref": "myLoggingConfiguration" }

For the Amazon IVS logging configuration myLoggingConfiguration, Ref returns the logging-configuration ARN.

For more information about using the Ref function, see Ref.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


The logging-configuration ARN. For example: arn:aws:ivschat:us-west-2:123456789012:logging-configuration/abcdABCDefgh


The logging-configuration ID. For example: abcdABCDefgh


Indicates the current state of the logging configuration. When the state is ACTIVE, the configuration is ready to log a chat session. Valid values: CREATING | CREATE_FAILED | DELETING | DELETE_FAILED | UPDATING | UPDATE_FAILED | ACTIVE.


Logging Configuration Template Examples

The following examples specify an Amazon IVS Chat Room that logs interactions to an S3 bucket.


{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "Bucket": { "Type": "AWS::S3::Bucket" }, "LogGroup": { "Type": "AWS::Logs::LogGroup" }, "DeliveryStreamRole": { "Type": "AWS::IAM::Role", "Properties": { "AssumeRolePolicyDocument": { "Version": "2012-10-17", "Statement": { "Effect": "Allow", "Principal": { "Service": "" }, "Action": "sts:AssumeRole" } } } }, "DeliveryStream": { "Type": "AWS::KinesisFirehose::DeliveryStream", "Properties": { "S3DestinationConfiguration": { "BucketARN": { "Fn::GetAtt": [ "Bucket", "Arn" ] }, "RoleARN": { "Fn::GetAtt": [ "DeliveryStreamRole", "Arn" ] } } } }, "S3LoggingConfiguration": { "Type": "AWS::IVSChat::LoggingConfiguration", "Properties": { "Name": "S3", "DestinationConfiguration": { "S3": { "BucketName": { "Ref": "Bucket" } } } } }, "CloudWatchLogsLoggingConfiguration": { "Type": "AWS::IVSChat::LoggingConfiguration", "Properties": { "Name": "CloudWatchLogs", "DestinationConfiguration": { "CloudWatchLogs": { "LogGroupName": { "Ref": "LogGroup" } } } } }, "FirehoseLoggingConfiguration": { "Type": "AWS::IVSChat::LoggingConfiguration", "Properties": { "Name": "Firehose", "DestinationConfiguration": { "Firehose": { "DeliveryStreamName": { "Ref": "DeliveryStream" } } } } }, "Room": { "Type": "AWS::IVSChat::Room", "Properties": { "Name": "LoggingRoom", "LoggingConfigurationIdentifiers": [ { "Ref": "S3LoggingConfiguration" }, { "Ref": "CloudWatchLogsLoggingConfiguration" }, { "Ref": "FirehoseLoggingConfiguration" } ] } } } }


AWSTemplateFormatVersion: 2010-09-09 Resources: Bucket: Type: AWS::S3::Bucket LogGroup: Type: AWS::Logs::LogGroup DeliveryStreamRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: 2012-10-17 Statement: Effect: Allow Principal: Service: Action: sts:AssumeRole DeliveryStream: Type: AWS::KinesisFirehose::DeliveryStream Properties: S3DestinationConfiguration: BucketARN: !GetAtt Bucket.Arn RoleARN: !GetAtt DeliveryStreamRole.Arn S3LoggingConfiguration: Type: AWS::IVSChat::LoggingConfiguration Properties: Name: S3 DestinationConfiguration: S3: BucketName: !Ref Bucket CloudWatchLogsLoggingConfiguration: Type: AWS::IVSChat::LoggingConfiguration Properties: Name: CloudWatchLogs DestinationConfiguration: CloudWatchLogs: LogGroupName: !Ref LogGroup FirehoseLoggingConfiguration: Type: AWS::IVSChat::LoggingConfiguration Properties: Name: Firehose DestinationConfiguration: Firehose: DeliveryStreamName: !Ref DeliveryStream Room: Type: AWS::IVSChat::Room Properties: Name: LoggingRoom LoggingConfigurationIdentifiers: - !Ref S3LoggingConfiguration - !Ref CloudWatchLogsLoggingConfiguration - !Ref FirehoseLoggingConfiguration

See also