CfnFlowEntitlementProps

class aws_cdk.aws_mediaconnect.CfnFlowEntitlementProps(*, description, flow_arn, name, subscribers, data_transfer_subscriber_fee_percent=None, encryption=None, entitlement_status=None)

Bases: object

Properties for defining a CfnFlowEntitlement.

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

  • flow_arn (str) – The Amazon Resource Name (ARN) of the flow.

  • name (str) – The name of the entitlement. This value must be unique within the current flow.

  • subscribers (Sequence[str]) – 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]) – The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

  • encryption (Union[IResolvable, EncryptionProperty, None]) – The type of encryption that MediaConnect will use on the output that is associated with the entitlement.

  • entitlement_status (Optional[str]) – An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_mediaconnect as mediaconnect

cfn_flow_entitlement_props = mediaconnect.CfnFlowEntitlementProps(
    description="description",
    flow_arn="flowArn",
    name="name",
    subscribers=["subscribers"],

    # the properties below are optional
    data_transfer_subscriber_fee_percent=123,
    encryption=mediaconnect.CfnFlowEntitlement.EncryptionProperty(
        algorithm="algorithm",
        role_arn="roleArn",

        # the properties below are optional
        constant_initialization_vector="constantInitializationVector",
        device_id="deviceId",
        key_type="keyType",
        region="region",
        resource_id="resourceId",
        secret_arn="secretArn",
        url="url"
    ),
    entitlement_status="entitlementStatus"
)

Attributes

data_transfer_subscriber_fee_percent

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-datatransfersubscriberfeepercent

Return type

Union[int, float, None]

description

A description of the entitlement.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-description

Return type

str

encryption

The type of encryption that MediaConnect will use on the output that is associated with the entitlement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-encryption

Return type

Union[IResolvable, EncryptionProperty, None]

entitlement_status

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

If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-entitlementstatus

Return type

Optional[str]

flow_arn

The Amazon Resource Name (ARN) of the flow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-flowarn

Return type

str

name

The name of the entitlement.

This value must be unique within the current flow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-name

Return type

str

subscribers

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-subscribers

Return type

List[str]