AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

FlowEntitlement

Resource schema for AWS::MediaConnect::FlowEntitlement

Create FlowEntitlement Resource

new FlowEntitlement(name: string, args: FlowEntitlementArgs, opts?: CustomResourceOptions);
@overload
def FlowEntitlement(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    data_transfer_subscriber_fee_percent: Optional[int] = None,
                    description: Optional[str] = None,
                    encryption: Optional[FlowEntitlementEncryptionArgs] = None,
                    entitlement_status: Optional[FlowEntitlementEntitlementStatus] = None,
                    flow_arn: Optional[str] = None,
                    name: Optional[str] = None,
                    subscribers: Optional[Sequence[str]] = None)
@overload
def FlowEntitlement(resource_name: str,
                    args: FlowEntitlementArgs,
                    opts: Optional[ResourceOptions] = None)
func NewFlowEntitlement(ctx *Context, name string, args FlowEntitlementArgs, opts ...ResourceOption) (*FlowEntitlement, error)
public FlowEntitlement(string name, FlowEntitlementArgs args, CustomResourceOptions? opts = null)
public FlowEntitlement(String name, FlowEntitlementArgs args)
public FlowEntitlement(String name, FlowEntitlementArgs args, CustomResourceOptions options)
type: aws-native:mediaconnect:FlowEntitlement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FlowEntitlementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args FlowEntitlementArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args FlowEntitlementArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FlowEntitlementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FlowEntitlementArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FlowEntitlement Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The FlowEntitlement resource accepts the following input properties:

Description string

A description of the entitlement.

FlowArn string

The ARN of the flow.

Subscribers List<string>

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

DataTransferSubscriberFeePercent int

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

Encryption Pulumi.AwsNative.MediaConnect.Inputs.FlowEntitlementEncryptionArgs

The type of encryption that will be used on the output that is associated with this entitlement.

EntitlementStatus Pulumi.AwsNative.MediaConnect.FlowEntitlementEntitlementStatus

An indication of whether the entitlement is enabled.

Name string

The name of the entitlement.

Description string

A description of the entitlement.

FlowArn string

The ARN of the flow.

Subscribers []string

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

DataTransferSubscriberFeePercent int

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

Encryption FlowEntitlementEncryptionArgs

The type of encryption that will be used on the output that is associated with this entitlement.

EntitlementStatus FlowEntitlementEntitlementStatus

An indication of whether the entitlement is enabled.

Name string

The name of the entitlement.

description String

A description of the entitlement.

flowArn String

The ARN of the flow.

subscribers List<String>

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

dataTransferSubscriberFeePercent Integer

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

encryption FlowEntitlementEncryptionArgs

The type of encryption that will be used on the output that is associated with this entitlement.

entitlementStatus FlowEntitlementEntitlementStatus

An indication of whether the entitlement is enabled.

name String

The name of the entitlement.

description string

A description of the entitlement.

flowArn string

The ARN of the flow.

subscribers string[]

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

dataTransferSubscriberFeePercent number

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

encryption FlowEntitlementEncryptionArgs

The type of encryption that will be used on the output that is associated with this entitlement.

entitlementStatus FlowEntitlementEntitlementStatus

An indication of whether the entitlement is enabled.

name string

The name of the entitlement.

description str

A description of the entitlement.

flow_arn str

The ARN of the flow.

subscribers Sequence[str]

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

data_transfer_subscriber_fee_percent int

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

encryption FlowEntitlementEncryptionArgs

The type of encryption that will be used on the output that is associated with this entitlement.

entitlement_status FlowEntitlementEntitlementStatus

An indication of whether the entitlement is enabled.

name str

The name of the entitlement.

description String

A description of the entitlement.

flowArn String

The ARN of the flow.

subscribers List<String>

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

dataTransferSubscriberFeePercent Number

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

encryption Property Map

The type of encryption that will be used on the output that is associated with this entitlement.

entitlementStatus "ENABLED" | "DISABLED"

An indication of whether the entitlement is enabled.

name String

The name of the entitlement.

Outputs

All input properties are implicitly available as output properties. Additionally, the FlowEntitlement resource produces the following output properties:

EntitlementArn string

The ARN of the entitlement.

Id string

The provider-assigned unique ID for this managed resource.

EntitlementArn string

The ARN of the entitlement.

Id string

The provider-assigned unique ID for this managed resource.

entitlementArn String

The ARN of the entitlement.

id String

The provider-assigned unique ID for this managed resource.

entitlementArn string

The ARN of the entitlement.

id string

The provider-assigned unique ID for this managed resource.

entitlement_arn str

The ARN of the entitlement.

id str

The provider-assigned unique ID for this managed resource.

entitlementArn String

The ARN of the entitlement.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

FlowEntitlementEncryption

Algorithm Pulumi.AwsNative.MediaConnect.FlowEntitlementEncryptionAlgorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

RoleArn string

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

ConstantInitializationVector string

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

DeviceId string

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

KeyType Pulumi.AwsNative.MediaConnect.FlowEntitlementEncryptionKeyType

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Region string

The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

ResourceId string

An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

SecretArn string

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

Url string

The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

Algorithm FlowEntitlementEncryptionAlgorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

RoleArn string

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

ConstantInitializationVector string

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

DeviceId string

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

KeyType FlowEntitlementEncryptionKeyType

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Region string

The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

ResourceId string

An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

SecretArn string

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

Url string

The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

algorithm FlowEntitlementEncryptionAlgorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

roleArn String

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

constantInitializationVector String

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

deviceId String

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

keyType FlowEntitlementEncryptionKeyType

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

region String

The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

resourceId String

An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

secretArn String

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

url String

The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

algorithm FlowEntitlementEncryptionAlgorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

roleArn string

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

constantInitializationVector string

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

deviceId string

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

keyType FlowEntitlementEncryptionKeyType

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

region string

The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

resourceId string

An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

secretArn string

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

url string

The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

algorithm FlowEntitlementEncryptionAlgorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

role_arn str

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

constant_initialization_vector str

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

device_id str

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

key_type FlowEntitlementEncryptionKeyType

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

region str

The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

resource_id str

An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

secret_arn str

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

url str

The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

algorithm "aes128" | "aes192" | "aes256"

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

roleArn String

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

constantInitializationVector String

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

deviceId String

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

keyType "speke" | "static-key"

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

region String

The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

resourceId String

An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

secretArn String

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

url String

The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

FlowEntitlementEncryptionAlgorithm

Aes128
aes128
Aes192
aes192
Aes256
aes256
FlowEntitlementEncryptionAlgorithmAes128
aes128
FlowEntitlementEncryptionAlgorithmAes192
aes192
FlowEntitlementEncryptionAlgorithmAes256
aes256
Aes128
aes128
Aes192
aes192
Aes256
aes256
Aes128
aes128
Aes192
aes192
Aes256
aes256
AES128
aes128
AES192
aes192
AES256
aes256
"aes128"
aes128
"aes192"
aes192
"aes256"
aes256

FlowEntitlementEncryptionKeyType

Speke
speke
StaticKey
static-key
FlowEntitlementEncryptionKeyTypeSpeke
speke
FlowEntitlementEncryptionKeyTypeStaticKey
static-key
Speke
speke
StaticKey
static-key
Speke
speke
StaticKey
static-key
SPEKE
speke
STATIC_KEY
static-key
"speke"
speke
"static-key"
static-key

FlowEntitlementEntitlementStatus

Enabled
ENABLED
Disabled
DISABLED
FlowEntitlementEntitlementStatusEnabled
ENABLED
FlowEntitlementEntitlementStatusDisabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
ENABLED
ENABLED
DISABLED
DISABLED
"ENABLED"
ENABLED
"DISABLED"
DISABLED

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0