This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::IVSChat::LoggingConfiguration
<a name="aws-resource-ivschat-loggingconfiguration"></a>

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](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_CreateLoggingConfiguration.html) in the *Amazon Interactive Video Service Chat API Reference*.

## Syntax
<a name="aws-resource-ivschat-loggingconfiguration-syntax"></a>

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

### JSON
<a name="aws-resource-ivschat-loggingconfiguration-syntax.json"></a>

```
{
  "Type" : "AWS::IVSChat::LoggingConfiguration",
  "Properties" : {
      "[DestinationConfiguration](#cfn-ivschat-loggingconfiguration-destinationconfiguration)" : DestinationConfiguration,
      "[Name](#cfn-ivschat-loggingconfiguration-name)" : String,
      "[Tags](#cfn-ivschat-loggingconfiguration-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-ivschat-loggingconfiguration-syntax.yaml"></a>

```
Type: AWS::IVSChat::LoggingConfiguration
Properties:
  [DestinationConfiguration](#cfn-ivschat-loggingconfiguration-destinationconfiguration): 
    DestinationConfiguration
  [Name](#cfn-ivschat-loggingconfiguration-name): String
  [Tags](#cfn-ivschat-loggingconfiguration-tags): 
    - Tag
```

## Properties
<a name="aws-resource-ivschat-loggingconfiguration-properties"></a>

`DestinationConfiguration`  <a name="cfn-ivschat-loggingconfiguration-destinationconfiguration"></a>
The DestinationConfiguration is a complex type that contains information about where chat content will be logged.  
*Required*: Yes  
*Type*: [DestinationConfiguration](aws-properties-ivschat-loggingconfiguration-destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-ivschat-loggingconfiguration-name"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-ivschat-loggingconfiguration-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-tag.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-ivschat-loggingconfiguration-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-ivschat-loggingconfiguration-return-values"></a>

### Ref
<a name="aws-resource-ivschat-loggingconfiguration-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-ivschat-loggingconfiguration-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-ivschat-loggingconfiguration-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The logging-configuration ARN. For example: `arn:aws:ivschat:us-west-2:123456789012:logging-configuration/abcdABCDefgh`

`Id`  <a name="Id-fn::getatt"></a>
The logging-configuration ID. For example: `abcdABCDefgh`

`State`  <a name="State-fn::getatt"></a>
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` \$1 `CREATE_FAILED` \$1 `DELETING` \$1 `DELETE_FAILED` \$1 `UPDATING` \$1 `UPDATE_FAILED` \$1 `ACTIVE`.

## Examples
<a name="aws-resource-ivschat-loggingconfiguration--examples"></a>



### Logging Configuration Template Examples
<a name="aws-resource-ivschat-loggingconfiguration--examples--Logging_Configuration_Template_Examples"></a>

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

#### JSON
<a name="aws-resource-ivschat-loggingconfiguration--examples--Logging_Configuration_Template_Examples--json"></a>

```
{
  "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
<a name="aws-resource-ivschat-loggingconfiguration--examples--Logging_Configuration_Template_Examples--yaml"></a>

```
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
<a name="aws-resource-ivschat-loggingconfiguration--seealso"></a>
+  [Getting Started with Amazon Interactive Video Service](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html) 
+ [LoggingConfigurationSummary](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_LoggingConfigurationSummary.html) API data type
+ [DestinationConfiguration](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_DestinationConfiguration.html) API data type
+ [CloudWatchLogsDestinationConfiguration](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_CloudWatchLogsDestinationConfiguration.html) API data type
+ [FirehoseDestinationConfiguration](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_FirehoseDestinationConfiguration.html) API data type
+ [S3DestinationConfiguration](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_S3DestinationConfiguration.html) API data type
+ [CreateLoggingConfiguration](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_CreateLoggingConfiguration.html) API endpoint

# AWS::IVSChat::LoggingConfiguration CloudWatchLogsDestinationConfiguration
<a name="aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration"></a>

The CloudWatchLogsDestinationConfiguration property type specifies a CloudWatch Logs location where chat logs will be stored.

## Syntax
<a name="aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-syntax.json"></a>

```
{
  "[LogGroupName](#cfn-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-loggroupname)" : String
}
```

### YAML
<a name="aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-syntax.yaml"></a>

```
  [LogGroupName](#cfn-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-loggroupname): String
```

## Properties
<a name="aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-properties"></a>

`LogGroupName`  <a name="cfn-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-loggroupname"></a>
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\.\-_/#A-Za-z0-9]+$`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVSChat::LoggingConfiguration DestinationConfiguration
<a name="aws-properties-ivschat-loggingconfiguration-destinationconfiguration"></a>

The DestinationConfiguration property type 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.

## Syntax
<a name="aws-properties-ivschat-loggingconfiguration-destinationconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-ivschat-loggingconfiguration-destinationconfiguration-syntax.json"></a>

```
{
  "[CloudWatchLogs](#cfn-ivschat-loggingconfiguration-destinationconfiguration-cloudwatchlogs)" : CloudWatchLogsDestinationConfiguration,
  "[Firehose](#cfn-ivschat-loggingconfiguration-destinationconfiguration-firehose)" : FirehoseDestinationConfiguration,
  "[S3](#cfn-ivschat-loggingconfiguration-destinationconfiguration-s3)" : S3DestinationConfiguration
}
```

### YAML
<a name="aws-properties-ivschat-loggingconfiguration-destinationconfiguration-syntax.yaml"></a>

```
  [CloudWatchLogs](#cfn-ivschat-loggingconfiguration-destinationconfiguration-cloudwatchlogs): 
    CloudWatchLogsDestinationConfiguration
  [Firehose](#cfn-ivschat-loggingconfiguration-destinationconfiguration-firehose): 
    FirehoseDestinationConfiguration
  [S3](#cfn-ivschat-loggingconfiguration-destinationconfiguration-s3): 
    S3DestinationConfiguration
```

## Properties
<a name="aws-properties-ivschat-loggingconfiguration-destinationconfiguration-properties"></a>

`CloudWatchLogs`  <a name="cfn-ivschat-loggingconfiguration-destinationconfiguration-cloudwatchlogs"></a>
An Amazon CloudWatch Logs destination configuration where chat activity will be logged.  
*Required*: No  
*Type*: [CloudWatchLogsDestinationConfiguration](aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Firehose`  <a name="cfn-ivschat-loggingconfiguration-destinationconfiguration-firehose"></a>
An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.  
*Required*: No  
*Type*: [FirehoseDestinationConfiguration](aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3`  <a name="cfn-ivschat-loggingconfiguration-destinationconfiguration-s3"></a>
An Amazon S3 destination configuration where chat activity will be logged.  
*Required*: No  
*Type*: [S3DestinationConfiguration](aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVSChat::LoggingConfiguration FirehoseDestinationConfiguration
<a name="aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration"></a>

The FirehoseDestinationConfiguration property type specifies a Kinesis Firehose location where chat logs will be stored.

## Syntax
<a name="aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration-syntax.json"></a>

```
{
  "[DeliveryStreamName](#cfn-ivschat-loggingconfiguration-firehosedestinationconfiguration-deliverystreamname)" : String
}
```

### YAML
<a name="aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration-syntax.yaml"></a>

```
  [DeliveryStreamName](#cfn-ivschat-loggingconfiguration-firehosedestinationconfiguration-deliverystreamname): String
```

## Properties
<a name="aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration-properties"></a>

`DeliveryStreamName`  <a name="cfn-ivschat-loggingconfiguration-firehosedestinationconfiguration-deliverystreamname"></a>
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_.-]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVSChat::LoggingConfiguration S3DestinationConfiguration
<a name="aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration"></a>

The S3DestinationConfiguration property type specifies an S3 location where chat logs will be stored.

## Syntax
<a name="aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration-syntax.json"></a>

```
{
  "[BucketName](#cfn-ivschat-loggingconfiguration-s3destinationconfiguration-bucketname)" : String
}
```

### YAML
<a name="aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration-syntax.yaml"></a>

```
  [BucketName](#cfn-ivschat-loggingconfiguration-s3destinationconfiguration-bucketname): String
```

## Properties
<a name="aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration-properties"></a>

`BucketName`  <a name="cfn-ivschat-loggingconfiguration-s3destinationconfiguration-bucketname"></a>
Name of the Amazon S3 bucket where chat activity will be logged.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-z0-9-.]+$`  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVSChat::LoggingConfiguration Tag
<a name="aws-properties-ivschat-loggingconfiguration-tag"></a>

A key-value pair that you can use to categorize and manage Amazon IVSChat LoggingConfigurations.

## Syntax
<a name="aws-properties-ivschat-loggingconfiguration-tag-syntax"></a>

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

### JSON
<a name="aws-properties-ivschat-loggingconfiguration-tag-syntax.json"></a>

```
{
  "[Key](#cfn-ivschat-loggingconfiguration-tag-key)" : String,
  "[Value](#cfn-ivschat-loggingconfiguration-tag-value)" : String
}
```

### YAML
<a name="aws-properties-ivschat-loggingconfiguration-tag-syntax.yaml"></a>

```
  [Key](#cfn-ivschat-loggingconfiguration-tag-key): String
  [Value](#cfn-ivschat-loggingconfiguration-tag-value): String
```

## Properties
<a name="aws-properties-ivschat-loggingconfiguration-tag-properties"></a>

`Key`  <a name="cfn-ivschat-loggingconfiguration-tag-key"></a>
One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-ivschat-loggingconfiguration-tag-value"></a>
The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor within a tag category (key).  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)