Package software.amazon.awscdk.services.mediaconnect

Class CfnFlowEntitlement

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.mediaconnect.CfnFlowEntitlement
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:32.378Z") @Stability(Stable) public class CfnFlowEntitlement extends CfnResource implements IInspectable
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediaconnect.*;
 CfnFlowEntitlement cfnFlowEntitlement = CfnFlowEntitlement.Builder.create(this, "MyCfnFlowEntitlement")
         .description("description")
         .flowArn("flowArn")
         .name("name")
         .subscribers(List.of("subscribers"))
         // the properties below are optional
         .dataTransferSubscriberFeePercent(123)
         .encryption(EncryptionProperty.builder()
                 .algorithm("algorithm")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .constantInitializationVector("constantInitializationVector")
                 .deviceId("deviceId")
                 .keyType("keyType")
                 .region("region")
                 .resourceId("resourceId")
                 .secretArn("secretArn")
                 .url("url")
                 .build())
         .entitlementStatus("entitlementStatus")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFlowEntitlement

      protected CfnFlowEntitlement(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFlowEntitlement

      protected CfnFlowEntitlement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFlowEntitlement

      @Stability(Stable) public CfnFlowEntitlement(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFlowEntitlementProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrEntitlementArn

      @Stability(Stable) @NotNull public String getAttrEntitlementArn()
      The entitlement ARN.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      A description of the entitlement.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      A description of the entitlement.

    • getFlowArn

      @Stability(Stable) @NotNull public String getFlowArn()
      The Amazon Resource Name (ARN) of the flow.

    • setFlowArn

      @Stability(Stable) public void setFlowArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the flow.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the entitlement.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the entitlement.

    • getSubscribers

      @Stability(Stable) @NotNull public List<String> getSubscribers()
      The AWS account IDs that you want to share your content with.

    • setSubscribers

      @Stability(Stable) public void setSubscribers(@NotNull List<String> value)
      The AWS account IDs that you want to share your content with.

    • getDataTransferSubscriberFeePercent

      @Stability(Stable) @Nullable public Number getDataTransferSubscriberFeePercent()
      The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

    • setDataTransferSubscriberFeePercent

      @Stability(Stable) public void setDataTransferSubscriberFeePercent(@Nullable Number value)
      The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

    • getEncryption

      @Stability(Stable) @Nullable public Object getEncryption()
      The type of encryption that MediaConnect will use on the output that is associated with the entitlement.

    • setEncryption

      @Stability(Stable) public void setEncryption(@Nullable IResolvable value)
      The type of encryption that MediaConnect will use on the output that is associated with the entitlement.

    • setEncryption

      @Stability(Stable) public void setEncryption(@Nullable CfnFlowEntitlement.EncryptionProperty value)
      The type of encryption that MediaConnect will use on the output that is associated with the entitlement.

    • getEntitlementStatus

      @Stability(Stable) @Nullable public String getEntitlementStatus()
      An indication of whether the new entitlement should be enabled or disabled as soon as it is created.

    • setEntitlementStatus

      @Stability(Stable) public void setEntitlementStatus(@Nullable String value)
      An indication of whether the new entitlement should be enabled or disabled as soon as it is created.