Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlowEntitlementProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowEntitlementProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:19.455Z")
@Stability(Stable)
public interface CfnFlowEntitlementProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFlowEntitlement.

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.*;
 CfnFlowEntitlementProps cfnFlowEntitlementProps = CfnFlowEntitlementProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlowEntitlementProps.Builder	A builder for CfnFlowEntitlementProps
static final class	CfnFlowEntitlementProps.Jsii$Proxy	An implementation for CfnFlowEntitlementProps

Method Summary

Modifier and Type	Method	Description
static CfnFlowEntitlementProps.Builder	builder()
default Number	getDataTransferSubscriberFeePercent()	The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
String	getDescription()	A description of the entitlement.
default Object	getEncryption()	The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
default String	getEntitlementStatus()	An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
String	getFlowArn()	The Amazon Resource Name (ARN) of the flow.
String	getName()	The name of the entitlement.
List<String>	getSubscribers()	The AWS account IDs that you want to share your content with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

A description of the entitlement.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-description

getFlowArn

@Stability(Stable)
@NotNull
String getFlowArn()

The Amazon Resource Name (ARN) of the flow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-flowarn

getName

@Stability(Stable)
@NotNull
String getName()

The name of the entitlement.

This value must be unique within the current flow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-name

getSubscribers

@Stability(Stable)
@NotNull
List<String> getSubscribers()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-subscribers

getDataTransferSubscriberFeePercent

@Stability(Stable)
@Nullable
default Number getDataTransferSubscriberFeePercent()

The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-datatransfersubscriberfeepercent

getEncryption

@Stability(Stable)
@Nullable
default Object getEncryption()

The type of encryption that MediaConnect will use on the output that is associated with the entitlement.

See Also:

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

getEntitlementStatus

@Stability(Stable)
@Nullable
default String getEntitlementStatus()

An indication of whether the new entitlement should be enabled or disabled as soon as it is created.

If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-entitlementstatus

builder

@Stability(Stable)
static CfnFlowEntitlementProps.Builder builder()

Returns:

a CfnFlowEntitlementProps.Builder of CfnFlowEntitlementProps