signal_maps

Creates, updates, deletes or gets a signal_map resource or lists signal_maps in a region

Overview

Name	signal_maps
Type	Resource
Description	Definition of AWS::MediaLive::SignalMap Resource Type
Id	aws.medialive.signal_maps

Fields

Name	Datatype	Description
arn	string	A signal map's ARN (Amazon Resource Name)
cloud_watch_alarm_template_group_identifiers	array
cloud_watch_alarm_template_group_ids	array
created_at	string
description	string	A resource's optional description.
discovery_entry_point_arn	string	A top-level supported AWS resource ARN to discovery a signal map from.
error_message	string	Error message associated with a failed creation or failed update attempt of a signal map.
event_bridge_rule_template_group_identifiers	array
event_bridge_rule_template_group_ids	array
failed_media_resource_map	object	A map representing an incomplete AWS media workflow as a graph.
force_rediscovery	boolean	If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.
id	string	A signal map's id.
identifier	string
last_discovered_at	string
last_successful_monitor_deployment	object	Represents the latest successful monitor deployment of a signal map.
media_resource_map	object	A map representing an AWS media workflow as a graph.
modified_at	string
monitor_changes_pending_deployment	boolean	If true, there are pending monitor changes for this signal map that can be deployed.
monitor_deployment	object	Represents the latest monitor deployment of a signal map.
name	string	A resource's name. Names must be unique within the scope of a resource type in a specific region.
status	string	A signal map's current status which is dependent on its lifecycle actions or associated jobs.
tags	object	Represents the tags associated with a resource.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DiscoveryEntryPointArn, Name, 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 signal_maps in a region.

SELECT
region,
arn,
cloud_watch_alarm_template_group_identifiers,
cloud_watch_alarm_template_group_ids,
created_at,
description,
discovery_entry_point_arn,
error_message,
event_bridge_rule_template_group_identifiers,
event_bridge_rule_template_group_ids,
failed_media_resource_map,
force_rediscovery,
id,
identifier,
last_discovered_at,
last_successful_monitor_deployment,
media_resource_map,
modified_at,
monitor_changes_pending_deployment,
monitor_deployment,
name,
status,
tags
FROM aws.medialive.signal_maps
WHERE region = 'us-east-1';

Gets all properties from an individual signal_map.

SELECT
region,
arn,
cloud_watch_alarm_template_group_identifiers,
cloud_watch_alarm_template_group_ids,
created_at,
description,
discovery_entry_point_arn,
error_message,
event_bridge_rule_template_group_identifiers,
event_bridge_rule_template_group_ids,
failed_media_resource_map,
force_rediscovery,
id,
identifier,
last_discovered_at,
last_successful_monitor_deployment,
media_resource_map,
modified_at,
monitor_changes_pending_deployment,
monitor_deployment,
name,
status,
tags
FROM aws.medialive.signal_maps
WHERE region = 'us-east-1' AND data__Identifier = '<Identifier>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.medialive.signal_maps (
 DiscoveryEntryPointArn,
 Name,
 region
)
SELECT 
'{{ DiscoveryEntryPointArn }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.medialive.signal_maps (
 CloudWatchAlarmTemplateGroupIdentifiers,
 Description,
 DiscoveryEntryPointArn,
 EventBridgeRuleTemplateGroupIdentifiers,
 ForceRediscovery,
 Name,
 Tags,
 region
)
SELECT 
 '{{ CloudWatchAlarmTemplateGroupIdentifiers }}',
 '{{ Description }}',
 '{{ DiscoveryEntryPointArn }}',
 '{{ EventBridgeRuleTemplateGroupIdentifiers }}',
 '{{ ForceRediscovery }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: signal_map
    props:
      - name: CloudWatchAlarmTemplateGroupIdentifiers
        value:
          - '{{ CloudWatchAlarmTemplateGroupIdentifiers[0] }}'
      - name: Description
        value: '{{ Description }}'
      - name: DiscoveryEntryPointArn
        value: '{{ DiscoveryEntryPointArn }}'
      - name: EventBridgeRuleTemplateGroupIdentifiers
        value:
          - '{{ EventBridgeRuleTemplateGroupIdentifiers[0] }}'
      - name: ForceRediscovery
        value: '{{ ForceRediscovery }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value: {}

DELETE example

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

Permissions

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

Create

medialive:CreateSignalMap,
medialive:GetSignalMap,
medialive:CreateTags,
medialive:DescribeChannel,
medialive:DescribeInput,
medialive:DescribeInputDevice,
medialive:DescribeInputSecurityGroup,
medialive:DescribeMultiplex,
medialive:DescribeMultiplexProgram,
medialive:ListChannels,
medialive:ListInputDevices,
medialive:ListInputSecurityGroups,
medialive:ListInputs,
medialive:ListMultiplexPrograms,
medialive:ListMultiplexes,
medialive:ListOfferings,
medialive:ListReservations,
medialive:ListTagsForResource,
cloudfront:ListDistributions,
cloudfront:GetDistribution,
ec2:DescribeNetworkInterfaces,
mediaconnect:ListEntitlements,
mediaconnect:ListFlows,
mediaconnect:ListOfferings,
mediaconnect:ListReservations,
mediaconnect:DescribeFlow,
mediapackage:ListChannels,
mediapackage:ListOriginEndpoints,
mediapackage:DescribeChannel,
mediapackage:DescribeOriginEndpoint,
mediapackagev2:ListChannelGroups,
mediapackagev2:ListChannels,
mediapackagev2:ListOriginEndpoints,
mediapackagev2:GetChannelGroup,
mediapackagev2:GetChannel,
mediapackagev2:GetOriginEndpoint,
tag:GetResources

Read

medialive:GetSignalMap,
tag:GetResources

Update

medialive:StartUpdateSignalMap,
medialive:GetSignalMap,
medialive:CreateTags,
medialive:DeleteTags,
medialive:DescribeChannel,
medialive:DescribeInput,
medialive:DescribeInputDevice,
medialive:DescribeInputSecurityGroup,
medialive:DescribeMultiplex,
medialive:DescribeMultiplexProgram,
medialive:ListChannels,
medialive:ListInputDevices,
medialive:ListInputSecurityGroups,
medialive:ListInputs,
medialive:ListMultiplexPrograms,
medialive:ListMultiplexes,
medialive:ListOfferings,
medialive:ListReservations,
medialive:ListTagsForResource,
cloudfront:ListDistributions,
cloudfront:GetDistribution,
ec2:DescribeNetworkInterfaces,
mediaconnect:ListEntitlements,
mediaconnect:ListFlows,
mediaconnect:ListOfferings,
mediaconnect:ListReservations,
mediaconnect:DescribeFlow,
mediapackage:ListChannels,
mediapackage:ListOriginEndpoints,
mediapackage:DescribeChannel,
mediapackage:DescribeOriginEndpoint,
mediapackagev2:ListChannelGroups,
mediapackagev2:ListChannels,
mediapackagev2:ListOriginEndpoints,
mediapackagev2:GetChannelGroup,
mediapackagev2:GetChannel,
mediapackagev2:GetOriginEndpoint,
tag:GetResources

Delete

medialive:GetSignalMap,
medialive:DeleteSignalMap

List

medialive:ListSignalMaps