AWS::MediaLive::Cluster - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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::Cluster

Creates a cluster. A cluster is a group of nodes that work together to run MediaLive channels on your own hardware.

Syntax

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

JSON

{
  "Type" : "AWS::MediaLive::Cluster",
  "Properties" : {
      "ClusterType" : String,
      "InstanceRoleArn" : String,
      "Name" : String,
      "NetworkSettings" : ClusterNetworkSettings,
      "Tags" : [ Tags, ... ]
    }
}

YAML

Type: AWS::MediaLive::Cluster
Properties:
  ClusterType: String
  InstanceRoleArn: String
  Name: String
  NetworkSettings: 
    ClusterNetworkSettings
  Tags: 
    - Tags

Properties

ClusterType

The hardware type for the cluster.

Required: No

Type: String

Allowed values: ON_PREMISES | OUTPOSTS_RACK | OUTPOSTS_SERVER | EC2

Update requires: Replacement

InstanceRoleArn

The IAM role your nodes will use.

Required: No

Type: String

Pattern: ^arn:.+:iam:.+:role/.+$

Update requires: Replacement

Name

The user-specified name of the cluster.

Required: No

Type: String

Update requires: No interruption

NetworkSettings

On-premises network settings for the cluster.

Required: No

Type: ClusterNetworkSettings

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 cluster.

ChannelIds

The MediaLive channels that are currently running on nodes in this cluster.

Id

The unique ID of the cluster.

State

The current state of the cluster.