Experimental

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

FlowEntitlement L2 construct

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.

Stability: Experimental
Source: lib/flow-entitlement.ts

Example

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

// 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(),
	},
})

Initializer

new FlowEntitlement(scope: Construct, id: string, props: FlowEntitlementProps)

python

FlowEntitlement(scope: Construct, id: str, props: FlowEntitlementProps)

java

new FlowEntitlement(Construct scope, String id, FlowEntitlementProps props)

csharp

new FlowEntitlement(Construct scope, string id, FlowEntitlementProps props)

NewFlowEntitlement(Scope Construct, Id *string, Props FlowEntitlementProps)

Construct Props

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.

Properties

entitlementArnstringentitlement_arnstrentitlementArnStringEntitlementArnstringEntitlementArn*string#

The Amazon Resource Name (ARN) of the entitlement.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

flowEntitlementRefFlowEntitlementReferenceflow_entitlement_refFlowEntitlementReferenceflowEntitlementRefFlowEntitlementReferenceFlowEntitlementRefFlowEntitlementReferenceFlowEntitlementRefFlowEntitlementReference#

A reference to a FlowEntitlement resource.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromFlowEntitlementArn(scope: Construct, id: string, flowEntitlementArn: string): IFlowEntitlement@staticmethod def from_flow_entitlement_arn(scope: Construct, id: str, flow_entitlement_arn: str) -> IFlowEntitlementpublic static IFlowEntitlement fromFlowEntitlementArn(Construct scope, String id, String flowEntitlementArn)public static IFlowEntitlement FromFlowEntitlementArn(Construct scope, string id, string flowEntitlementArn)func FromFlowEntitlementArn(Scope Construct, Id *string, FlowEntitlementArn *string) IFlowEntitlementstatic#

Creates a FlowEntitlement construct that represents an external (imported) FlowEntitlement.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

FlowEntitlement L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​