interface FlowEntitlementProps
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.MediaConnect.Alpha.FlowEntitlementProps |
Go | github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2#FlowEntitlementProps |
Java | software.amazon.awscdk.services.mediaconnect.alpha.FlowEntitlementProps |
Python | aws_cdk.aws_mediaconnect_alpha.FlowEntitlementProps |
TypeScript (source) | @aws-cdk/aws-mediaconnect-alpha ยป FlowEntitlementProps |
Properties for the Flow entitlement.
Example
declare const stack: Stack;
declare const flow: Flow;
declare const role: iam.IRole;
declare const secret: secretsmanager.ISecret;
new FlowEntitlement(stack, 'MyEntitlement', {
flow,
subscribers: ['111122223333'],
description: 'Grant partner access to live feed',
encryption: {
role,
secret,
algorithm: EncryptionAlgorithm.AES256,
},
});
Properties
| Name | Type | Description |
|---|---|---|
| description | string | A description of the entitlement. |
| flow | IFlow | The flow to set the entitlement from. |
| subscribers | string[] | The AWS account IDs that you want to share your content with. |
| data | number | The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for. |
| encryption? | Static | Options for encrypting the entitlement. |
| entitlement | Entitlement | An indication of whether the new entitlement should be enabled or disabled as soon as it is created. |
| flow | string | The name of the entitlement. |
description
Type:
string
A description of the entitlement.
This description appears only on the MediaConnect console and is not visible outside of the current AWS account.
flow
Type:
IFlow
The flow to set the entitlement from.
subscribers
Type:
string[]
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.
dataTransferSubscriberFeePercent?
Type:
number
(optional, default: the MediaConnect service default)
The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
encryption?
Type:
Static
(optional, default: no encryption)
Options for encrypting the entitlement.
Only static key encryption is supported for entitlements.
entitlementStatus?
Type:
Entitlement
(optional, default: undefined; when omitted, MediaConnect enables the entitlement (ENABLED) at deploy time)
An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
flowEntitlementName?
Type:
string
(optional, default: autogenerated)
The name of the entitlement.
This value must be unique within the current flow.

.NET
Go
Java
Python
TypeScript (