class FlowEntitlement (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaConnect.Alpha.FlowEntitlement
Go	github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2#FlowEntitlement
Java	software.amazon.awscdk.services.mediaconnect.alpha.FlowEntitlement
Python	aws_cdk.aws_mediaconnect_alpha.FlowEntitlement
TypeScript (source)	@aws-cdk/aws-mediaconnect-alpha » FlowEntitlement

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IFlowEntitlement, IFlowEntitlementRef

Resource defines the permission that an AWS account grants to another AWS account to allow access to the content in a specific AWS Elemental MediaConnect flow.

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,
  },
});

Initializer

new FlowEntitlement(scope: Construct, id: string, props: FlowEntitlementProps)

Parameters

• scope Construct
• id string
• props FlowEntitlementProps

Construct Props

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.
dataTransferSubscriberFeePercent?🔹	number	The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
encryption?🔹	StaticKeyEncryption	Options for encrypting the entitlement.
entitlementStatus?🔹	EntitlementStatus	An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
flowEntitlementName?🔹	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: StaticKeyEncryption (optional, default: no encryption)

Options for encrypting the entitlement.

Only static key encryption is supported for entitlements.

---

entitlementStatus?🔹

Type: EntitlementStatus (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.

Properties

Name	Type	Description
entitlementArn🔹	string	The Amazon Resource Name (ARN) of the entitlement.
env🔹	ResourceEnvironment	The environment this resource belongs to.
flowEntitlementRef🔹	FlowEntitlementReference	A reference to a FlowEntitlement resource.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

entitlementArn🔹

Type: string

The Amazon Resource Name (ARN) of the entitlement.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

flowEntitlementRef🔹

Type: FlowEntitlementReference

A reference to a FlowEntitlement resource.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.
static fromFlowEntitlementArn(scope, id, flowEntitlementArn)🔹	Creates a FlowEntitlement construct that represents an external (imported) FlowEntitlement.

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

static fromFlowEntitlementArn(scope, id, flowEntitlementArn)🔹

public static fromFlowEntitlementArn(scope: Construct, id: string, flowEntitlementArn: string): IFlowEntitlement

Parameters

• scope Construct
• id string
• flowEntitlementArn string

Returns

• IFlowEntitlement

Creates a FlowEntitlement construct that represents an external (imported) FlowEntitlement.