Package software.amazon.awscdk.services.mediaconnect.alpha

Class FlowEntitlement.Builder

java.lang.Object
software.amazon.awscdk.services.mediaconnect.alpha.FlowEntitlement.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<FlowEntitlement>
Enclosing class:
FlowEntitlement
@Stability(Experimental) public static final class FlowEntitlement.Builder extends Object implements software.amazon.jsii.Builder<FlowEntitlement>
(experimental) A fluent builder for FlowEntitlement.

  • Method Details

    • create

      @Stability(Experimental) public static FlowEntitlement.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of FlowEntitlement.Builder.

    • description

      @Stability(Experimental) public FlowEntitlement.Builder description(String description)
      (experimental) A description of the entitlement.

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

      Parameters:
      description - A description of the entitlement. This parameter is required.
      Returns:
      this

    • flow

      @Stability(Experimental) public FlowEntitlement.Builder flow(IFlow flow)
      (experimental) The flow to set the entitlement from.

      Parameters:
      flow - The flow to set the entitlement from. This parameter is required.
      Returns:
      this

    • subscribers

      @Stability(Experimental) public FlowEntitlement.Builder subscribers(List<String> subscribers)
      (experimental) 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.

      Parameters:
      subscribers - The AWS account IDs that you want to share your content with. This parameter is required.
      Returns:
      this

    • dataTransferSubscriberFeePercent

      @Stability(Experimental) public FlowEntitlement.Builder dataTransferSubscriberFeePercent(Number dataTransferSubscriberFeePercent)
      (experimental) The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

      Default: - the MediaConnect service default

      Parameters:
      dataTransferSubscriberFeePercent - The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for. This parameter is required.
      Returns:
      this

    • encryption

      @Stability(Experimental) public FlowEntitlement.Builder encryption(StaticKeyEncryption encryption)
      (experimental) Options for encrypting the entitlement.

      Only static key encryption is supported for entitlements.

      Default: - no encryption

      Parameters:
      encryption - Options for encrypting the entitlement. This parameter is required.
      Returns:
      this

    • entitlementStatus

      @Stability(Experimental) public FlowEntitlement.Builder entitlementStatus(EntitlementStatus entitlementStatus)
      (experimental) 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

      Parameters:
      entitlementStatus - An indication of whether the new entitlement should be enabled or disabled as soon as it is created. This parameter is required.
      Returns:
      this

    • flowEntitlementName

      @Stability(Experimental) public FlowEntitlement.Builder flowEntitlementName(String flowEntitlementName)
      (experimental) The name of the entitlement.

      This value must be unique within the current flow.

      Default: autogenerated

      Parameters:
      flowEntitlementName - The name of the entitlement. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public FlowEntitlement build()
      Specified by:
      build in interface software.amazon.jsii.Builder<FlowEntitlement>
      Returns:
      a newly built instance of FlowEntitlement.