clusters

Creates, updates, deletes or gets a cluster resource or lists clusters in a region

Overview

Name	clusters
Type	Resource
Description	Definition of AWS::MediaLive::Cluster Resource Type
Id	aws.medialive.clusters

Fields

Name	Datatype	Description
arn	string	The ARN of the Cluster.
channel_ids	array	The MediaLive Channels that are currently running on Nodes in this Cluster.
cluster_type	string	The hardware type for the cluster.
id	string	The unique ID of the Cluster.
instance_role_arn	string	The IAM role your nodes will use.
name	string	The user-specified name of the Cluster to be created.
network_settings	object	On premises settings which will have the interface network mappings and default Output logical interface
state	string	The current state of the Cluster.
tags	array	A collection of key-value pairs.
region	string	AWS region.

For more information, see AWS::MediaLive::Cluster.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all clusters in a region.

SELECT
region,
arn,
channel_ids,
cluster_type,
id,
instance_role_arn,
name,
network_settings,
state,
tags
FROM aws.medialive.clusters
WHERE region = 'us-east-1';

Gets all properties from an individual cluster.

SELECT
region,
arn,
channel_ids,
cluster_type,
id,
instance_role_arn,
name,
network_settings,
state,
tags
FROM aws.medialive.clusters
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new cluster resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.medialive.clusters (
 ClusterType,
 InstanceRoleArn,
 Name,
 NetworkSettings,
 Tags,
 region
)
SELECT 
'{{ ClusterType }}',
 '{{ InstanceRoleArn }}',
 '{{ Name }}',
 '{{ NetworkSettings }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.medialive.clusters (
 ClusterType,
 InstanceRoleArn,
 Name,
 NetworkSettings,
 Tags,
 region
)
SELECT 
 '{{ ClusterType }}',
 '{{ InstanceRoleArn }}',
 '{{ Name }}',
 '{{ NetworkSettings }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cluster
    props:
      - name: ClusterType
        value: '{{ ClusterType }}'
      - name: InstanceRoleArn
        value: '{{ InstanceRoleArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: NetworkSettings
        value:
          DefaultRoute: '{{ DefaultRoute }}'
          InterfaceMappings:
            - LogicalInterfaceName: '{{ LogicalInterfaceName }}'
              NetworkId: '{{ NetworkId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.medialive.clusters
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the clusters resource, the following permissions are required:

Create

medialive:CreateCluster,
medialive:DescribeCluster,
medialive:CreateTags,
ecs:CreateCluster,
ecs:RegisterTaskDefinition,
ecs:TagResource,
ecs:CreateService,
iam:PassRole,
medialive:ListTagsForResource

Read

medialive:DescribeCluster,
medialive:ListTagsForResource

Update

medialive:UpdateCluster,
medialive:DescribeCluster,
medialive:CreateTags,
medialive:DeleteTags,
medialive:ListTagsForResource

Delete

medialive:DeleteCluster,
medialive:DescribeCluster,
ecs:DeleteService

List

medialive:ListClusters