Class CfnFlowEntitlement
A CloudFormation AWS::MediaConnect::FlowEntitlement
.
Inherited Members
Namespace: Amazon.CDK.AWS.MediaConnect
Assembly: Amazon.CDK.AWS.MediaConnect.dll
Syntax (csharp)
public class CfnFlowEntitlement : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFlowEntitlement
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::MediaConnect::FlowEntitlement
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConnect;
var cfnFlowEntitlement = new CfnFlowEntitlement(this, "MyCfnFlowEntitlement", new CfnFlowEntitlementProps {
Description = "description",
FlowArn = "flowArn",
Name = "name",
Subscribers = new [] { "subscribers" },
// the properties below are optional
DataTransferSubscriberFeePercent = 123,
Encryption = new EncryptionProperty {
Algorithm = "algorithm",
RoleArn = "roleArn",
// the properties below are optional
ConstantInitializationVector = "constantInitializationVector",
DeviceId = "deviceId",
KeyType = "keyType",
Region = "region",
ResourceId = "resourceId",
SecretArn = "secretArn",
Url = "url"
},
EntitlementStatus = "entitlementStatus"
});
Synopsis
Constructors
CfnFlowEntitlement(Construct, String, ICfnFlowEntitlementProps) | Create a new |
CfnFlowEntitlement(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFlowEntitlement(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrEntitlementArn | The entitlement ARN. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataTransferSubscriberFeePercent | The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for. |
Description | A description of the entitlement. |
Encryption | The type of encryption that MediaConnect will use on the output that is associated with the entitlement. |
EntitlementStatus | An indication of whether the new entitlement should be enabled or disabled as soon as it is created. |
FlowArn | The Amazon Resource Name (ARN) of the flow. |
Name | The name of the entitlement. |
Subscribers | The AWS account IDs that you want to share your content with. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFlowEntitlement(Construct, String, ICfnFlowEntitlementProps)
Create a new AWS::MediaConnect::FlowEntitlement
.
public CfnFlowEntitlement(Construct scope, string id, ICfnFlowEntitlementProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFlowEntitlementProps
- resource properties.
CfnFlowEntitlement(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFlowEntitlement(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFlowEntitlement(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFlowEntitlement(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrEntitlementArn
The entitlement ARN.
public virtual string AttrEntitlementArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EntitlementArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataTransferSubscriberFeePercent
The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
public virtual Nullable<double> DataTransferSubscriberFeePercent { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Description
A description of the entitlement.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
This description appears only on the MediaConnect console and is not visible outside of the current AWS account.
Encryption
The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
public virtual object Encryption { get; set; }
Property Value
System.Object
Remarks
EntitlementStatus
An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
public virtual string EntitlementStatus { get; set; }
Property Value
System.String
Remarks
If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
FlowArn
The Amazon Resource Name (ARN) of the flow.
public virtual string FlowArn { get; set; }
Property Value
System.String
Remarks
Name
The name of the entitlement.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
This value must be unique within the current flow.
Subscribers
The AWS account IDs that you want to share your content with.
public virtual string[] Subscribers { get; set; }
Property Value
System.String[]
Remarks
The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>