flow_entitlements

Creates, updates, deletes or gets a flow_entitlement resource or lists flow_entitlements in a region

Overview

Name	flow_entitlements
Type	Resource
Description	Resource schema for AWS::MediaConnect::FlowEntitlement
Id	aws.mediaconnect.flow_entitlements

Fields

Name	Datatype	Description
flow_arn	string	The ARN of the flow.
entitlement_arn	string	The ARN of the entitlement.
data_transfer_subscriber_fee_percent	integer	Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
description	string	A description of the entitlement.
encryption	object	The type of encryption that will be used on the output that is associated with this entitlement.
entitlement_status	string	An indication of whether the entitlement is enabled.
name	string	The name of the entitlement.
subscribers	array	The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FlowArn, Name, Subscribers, Description, 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 flow_entitlements in a region.

SELECT
region,
flow_arn,
entitlement_arn,
data_transfer_subscriber_fee_percent,
description,
encryption,
entitlement_status,
name,
subscribers
FROM aws.mediaconnect.flow_entitlements
WHERE region = 'us-east-1';

Gets all properties from an individual flow_entitlement.

SELECT
region,
flow_arn,
entitlement_arn,
data_transfer_subscriber_fee_percent,
description,
encryption,
entitlement_status,
name,
subscribers
FROM aws.mediaconnect.flow_entitlements
WHERE region = 'us-east-1' AND data__Identifier = '<EntitlementArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.mediaconnect.flow_entitlements (
 FlowArn,
 Description,
 Name,
 Subscribers,
 region
)
SELECT 
'{{ FlowArn }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ Subscribers }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediaconnect.flow_entitlements (
 FlowArn,
 DataTransferSubscriberFeePercent,
 Description,
 Encryption,
 EntitlementStatus,
 Name,
 Subscribers,
 region
)
SELECT 
 '{{ FlowArn }}',
 '{{ DataTransferSubscriberFeePercent }}',
 '{{ Description }}',
 '{{ Encryption }}',
 '{{ EntitlementStatus }}',
 '{{ Name }}',
 '{{ Subscribers }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: flow_entitlement
    props:
      - name: FlowArn
        value: '{{ FlowArn }}'
      - name: DataTransferSubscriberFeePercent
        value: '{{ DataTransferSubscriberFeePercent }}'
      - name: Description
        value: '{{ Description }}'
      - name: Encryption
        value:
          Algorithm: '{{ Algorithm }}'
          ConstantInitializationVector: '{{ ConstantInitializationVector }}'
          DeviceId: '{{ DeviceId }}'
          KeyType: '{{ KeyType }}'
          Region: '{{ Region }}'
          ResourceId: '{{ ResourceId }}'
          RoleArn: '{{ RoleArn }}'
          SecretArn: '{{ SecretArn }}'
          Url: '{{ Url }}'
      - name: EntitlementStatus
        value: '{{ EntitlementStatus }}'
      - name: Name
        value: '{{ Name }}'
      - name: Subscribers
        value:
          - '{{ Subscribers[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.mediaconnect.flow_entitlements
WHERE data__Identifier = '<EntitlementArn>'
AND region = 'us-east-1';

Permissions

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

Create

iam:PassRole,
mediaconnect:GrantFlowEntitlements

Read

mediaconnect:DescribeFlow

Update

mediaconnect:DescribeFlow,
mediaconnect:UpdateFlowEntitlement

Delete

mediaconnect:DescribeFlow,
mediaconnect:RevokeFlowEntitlement

List

mediaconnect:DescribeFlow