FlowEntitlementProps

class aws_cdk.aws_mediaconnect_alpha.FlowEntitlementProps(*, description, flow, subscribers, data_transfer_subscriber_fee_percent=None, encryption=None, entitlement_status=None, flow_entitlement_name=None)

Bases: object

(experimental) Properties for the Flow entitlement.

Parameters:
  • description (str) – (experimental) A description of the entitlement. This description appears only on the MediaConnect console and is not visible outside of the current AWS account.

  • flow (IFlow) – (experimental) The flow to set the entitlement from.

  • subscribers (Sequence[str]) – (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.

  • data_transfer_subscriber_fee_percent (Union[int, float, None]) – (experimental) The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for. Default: - the MediaConnect service default

  • encryption (Union[StaticKeyEncryption, Dict[str, Any], None]) – (experimental) Options for encrypting the entitlement. Only static key encryption is supported for entitlements. Default: - no encryption

  • entitlement_status (Optional[EntitlementStatus]) – (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

  • flow_entitlement_name (Optional[str]) – (experimental) The name of the entitlement. This value must be unique within the current flow. Default: autogenerated

Stability:

experimental

ExampleMetadata:

infused

Example:

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
    )
)

Attributes

data_transfer_subscriber_fee_percent

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

Default:
  • the MediaConnect service default

Stability:

experimental

description

(experimental) A description of the entitlement.

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

Stability:

experimental

encryption

(experimental) Options for encrypting the entitlement.

Only static key encryption is supported for entitlements.

Default:
  • no encryption

Stability:

experimental

entitlement_status

(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

Stability:

experimental

flow

(experimental) The flow to set the entitlement from.

Stability:

experimental

flow_entitlement_name

(experimental) The name of the entitlement.

This value must be unique within the current flow.

Default:

autogenerated

Stability:

experimental

subscribers

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

Stability:

experimental