View a markdown version of this page

AWS::MediaLive::ChannelPlacementGroup - AWS CloudFormation
SyntaxPropertiesReturn values

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::MediaLive::ChannelPlacementGroup

Creates a channel placement group in a cluster. A channel placement group lets you control which cluster nodes run specific channels.

Syntax

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

JSON

{
  "Type" : "AWS::MediaLive::ChannelPlacementGroup",
  "Properties" : {
      "ClusterId" : String,
      "Name" : String,
      "Nodes" : [ String, ... ],
      "Tags" : [ Tags, ... ]
    }
}

YAML

Type: AWS::MediaLive::ChannelPlacementGroup
Properties:
  ClusterId: String
  Name: String
  Nodes: 
    - String
  Tags: 
    - Tags

Properties

ClusterId

The ID of the cluster the channel placement group belongs to.

Required: No

Type: String

Update requires: Replacement

Name

The name of the channel placement group.

Required: No

Type: String

Update requires: No interruption

Nodes

List of nodes added to the channel placement group.

Required: No

Type: Array of String

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tags

Update requires: No interruption

Return values

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 ARN of the channel placement group.

Channels

List of channel IDs added to the channel placement group.

Id

The unique identifier of the channel placement group.

State

The current state of the channel placement group.