Skip to content
v2.274.0

CfnFlowEntitlementProps Struct ​

Properties for defining a CfnFlowEntitlement.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediaconnect as mediaconnect } from 'aws-cdk-lib';
const cfnFlowEntitlementProps: mediaconnect.CfnFlowEntitlementProps = {
  description: 'description',
  flowArn: 'flowArn',
  name: 'name',
  subscribers: ['subscribers'],

  // the properties below are optional
  dataTransferSubscriberFeePercent: 123,
  encryption: {
    algorithm: 'algorithm',
    roleArn: 'roleArn',

    // the properties below are optional
    constantInitializationVector: 'constantInitializationVector',
    deviceId: 'deviceId',
    keyType: 'keyType',
    region: 'region',
    resourceId: 'resourceId',
    secretArn: 'secretArn',
    url: 'url',
  },
  entitlementStatus: 'entitlementStatus',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

dataTransferSubscriberFeePercentoptionalnumberdata_transfer_subscriber_fee_percentoptionalint | floatdataTransferSubscriberFeePercentoptionalNumberDataTransferSubscriberFeePercentoptionaldoubleDataTransferSubscriberFeePercentoptional*float64= 0#
The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*stringrequired#
A description of the entitlement.

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

encryptionoptionalIResolvable | CfnFlowEntitlement.EncryptionPropertyencryptionoptionaltyping.Union[IResolvable, EncryptionProperty]encryptionoptionalIResolvableEncryptionoptionalIResolvableEncryptionoptionalinterface{}#
Encryption information.
entitlementStatusoptionalstringentitlement_statusoptionalstrentitlementStatusoptionalStringEntitlementStatusoptionalstringEntitlementStatusoptional*string#
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.

flowArnstringflow_arnstrflowArnStringFlowArnstringFlowArn*stringrequired#
The Amazon Resource Name (ARN) of the flow.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the entitlement.

This value must be unique within the current flow.

subscribersstring[]subscriberstyping.List[str]subscribersList<String>Subscribersstring[]Subscribers*[]*stringrequired#
The AWS 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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Key-value pairs that can be used to tag and organize this flow entitlement.