View a markdown version of this page

AWS::IVS::Composition PipConfiguration - AWS CloudFormation
SyntaxProperties

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.

AWS::IVS::Composition PipConfiguration

The PipConfiguration property type specifies Property description not available. for an AWS::IVS::Composition.

Syntax

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

JSON

{
  "FeaturedParticipantAttribute" : String,
  "GridGap" : Integer,
  "OmitStoppedVideo" : Boolean,
  "ParticipantOrderAttribute" : String,
  "PipBehavior" : String,
  "PipHeight" : Integer,
  "PipOffset" : Integer,
  "PipParticipantAttribute" : String,
  "PipPosition" : String,
  "PipWidth" : Integer,
  "VideoFillMode" : String
}

YAML

  FeaturedParticipantAttribute: String
  GridGap: Integer
  OmitStoppedVideo: Boolean
  ParticipantOrderAttribute: String
  PipBehavior: String
  PipHeight: Integer
  PipOffset: Integer
  PipParticipantAttribute: String
  PipPosition: String
  PipWidth: Integer
  VideoFillMode: String

Properties

FeaturedParticipantAttribute

Property description not available.

Required: No

Type: String

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

Minimum: 0

Maximum: 128

Update requires: Replacement

GridGap

Property description not available.

Required: No

Type: Integer

Minimum: 0

Update requires: Replacement

OmitStoppedVideo

Property description not available.

Required: No

Type: Boolean

Update requires: Replacement

ParticipantOrderAttribute

Property description not available.

Required: No

Type: String

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

Minimum: 0

Maximum: 128

Update requires: Replacement

PipBehavior

Property description not available.

Required: No

Type: String

Allowed values: STATIC | DYNAMIC

Update requires: Replacement

PipHeight

Property description not available.

Required: No

Type: Integer

Minimum: 1

Update requires: Replacement

PipOffset

Property description not available.

Required: No

Type: Integer

Minimum: 0

Update requires: Replacement

PipParticipantAttribute

Property description not available.

Required: No

Type: String

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

Minimum: 0

Maximum: 128

Update requires: Replacement

PipPosition

Property description not available.

Required: No

Type: String

Allowed values: TOP_LEFT | TOP_RIGHT | BOTTOM_LEFT | BOTTOM_RIGHT

Update requires: Replacement

PipWidth

Property description not available.

Required: No

Type: Integer

Minimum: 1

Update requires: Replacement

VideoFillMode

Property description not available.

Required: No

Type: String

Allowed values: FILL | COVER | CONTAIN

Update requires: Replacement