source_locations

Creates, updates, deletes or gets a source_location resource or lists source_locations in a region

Overview

Name	source_locations
Type	Resource
Description	Definition of AWS::MediaTailor::SourceLocation Resource Type
Id	awscc.mediatailor.source_locations

Fields

get (all properties)

Name	Datatype	Description
▶access_configuration	object	Access configuration parameters.
arn	string	The ARN of the source location.
▶default_segment_delivery_configuration	object	The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.
▶http_configuration	object	The HTTP configuration for the source location.
▶segment_delivery_configurations	array	A list of the segment delivery configurations associated with this resource.
source_location_name	string
▶tags	array	The tags to assign to the source location.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
source_location_name	string
region	string	AWS region.

For more information, see AWS::MediaTailor::SourceLocation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	source_locations	INSERT	HttpConfiguration, SourceLocationName, region
delete_resource	source_locations	DELETE	Identifier, region
update_resource	source_locations	UPDATE	Identifier, PatchDocument, region
list_resources	source_locations_list_only	SELECT	region
get_resource	source_locations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual source_location.

SELECT
  region,
  access_configuration,
  arn,
  default_segment_delivery_configuration,
  http_configuration,
  segment_delivery_configurations,
  source_location_name,
  tags
FROM awscc.mediatailor.source_locations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ source_location_name }}';

list (identifiers only)

Lists all source_locations in a region.

SELECT
  region,
  source_location_name
FROM awscc.mediatailor.source_locations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.mediatailor.source_locations (
  HttpConfiguration,
  SourceLocationName,
  region
)
SELECT
  '{{ http_configuration }}',
  '{{ source_location_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.mediatailor.source_locations (
  AccessConfiguration,
  DefaultSegmentDeliveryConfiguration,
  HttpConfiguration,
  SegmentDeliveryConfigurations,
  SourceLocationName,
  Tags,
  region
)
SELECT
  '{{ access_configuration }}',
  '{{ default_segment_delivery_configuration }}',
  '{{ http_configuration }}',
  '{{ segment_delivery_configurations }}',
  '{{ source_location_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: source_location
  props:
    - name: access_configuration
      value:
        access_type: '{{ access_type }}'
        secrets_manager_access_token_configuration:
          header_name: '{{ header_name }}'
          secret_arn: '{{ secret_arn }}'
          secret_string_key: '{{ secret_string_key }}'
    - name: default_segment_delivery_configuration
      value:
        base_url: '{{ base_url }}'
    - name: http_configuration
      value:
        base_url: '{{ base_url }}'
    - name: segment_delivery_configurations
      value:
        - base_url: '{{ base_url }}'
          name: '{{ name }}'
    - name: source_location_name
      value: '{{ source_location_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mediatailor.source_locations
SET PatchDocument = string('{{ {
    "AccessConfiguration": access_configuration,
    "DefaultSegmentDeliveryConfiguration": default_segment_delivery_configuration,
    "HttpConfiguration": http_configuration,
    "SegmentDeliveryConfigurations": segment_delivery_configurations,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ source_location_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.mediatailor.source_locations
WHERE
  Identifier = '{{ source_location_name }}' 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 source_locations resource, the following permissions are required:

Create

mediatailor:CreateSourceLocation,
mediatailor:DescribeSourceLocation,
mediatailor:TagResource,
secretsmanager:DescribeSecret,
secretsmanager:GetSecretValue,
kms:CreateGrant

Read

mediatailor:DescribeSourceLocation

Update

mediatailor:DescribeSourceLocation,
mediatailor:TagResource,
mediatailor:UntagResource,
mediatailor:UpdateSourceLocation,
secretsmanager:DescribeSecret,
secretsmanager:GetSecretValue,
kms:CreateGrant

Delete

mediatailor:DeleteSourceLocation,
mediatailor:DescribeSourceLocation

List

mediatailor:ListSourceLocations