

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::IVS::Composition PipConfiguration
<a name="aws-properties-ivs-composition-pipconfiguration"></a>

<a name="aws-properties-ivs-composition-pipconfiguration-description"></a>The `PipConfiguration` property type specifies Property description not available. for an [AWS::IVS::Composition](aws-resource-ivs-composition.md).

## Syntax
<a name="aws-properties-ivs-composition-pipconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-ivs-composition-pipconfiguration-syntax.json"></a>

```
{
  "[FeaturedParticipantAttribute](#cfn-ivs-composition-pipconfiguration-featuredparticipantattribute)" : {{String}},
  "[GridGap](#cfn-ivs-composition-pipconfiguration-gridgap)" : {{Integer}},
  "[OmitStoppedVideo](#cfn-ivs-composition-pipconfiguration-omitstoppedvideo)" : {{Boolean}},
  "[ParticipantOrderAttribute](#cfn-ivs-composition-pipconfiguration-participantorderattribute)" : {{String}},
  "[PipBehavior](#cfn-ivs-composition-pipconfiguration-pipbehavior)" : {{String}},
  "[PipHeight](#cfn-ivs-composition-pipconfiguration-pipheight)" : {{Integer}},
  "[PipOffset](#cfn-ivs-composition-pipconfiguration-pipoffset)" : {{Integer}},
  "[PipParticipantAttribute](#cfn-ivs-composition-pipconfiguration-pipparticipantattribute)" : {{String}},
  "[PipPosition](#cfn-ivs-composition-pipconfiguration-pipposition)" : {{String}},
  "[PipWidth](#cfn-ivs-composition-pipconfiguration-pipwidth)" : {{Integer}},
  "[VideoFillMode](#cfn-ivs-composition-pipconfiguration-videofillmode)" : {{String}}
}
```

### YAML
<a name="aws-properties-ivs-composition-pipconfiguration-syntax.yaml"></a>

```
  [FeaturedParticipantAttribute](#cfn-ivs-composition-pipconfiguration-featuredparticipantattribute): {{String}}
  [GridGap](#cfn-ivs-composition-pipconfiguration-gridgap): {{Integer}}
  [OmitStoppedVideo](#cfn-ivs-composition-pipconfiguration-omitstoppedvideo): {{Boolean}}
  [ParticipantOrderAttribute](#cfn-ivs-composition-pipconfiguration-participantorderattribute): {{String}}
  [PipBehavior](#cfn-ivs-composition-pipconfiguration-pipbehavior): {{String}}
  [PipHeight](#cfn-ivs-composition-pipconfiguration-pipheight): {{Integer}}
  [PipOffset](#cfn-ivs-composition-pipconfiguration-pipoffset): {{Integer}}
  [PipParticipantAttribute](#cfn-ivs-composition-pipconfiguration-pipparticipantattribute): {{String}}
  [PipPosition](#cfn-ivs-composition-pipconfiguration-pipposition): {{String}}
  [PipWidth](#cfn-ivs-composition-pipconfiguration-pipwidth): {{Integer}}
  [VideoFillMode](#cfn-ivs-composition-pipconfiguration-videofillmode): {{String}}
```

## Properties
<a name="aws-properties-ivs-composition-pipconfiguration-properties"></a>

`FeaturedParticipantAttribute`  <a name="cfn-ivs-composition-pipconfiguration-featuredparticipantattribute"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_]*$`  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`GridGap`  <a name="cfn-ivs-composition-pipconfiguration-gridgap"></a>
Property description not available.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`OmitStoppedVideo`  <a name="cfn-ivs-composition-pipconfiguration-omitstoppedvideo"></a>
Property description not available.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ParticipantOrderAttribute`  <a name="cfn-ivs-composition-pipconfiguration-participantorderattribute"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_]*$`  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PipBehavior`  <a name="cfn-ivs-composition-pipconfiguration-pipbehavior"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `STATIC | DYNAMIC`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PipHeight`  <a name="cfn-ivs-composition-pipconfiguration-pipheight"></a>
Property description not available.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PipOffset`  <a name="cfn-ivs-composition-pipconfiguration-pipoffset"></a>
Property description not available.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PipParticipantAttribute`  <a name="cfn-ivs-composition-pipconfiguration-pipparticipantattribute"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_]*$`  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PipPosition`  <a name="cfn-ivs-composition-pipconfiguration-pipposition"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `TOP_LEFT | TOP_RIGHT | BOTTOM_LEFT | BOTTOM_RIGHT`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PipWidth`  <a name="cfn-ivs-composition-pipconfiguration-pipwidth"></a>
Property description not available.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VideoFillMode`  <a name="cfn-ivs-composition-pipconfiguration-videofillmode"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `FILL | COVER | CONTAIN`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)