signal_maps

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

Overview

Name	signal_maps
Type	Resource
Id	aws.medialive.signal_maps

Fields

The following fields are returned by SELECT queries:

get_signal_map

Name	Datatype	Description
arn	string	A signal map's ARN (Amazon Resource Name)
cloud_watch_alarm_template_group_ids	array	Placeholder documentation for __listOf__stringMin7Max11PatternAws097
created_at	string (date-time)	Placeholder documentation for __timestampIso8601
description	string	Placeholder documentation for __stringMin0Max1024
discovery_entry_point_arn	string	Placeholder documentation for __stringMin1Max2048
error_message	string	Placeholder documentation for __stringMin1Max2048
event_bridge_rule_template_group_ids	array	Placeholder documentation for __listOf__stringMin7Max11PatternAws097
failed_media_resource_map	object
id	string	Placeholder documentation for __stringMin7Max11PatternAws097
last_discovered_at	string (date-time)	Placeholder documentation for __timestampIso8601
last_successful_monitor_deployment	object	Represents the latest successful monitor deployment of a signal map.
media_resource_map	object
modified_at	string (date-time)	Placeholder documentation for __timestampIso8601
monitor_changes_pending_deployment	boolean	Placeholder documentation for __boolean
monitor_deployment	object	Represents the latest monitor deployment of a signal map.
name	string	Placeholder documentation for __stringMin1Max255PatternS
status	string	A signal map's current status which is dependent on its lifecycle actions or associated jobs. (CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_REVERTED, UPDATE_FAILED, READY, NOT_READY)
tags	object

list_signal_maps

Name	Datatype	Description
arn	string	A signal map's ARN (Amazon Resource Name)
created_at	string (date-time)	Placeholder documentation for __timestampIso8601
description	string	Placeholder documentation for __stringMin0Max1024
id	string	Placeholder documentation for __stringMin7Max11PatternAws097
modified_at	string (date-time)	Placeholder documentation for __timestampIso8601
monitor_deployment_status	string	A signal map's monitor deployment status. (NOT_DEPLOYED, DRY_RUN_DEPLOYMENT_COMPLETE, DRY_RUN_DEPLOYMENT_FAILED, DRY_RUN_DEPLOYMENT_IN_PROGRESS, DEPLOYMENT_COMPLETE, DEPLOYMENT_FAILED, DEPLOYMENT_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED, DELETE_IN_PROGRESS)
name	string	Placeholder documentation for __stringMin1Max255PatternS
status	string	A signal map's current status which is dependent on its lifecycle actions or associated jobs. (CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_REVERTED, UPDATE_FAILED, READY, NOT_READY)
tags	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_signal_map	select	identifier, region		Retrieves the specified signal map.
list_signal_maps	select	region	cloudWatchAlarmTemplateGroupIdentifier, eventBridgeRuleTemplateGroupIdentifier, maxResults, nextToken	Lists signal maps.
create_signal_map	insert	region, DiscoveryEntryPointArn		Initiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.
delete_signal_map	delete	identifier, region		Deletes the specified signal map.

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
identifier	string	A signal map's identifier. Can be either be its id or current name.
region	string	AWS region (default: us-east-1)
cloudWatchAlarmTemplateGroupIdentifier	string	A cloudwatch alarm template group's identifier. Can be either be its id or current name.
eventBridgeRuleTemplateGroupIdentifier	string	An eventbridge rule template group's identifier. Can be either be its id or current name.
maxResults	integer
nextToken	string	A token used to retrieve the next set of results in paginated list responses.

SELECT examples

get_signal_map

Retrieves the specified signal map.

SELECT
arn,
cloud_watch_alarm_template_group_ids,
created_at,
description,
discovery_entry_point_arn,
error_message,
event_bridge_rule_template_group_ids,
failed_media_resource_map,
id,
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 identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_signal_maps

Lists signal maps.

SELECT
arn,
created_at,
description,
id,
modified_at,
monitor_deployment_status,
name,
status,
tags
FROM aws.medialive.signal_maps
WHERE region = '{{ region }}' -- required
AND cloudWatchAlarmTemplateGroupIdentifier = '{{ cloudWatchAlarmTemplateGroupIdentifier }}'
AND eventBridgeRuleTemplateGroupIdentifier = '{{ eventBridgeRuleTemplateGroupIdentifier }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_signal_map

Initiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.

INSERT INTO aws.medialive.signal_maps (
CloudWatchAlarmTemplateGroupIdentifiers,
Description,
DiscoveryEntryPointArn,
EventBridgeRuleTemplateGroupIdentifiers,
Name,
Tags,
RequestId,
region
)
SELECT 
'{{ CloudWatchAlarmTemplateGroupIdentifiers }}',
'{{ Description }}',
'{{ DiscoveryEntryPointArn }}' /* required */,
'{{ EventBridgeRuleTemplateGroupIdentifiers }}',
'{{ Name }}',
'{{ Tags }}',
'{{ RequestId }}',
'{{ region }}'
RETURNING
arn,
cloud_watch_alarm_template_group_ids,
created_at,
description,
discovery_entry_point_arn,
error_message,
event_bridge_rule_template_group_ids,
failed_media_resource_map,
id,
last_discovered_at,
last_successful_monitor_deployment,
media_resource_map,
modified_at,
monitor_changes_pending_deployment,
monitor_deployment,
name,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: signal_maps
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the signal_maps resource.
  - name: CloudWatchAlarmTemplateGroupIdentifiers
    value:
      - "{{ CloudWatchAlarmTemplateGroupIdentifiers }}"
    description: |
      Placeholder documentation for __listOf__stringPatternS
  - name: Description
    value: "{{ Description }}"
    description: |
      Placeholder documentation for __stringMin0Max1024
  - name: DiscoveryEntryPointArn
    value: "{{ DiscoveryEntryPointArn }}"
    description: |
      Placeholder documentation for __stringMin1Max2048
  - name: EventBridgeRuleTemplateGroupIdentifiers
    value:
      - "{{ EventBridgeRuleTemplateGroupIdentifiers }}"
    description: |
      Placeholder documentation for __listOf__stringPatternS
  - name: Name
    value: "{{ Name }}"
    description: |
      Placeholder documentation for __stringMin1Max255PatternS
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Represents the tags associated with a resource.
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __stringMin1Max256PatternS

DELETE examples

delete_signal_map

Deletes the specified signal map.

DELETE FROM aws.medialive.signal_maps
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;