---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_ivs_composition{% #aws_ivs_composition %}

## `account_id`{% #account_id %}

**Type**: `STRING`

## `arn`{% #arn %}

**Type**: `STRING`**Provider name**: `arn`**Description**: ARN of the Composition resource.

## `destinations`{% #destinations %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `destinations`**Description**: Array of Destination objects. A Composition can contain either one destination (`channel` or `s3`) or two (one `channel` and one `s3`).

- `configuration`**Type**: `STRUCT`**Provider name**: `configuration`**Description**: Configuration used to create this destination.
  - `channel`**Type**: `STRUCT`**Provider name**: `channel`**Description**: An IVS channel to be used for broadcasting, for server-side composition. Either a `channel` or an `s3` must be specified.
    - `channel_arn`**Type**: `STRING`**Provider name**: `channelArn`**Description**: ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).
    - `encoder_configuration_arn`**Type**: `STRING`**Provider name**: `encoderConfigurationArn`**Description**: ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
  - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name that can be specified to help identify the destination.
  - `s3`**Type**: `STRUCT`**Provider name**: `s3`**Description**: An S3 storage configuration to be used for recording video data. Either a `channel` or an `s3` must be specified.
    - `encoder_configuration_arns`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `encoderConfigurationArns`**Description**: ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
    - `recording_configuration`**Type**: `STRUCT`**Provider name**: `recordingConfiguration`**Description**: Array of maps, each of the form `string:string (key:value)`. This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.
      - `format`**Type**: `STRING`**Provider name**: `format`**Description**: The recording format for storing a recording in Amazon S3.
      - `hls_configuration`**Type**: `STRUCT`**Provider name**: `hlsConfiguration`**Description**: An HLS configuration object to return information about how the recording will be configured.
        - `target_segment_duration_seconds`**Type**: `INT32`**Provider name**: `targetSegmentDurationSeconds`**Description**: Defines the target duration for recorded segments generated when using composite recording. Segments may have durations shorter than the specified value when needed to ensure each segment begins with a keyframe. Default: 2.
    - `storage_configuration_arn`**Type**: `STRING`**Provider name**: `storageConfigurationArn`**Description**: ARN of the StorageConfiguration where recorded videos will be stored.
    - `thumbnail_configurations`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `thumbnailConfigurations`**Description**: A complex type that allows you to enable/disable the recording of thumbnails for a Composition and modify the interval at which thumbnails are generated for the live session.
      - `storage`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `storage`**Description**: Indicates the format in which thumbnails are recorded. `SEQUENTIAL` records all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail. `LATEST` saves the latest thumbnail in media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified by `targetIntervalSeconds`. You can enable both `SEQUENTIAL` and `LATEST`. Default: `SEQUENTIAL`.
      - `target_interval_seconds`**Type**: `INT32`**Provider name**: `targetIntervalSeconds`**Description**: The targeted thumbnail-generation interval in seconds. Default: 60.
- `detail`**Type**: `STRUCT`**Provider name**: `detail`**Description**: Optional details regarding the status of the destination.
  - `s3`**Type**: `STRUCT`**Provider name**: `s3`**Description**: An S3 detail object to return information about the S3 destination.
    - `recording_prefix`**Type**: `STRING`**Provider name**: `recordingPrefix`**Description**: The S3 bucket prefix under which the recording is stored.
- `end_time`**Type**: `TIMESTAMP`**Provider name**: `endTime`**Description**: UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
- `id`**Type**: `STRING`**Provider name**: `id`**Description**: Unique identifier for this destination, assigned by IVS.
- `start_time`**Type**: `TIMESTAMP`**Provider name**: `startTime`**Description**: UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
- `state`**Type**: `STRING`**Provider name**: `state`**Description**: State of the Composition Destination.

## `end_time`{% #end_time %}

**Type**: `TIMESTAMP`**Provider name**: `endTime`**Description**: UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

## `layout`{% #layout %}

**Type**: `STRUCT`**Provider name**: `layout`**Description**: Layout object to configure composition parameters.

- `grid`**Type**: `STRUCT`**Provider name**: `grid`**Description**: Configuration related to grid layout. Default: Grid layout.
  - `featured_participant_attribute`**Type**: `STRING`**Provider name**: `featuredParticipantAttribute`**Description**: This attribute name identifies the featured slot. A participant with this attribute set to `"true"` (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: `""` (no featured participant).
  - `grid_gap`**Type**: `INT32`**Provider name**: `gridGap`**Description**: Specifies the spacing between participant tiles in pixels. Default: `2`.
  - `omit_stopped_video`**Type**: `BOOLEAN`**Provider name**: `omitStoppedVideo`**Description**: Determines whether to omit participants with stopped video in the composition. Default: `false`.
  - `video_aspect_ratio`**Type**: `STRING`**Provider name**: `videoAspectRatio`**Description**: Sets the non-featured participant display mode, to control the aspect ratio of video tiles. `VIDEO` is 16:9, `SQUARE` is 1:1, and `PORTRAIT` is 3:4. Default: `VIDEO`.
  - `video_fill_mode`**Type**: `STRING`**Provider name**: `videoFillMode`**Description**: Defines how video content fits within the participant tile: `FILL` (stretched), `COVER` (cropped), or `CONTAIN` (letterboxed). When not set, `videoFillMode` defaults to `COVER` fill mode for participants in the grid and to `CONTAIN` fill mode for featured participants.
- `pip`**Type**: `STRUCT`**Provider name**: `pip`**Description**: Configuration related to PiP layout.
  - `featured_participant_attribute`**Type**: `STRING`**Provider name**: `featuredParticipantAttribute`**Description**: This attribute name identifies the featured slot. A participant with this attribute set to `"true"` (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: `""` (no featured participant).
  - `grid_gap`**Type**: `INT32`**Provider name**: `gridGap`**Description**: Specifies the spacing between participant tiles in pixels. Default: `0`.
  - `omit_stopped_video`**Type**: `BOOLEAN`**Provider name**: `omitStoppedVideo`**Description**: Determines whether to omit participants with stopped video in the composition. Default: `false`.
  - `pip_behavior`**Type**: `STRING`**Provider name**: `pipBehavior`**Description**: Defines PiP behavior when all participants have left: `STATIC` (maintains original position/size) or `DYNAMIC` (expands to full composition). Default: `STATIC`.
  - `pip_height`**Type**: `INT32`**Provider name**: `pipHeight`**Description**: Specifies the height of the PiP window in pixels. When this is not set explicitly, `pipHeight`'s value will be based on the size of the composition and the aspect ratio of the participant's video.
  - `pip_offset`**Type**: `INT32`**Provider name**: `pipOffset`**Description**: Sets the PiP window's offset position in pixels from the closest edges determined by `PipPosition`. Default: `0`.
  - `pip_participant_attribute`**Type**: `STRING`**Provider name**: `pipParticipantAttribute`**Description**: Specifies the participant for the PiP window. A participant with this attribute set to `"true"` (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: `""` (no PiP participant).
  - `pip_position`**Type**: `STRING`**Provider name**: `pipPosition`**Description**: Determines the corner position of the PiP window. Default: `BOTTOM_RIGHT`.
  - `pip_width`**Type**: `INT32`**Provider name**: `pipWidth`**Description**: Specifies the width of the PiP window in pixels. When this is not set explicitly, `pipWidth`'s value will be based on the size of the composition and the aspect ratio of the participant's video.
  - `video_fill_mode`**Type**: `STRING`**Provider name**: `videoFillMode`**Description**: Defines how video content fits within the participant tile: `FILL` (stretched), `COVER` (cropped), or `CONTAIN` (letterboxed). Default: `COVER`.

## `stage_arn`{% #stage_arn %}

**Type**: `STRING`**Provider name**: `stageArn`**Description**: ARN of the stage used as input

## `start_time`{% #start_time %}

**Type**: `TIMESTAMP`**Provider name**: `startTime`**Description**: UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: State of the Composition.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`