Skip to content
v2.277.0

Experimental

@aws-cdk/aws-mediaconnect-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

FlowEntitlementProps Struct ​

Properties for the Flow entitlement.

Example ​

ts
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,
  },
});
python
from aws_cdk.aws_mediaconnect_alpha import StaticKeyEncryption
# stack: Stack
# flow: Flow
# role: iam.IRole
# secret: secretsmanager.ISecret


FlowEntitlement(stack, "MyEntitlement",
    flow=flow,
    subscribers=["111122223333"],
    description="Grant partner access to live feed",
    encryption=StaticKeyEncryption(
        role=role,
        secret=secret,
        algorithm=EncryptionAlgorithm.AES256
    )
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaConnect.Alpha
Stack stack;
Flow flow;
IRole role;
ISecret secret;


new FlowEntitlement(stack, "MyEntitlement", new FlowEntitlementProps {
    Flow = flow,
    Subscribers = new [] { "111122223333" },
    Description = "Grant partner access to live feed",
    Encryption = new StaticKeyEncryption {
        Role = role,
        Secret = secret,
        Algorithm = EncryptionAlgorithm.AES256
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2
var stack Stack
var flow Flow
var role IRole
var secret ISecret


awsmediaconnectalpha.NewFlowEntitlement(stack, jsii.String("MyEntitlement"), &FlowEntitlementProps{
	Flow: Flow,
	Subscribers: []*string{
		jsii.String("111122223333"),
	},
	Description: jsii.String("Grant partner access to live feed"),
	Encryption: &StaticKeyEncryption{
		Role: *Role,
		Secret: *Secret,
		Algorithm: awsmediaconnectalpha.EncryptionAlgorithm_AES256(),
	},
})

Properties ​

dataTransferSubscriberFeePercentoptionalnumberdata_transfer_subscriber_fee_percentoptionalint | floatdataTransferSubscriberFeePercentoptionalNumberDataTransferSubscriberFeePercentoptionaldoubleDataTransferSubscriberFeePercentoptional*float64#
The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

Default: the MediaConnect service default

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.

encryptionoptionalStaticKeyEncryptionencryptionoptionalStaticKeyEncryptionencryptionoptionalStaticKeyEncryptionEncryptionoptionalStaticKeyEncryptionEncryptionoptionalStaticKeyEncryption#
Options for encrypting the entitlement.

Default: no encryption

Only static key encryption is supported for entitlements.

entitlementStatusoptionalEntitlementStatusentitlement_statusoptionalEntitlementStatusentitlementStatusoptionalEntitlementStatusEntitlementStatusoptionalEntitlementStatusEntitlementStatusoptionalEntitlementStatus#
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

flowIFlowflowIFlowflowIFlowFlowIFlowFlowIFlowrequired#
The flow to set the entitlement from.
flowEntitlementNameoptionalstringflow_entitlement_nameoptionalstrflowEntitlementNameoptionalStringFlowEntitlementNameoptionalstringFlowEntitlementNameoptional*string= autogenerated#
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.