Package software.amazon.awscdk.services.mediaconnect.alpha

Interface FlowEntitlementProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FlowEntitlementProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-31T10:49:55.146Z")
@Stability(Experimental)
public interface FlowEntitlementProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for the Flow entitlement.

Example:

 Stack stack;
 Flow flow;
 IRole role;
 ISecret secret;
 FlowEntitlement.Builder.create(stack, "MyEntitlement")
         .flow(flow)
         .subscribers(List.of("111122223333"))
         .description("Grant partner access to live feed")
         .encryption(StaticKeyEncryption.builder()
                 .role(role)
                 .secret(secret)
                 .algorithm(EncryptionAlgorithm.AES256)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FlowEntitlementProps.Builder	A builder for FlowEntitlementProps
static final class	FlowEntitlementProps.Jsii$Proxy	An implementation for FlowEntitlementProps

Method Summary

Modifier and Type	Method	Description
static FlowEntitlementProps.Builder	builder()
default Number	getDataTransferSubscriberFeePercent()	(experimental) The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
String	getDescription()	(experimental) A description of the entitlement.
default StaticKeyEncryption	getEncryption()	(experimental) Options for encrypting the entitlement.
default EntitlementStatus	getEntitlementStatus()	(experimental) An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
IFlow	getFlow()	(experimental) The flow to set the entitlement from.
default String	getFlowEntitlementName()	(experimental) The name of the entitlement.
List<String>	getSubscribers()	(experimental) The AWS account IDs that you want to share your content with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Experimental)
@NotNull
String getDescription()

(experimental) A description of the entitlement.

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

getFlow

@Stability(Experimental)
@NotNull
IFlow getFlow()

(experimental) The flow to set the entitlement from.

getSubscribers

@Stability(Experimental)
@NotNull
List<String> getSubscribers()

(experimental) 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.

getDataTransferSubscriberFeePercent

@Stability(Experimental)
@Nullable
default Number getDataTransferSubscriberFeePercent()

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

Default: - the MediaConnect service default

getEncryption

@Stability(Experimental)
@Nullable
default StaticKeyEncryption getEncryption()

(experimental) Options for encrypting the entitlement.

Only static key encryption is supported for entitlements.

Default: - no encryption

getEntitlementStatus

@Stability(Experimental)
@Nullable
default EntitlementStatus getEntitlementStatus()

(experimental) An indication of whether the new entitlement should be enabled or disabled as soon as it is created.

Default: - undefined; when omitted, MediaConnect enables the entitlement (ENABLED) at deploy time

getFlowEntitlementName

@Stability(Experimental)
@Nullable
default String getFlowEntitlementName()

(experimental) The name of the entitlement.

This value must be unique within the current flow.

Default: autogenerated

builder

@Stability(Experimental)
static FlowEntitlementProps.Builder builder()

Returns:

a FlowEntitlementProps.Builder of FlowEntitlementProps