clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	clusters
Type	Resource
Id	aws.medialive.clusters

Fields

The following fields are returned by SELECT queries:

describe_cluster

Name	Datatype	Description
arn	string	Placeholder documentation for __string
channel_ids	array	Placeholder documentation for __listOf__string
cluster_type	string	Used in CreateClusterSummary, DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult. (ON_PREMISES)
id	string	Placeholder documentation for __string
instance_role_arn	string	Placeholder documentation for __string
name	string	Placeholder documentation for __string
network_settings	object	Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
state	string	The current state of the Cluster. (CREATING, CREATE_FAILED, ACTIVE, DELETING, DELETE_FAILED, DELETED)

list_clusters

Name	Datatype	Description
arn	string	Placeholder documentation for __string
channel_ids	array	Placeholder documentation for __listOf__string
cluster_type	string	Used in CreateClusterSummary, DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult. (ON_PREMISES)
id	string	Placeholder documentation for __string
instance_role_arn	string	Placeholder documentation for __string
name	string	Placeholder documentation for __string
network_settings	object	Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
state	string	The current state of the Cluster. (CREATING, CREATE_FAILED, ACTIVE, DELETING, DELETE_FAILED, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster	select	cluster_id, region		Get details about a Cluster.
list_clusters	select	region	maxResults, nextToken	Retrieve the list of Clusters.
create_cluster	insert	region		Create a new Cluster.
update_cluster	update	cluster_id, region		Change the settings for a Cluster.
delete_cluster	delete	cluster_id, region		Delete a Cluster. The Cluster must be idle.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_id	string	The ID of the cluster.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of items to return.
nextToken	string	The token to retrieve the next page of results.

SELECT examples

describe_cluster

Get details about a Cluster.

SELECT
arn,
channel_ids,
cluster_type,
id,
instance_role_arn,
name,
network_settings,
state
FROM aws.medialive.clusters
WHERE cluster_id = '{{ cluster_id }}' -- required
AND region = '{{ region }}' -- required
;

list_clusters

Retrieve the list of Clusters.

SELECT
arn,
channel_ids,
cluster_type,
id,
instance_role_arn,
name,
network_settings,
state
FROM aws.medialive.clusters
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_cluster

Create a new Cluster.

INSERT INTO aws.medialive.clusters (
ClusterType,
InstanceRoleArn,
Name,
NetworkSettings,
RequestId,
Tags,
region
)
SELECT 
'{{ ClusterType }}',
'{{ InstanceRoleArn }}',
'{{ Name }}',
'{{ NetworkSettings }}',
'{{ RequestId }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
channel_ids,
cluster_type,
id,
instance_role_arn,
name,
network_settings,
state
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the clusters resource.
  - name: ClusterType
    value: "{{ ClusterType }}"
    description: |
      Used in CreateClusterSummary, DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult.
    valid_values: ['ON_PREMISES']
  - name: InstanceRoleArn
    value: "{{ InstanceRoleArn }}"
    description: |
      Placeholder documentation for __string
  - name: Name
    value: "{{ Name }}"
    description: |
      Placeholder documentation for __string
  - name: NetworkSettings
    description: |
      Used in a CreateClusterRequest.
    value:
      DefaultRoute: "{{ DefaultRoute }}"
      InterfaceMappings:
        - LogicalInterfaceName: "{{ LogicalInterfaceName }}"
          NetworkId: "{{ NetworkId }}"
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __string
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Placeholder documentation for Tags

UPDATE examples

update_cluster

Change the settings for a Cluster.

UPDATE aws.medialive.clusters
SET 
Name = '{{ Name }}',
NetworkSettings = '{{ NetworkSettings }}'
WHERE 
cluster_id = '{{ cluster_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
channel_ids,
cluster_type,
id,
name,
network_settings,
state;

DELETE examples

delete_cluster

Delete a Cluster. The Cluster must be idle.

DELETE FROM aws.medialive.clusters
WHERE cluster_id = '{{ cluster_id }}' --required
AND region = '{{ region }}' --required
;