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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	A signal map's id.
identifier	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	signal_maps	INSERT	DiscoveryEntryPointArn, Name, region
delete_resource	signal_maps	DELETE	Identifier, region
update_resource	signal_maps	UPDATE	Identifier, PatchDocument, region
list_resources	signal_maps_list_only	SELECT	region
get_resource	signal_maps	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.medialive.signal_maps
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ identifier }}';

list (identifiers only)

Lists all signal_maps in a region.

SELECT
  region,
  identifier
FROM awscc.medialive.signal_maps_list_only
WHERE
  region = '{{ region }}';

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 awscc.medialive.signal_maps (
  DiscoveryEntryPointArn,
  Name,
  region
)
SELECT
  '{{ discovery_entry_point_arn }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.medialive.signal_maps (
  CloudWatchAlarmTemplateGroupIdentifiers,
  Description,
  DiscoveryEntryPointArn,
  EventBridgeRuleTemplateGroupIdentifiers,
  ForceRediscovery,
  Name,
  Tags,
  region
)
SELECT
  '{{ cloud_watch_alarm_template_group_identifiers }}',
  '{{ description }}',
  '{{ discovery_entry_point_arn }}',
  '{{ event_bridge_rule_template_group_identifiers }}',
  '{{ force_rediscovery }}',
  '{{ name }}',
  '{{ 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: signal_map
  props:
    - name: cloud_watch_alarm_template_group_identifiers
      value:
        - '{{ cloud_watch_alarm_template_group_identifiers[0] }}'
    - name: description
      value: '{{ description }}'
    - name: discovery_entry_point_arn
      value: '{{ discovery_entry_point_arn }}'
    - name: event_bridge_rule_template_group_identifiers
      value:
        - '{{ event_bridge_rule_template_group_identifiers[0] }}'
    - name: force_rediscovery
      value: '{{ force_rediscovery }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.medialive.signal_maps
SET PatchDocument = string('{{ {
    "CloudWatchAlarmTemplateGroupIdentifiers": cloud_watch_alarm_template_group_identifiers,
    "Description": description,
    "DiscoveryEntryPointArn": discovery_entry_point_arn,
    "EventBridgeRuleTemplateGroupIdentifiers": event_bridge_rule_template_group_identifiers,
    "ForceRediscovery": force_rediscovery,
    "Name": name
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ identifier }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.medialive.signal_maps
WHERE
  Identifier = '{{ identifier }}' 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 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