CfnFlowEntitlementPropsMixin

class aws_cdk.mixins_preview.aws_mediaconnect.mixins.CfnFlowEntitlementPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::MediaConnect::FlowEntitlement 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.

The content originator grants an entitlement to a specific AWS account (the subscriber). When an entitlement is granted, the subscriber can create a flow using the originator’s flow as the source. Each flow can have up to 50 entitlements.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html
CloudformationResource:: AWS::MediaConnect::FlowEntitlement
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_flow_entitlement_props_mixin = mediaconnect_mixins.CfnFlowEntitlementPropsMixin(mediaconnect_mixins.CfnFlowEntitlementMixinProps(
    data_transfer_subscriber_fee_percent=123,
    description="description",
    encryption=mediaconnect_mixins.CfnFlowEntitlementPropsMixin.EncryptionProperty(
        algorithm="algorithm",
        constant_initialization_vector="constantInitializationVector",
        device_id="deviceId",
        key_type="keyType",
        region="region",
        resource_id="resourceId",
        role_arn="roleArn",
        secret_arn="secretArn",
        url="url"
    ),
    entitlement_status="entitlementStatus",
    flow_arn="flowArn",
    name="name",
    subscribers=["subscribers"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MediaConnect::FlowEntitlement.

Parameters:

props (Union[CfnFlowEntitlementMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['dataTransferSubscriberFeePercent', 'description', 'encryption', 'entitlementStatus', 'flowArn', 'name', 'subscribers']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EncryptionProperty

class CfnFlowEntitlementPropsMixin.EncryptionProperty(*, algorithm=None, constant_initialization_vector=None, device_id=None, key_type=None, region=None, resource_id=None, role_arn=None, secret_arn=None, url=None)

Bases: object

Encryption information.

Parameters:

algorithm (Optional[str]) – The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256). If you are using SPEKE or SRT-password encryption, this property must be left blank.
constant_initialization_vector (Optional[str]) – A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
device_id (Optional[str]) – The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
key_type (Optional[str]) – The type of key that is used for the encryption. If you don’t specify a keyType value, the service uses the default setting ( static-key ). Valid key types are: static-key , speke , and srt-password . Default: - “static-key”
region (Optional[str]) – The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
resource_id (Optional[str]) – An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
role_arn (Optional[str]) – The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secret_arn (Optional[str]) – The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url (Optional[str]) – The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

encryption_property = mediaconnect_mixins.CfnFlowEntitlementPropsMixin.EncryptionProperty(
    algorithm="algorithm",
    constant_initialization_vector="constantInitializationVector",
    device_id="deviceId",
    key_type="keyType",
    region="region",
    resource_id="resourceId",
    role_arn="roleArn",
    secret_arn="secretArn",
    url="url"
)

Attributes

algorithm

The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).

If you are using SPEKE or SRT-password encryption, this property must be left blank.

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

constant_initialization_vector

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.

This parameter is not valid for static key encryption.

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

device_id

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.

This parameter is required for SPEKE encryption and is not valid for static key encryption.

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

key_type

The type of key that is used for the encryption.

If you don’t specify a keyType value, the service uses the default setting ( static-key ). Valid key types are: static-key , speke , and srt-password .

Default:

“static-key”

See:

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

region

The AWS Region that the API Gateway proxy endpoint was created in.

This parameter is required for SPEKE encryption and is not valid for static key encryption.

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

resource_id

An identifier for the content.

The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

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

role_arn

The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).

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

secret_arn

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.

This parameter is required for static key encryption and is not valid for SPEKE encryption.

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

url

The URL from the API Gateway proxy that you set up to talk to your key server.

This parameter is required for SPEKE encryption and is not valid for static key encryption.

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