software.amazon.awscdk.services.mediaconnect

Class CfnFlowEntitlement

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.mediaconnect.CfnFlowEntitlement

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.967Z")
 @Stability(value=Stable)
public class CfnFlowEntitlement
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaConnect::FlowEntitlement`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFlowEntitlement.Builder A fluent builder for CfnFlowEntitlement.
static interface	CfnFlowEntitlement.EncryptionProperty Information about the encryption of the flow.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFlowEntitlement(Construct scope, String id, CfnFlowEntitlementProps props) Create a new `AWS::MediaConnect::FlowEntitlement`.
protected	CfnFlowEntitlement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFlowEntitlement(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrEntitlementArn() The entitlement ARN.
protected Map<String,Object>	getCfnProperties()
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.
Object	getEncryption() The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataTransferSubscriberFeePercent(Number value) The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
void	setDescription(String value) A description of the entitlement.
void	setEncryption(CfnFlowEntitlement.EncryptionProperty value) The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
void	setEncryption(IResolvable value) The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
void	setEntitlementStatus(String value) An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
void	setFlowArn(String value) The Amazon Resource Name (ARN) of the flow.
void	setName(String value) The name of the entitlement.
void	setSubscribers(List<String> value) The AWS account IDs that you want to share your content with.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFlowEntitlement

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

CfnFlowEntitlement

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

CfnFlowEntitlement

@Stability(value=Stable)
public CfnFlowEntitlement(@NotNull
                                                   Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnFlowEntitlementProps props)

Create a new `AWS::MediaConnect::FlowEntitlement`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrEntitlementArn()

The entitlement ARN.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

@Stability(value=Stable)
 @NotNull
public 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.

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

A description of the entitlement.

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

getFlowArn

@Stability(value=Stable)
 @NotNull
public String getFlowArn()

The Amazon Resource Name (ARN) of the flow.

setFlowArn

@Stability(value=Stable)
public void setFlowArn(@NotNull
                                                String value)

The Amazon Resource Name (ARN) of the flow.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the entitlement.

This value must be unique within the current flow.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the entitlement.

This value must be unique within the current flow.

getSubscribers

@Stability(value=Stable)
 @NotNull
public 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.

setSubscribers

@Stability(value=Stable)
public void setSubscribers(@NotNull
                                                    List<String> value)

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.

getDataTransferSubscriberFeePercent

@Stability(value=Stable)
 @Nullable
public Number getDataTransferSubscriberFeePercent()

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

setDataTransferSubscriberFeePercent

@Stability(value=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(value=Stable)
 @Nullable
public Object getEncryption()

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

setEncryption

@Stability(value=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(value=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(value=Stable)
 @Nullable
public 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.

setEntitlementStatus

@Stability(value=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.

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