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	awscc.medialive.clusters

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	The unique ID of the Cluster.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	clusters	INSERT	region
delete_resource	clusters	DELETE	Identifier, region
update_resource	clusters	UPDATE	Identifier, PatchDocument, region
list_resources	clusters_list_only	SELECT	region
get_resource	clusters	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual cluster.

SELECT
  region,
  arn,
  channel_ids,
  cluster_type,
  id,
  instance_role_arn,
  name,
  network_settings,
  state,
  tags
FROM awscc.medialive.clusters
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all clusters in a region.

SELECT
  region,
  id
FROM awscc.medialive.clusters_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.medialive.clusters (
  ClusterType,
  InstanceRoleArn,
  Name,
  NetworkSettings,
  Tags,
  region
)
SELECT
  '{{ cluster_type }}',
  '{{ instance_role_arn }}',
  '{{ name }}',
  '{{ network_settings }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.medialive.clusters (
  ClusterType,
  InstanceRoleArn,
  Name,
  NetworkSettings,
  Tags,
  region
)
SELECT
  '{{ cluster_type }}',
  '{{ instance_role_arn }}',
  '{{ name }}',
  '{{ network_settings }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: cluster
  props:
    - name: cluster_type
      value: '{{ cluster_type }}'
    - name: instance_role_arn
      value: '{{ instance_role_arn }}'
    - name: name
      value: '{{ name }}'
    - name: network_settings
      value:
        default_route: '{{ default_route }}'
        interface_mappings:
          - logical_interface_name: '{{ logical_interface_name }}'
            network_id: '{{ network_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.medialive.clusters
SET PatchDocument = string('{{ {
    "Name": name,
    "NetworkSettings": network_settings,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.medialive.clusters
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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