AWS::IVSChat::LoggingConfiguration - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

AWS::IVSChat::LoggingConfiguration

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.

Syntax

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

JSON

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

YAML

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

Properties

DestinationConfiguration

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

Required: Yes

Type: DestinationConfiguration

Update requires: No interruption

Name

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

Tags

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

Ref

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.

Fn::GetAtt

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.

Arn

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

Id

The logging-configuration ID. For example: abcdABCDefgh

State

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.

Examples

Logging Configuration Template Examples

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

JSON

{
  "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": "firehose.amazonaws.com"
            },
            "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" }
        ]
      }
    }
  }
}

YAML

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: firehose.amazonaws.com
          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