AWS::MediaConnect::FlowEntitlement - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::MediaConnect::FlowEntitlement

The AWS::MediaConnect::FlowEntitlement resource defines the permission that an Amazon Web Services account grants to another Amazon Web Services account to allow access to the content in a specific Amazon Elemental MediaConnect flow. The content originator grants an entitlement to a specific Amazon Web Services account (the subscriber). When an entitlement is granted, the subscriber can create a flow using the originator's flow as the source. Each flow can have up to 50 entitlements.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MediaConnect::FlowEntitlement",
  "Properties" : {
      "DataTransferSubscriberFeePercent" : Integer,
      "Description" : String,
      "Encryption" : Encryption,
      "EntitlementStatus" : String,
      "FlowArn" : String,
      "Name" : String,
      "Subscribers" : [ String, ... ]
    }
}

YAML

Type: AWS::MediaConnect::FlowEntitlement
Properties:
  DataTransferSubscriberFeePercent: Integer
  Description: String
  Encryption: 
    Encryption
  EntitlementStatus: String
  FlowArn: String
  Name: String
  Subscribers: 
    - String

Properties

DataTransferSubscriberFeePercent

The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

Required: No

Type: Integer

Update requires: Replacement

Description

A description of the entitlement. This description appears only on the MediaConnect console and is not visible outside of the current Amazon account.

Required: Yes

Type: String

Update requires: No interruption

Encryption

The type of encryption that MediaConnect will use on the output that is associated with the entitlement.

Required: No

Type: Encryption

Update requires: No interruption

EntitlementStatus

An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

FlowArn

The Amazon Resource Name (ARN) of the flow.

Required: Yes

Type: String

Update requires: No interruption

Name

The name of the entitlement. This value must be unique within the current flow.

Required: Yes

Type: String

Update requires: Replacement

Subscribers

The Amazon account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.

Required: Yes

Type: Array of String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the entitlement ARN. For example:

{ "Ref": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

EntitlementArn

The entitlement ARN.