We recommend new projects start with resources from the AWS provider.
aws-native.mediaconnect.FlowEntitlement
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource schema for AWS::MediaConnect::FlowEntitlement
Create FlowEntitlement Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FlowEntitlement(name: string, args: FlowEntitlementArgs, opts?: CustomResourceOptions);
@overload
def FlowEntitlement(resource_name: str,
args: FlowEntitlementArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FlowEntitlement(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
flow_arn: Optional[str] = None,
subscribers: Optional[Sequence[str]] = None,
data_transfer_subscriber_fee_percent: Optional[int] = None,
encryption: Optional[FlowEntitlementEncryptionArgs] = None,
entitlement_status: Optional[FlowEntitlementEntitlementStatus] = None,
name: Optional[str] = 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.
Parameters
- 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.
- Flow
Arn 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.
- Data
Transfer intSubscriber Fee Percent - Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
- Encryption
Pulumi.
Aws Native. Media Connect. Inputs. Flow Entitlement Encryption - The type of encryption that will be used on the output that is associated with this entitlement.
- Entitlement
Status Pulumi.Aws Native. Media Connect. Flow Entitlement Entitlement Status - An indication of whether the entitlement is enabled.
- Name string
- The name of the entitlement.
- Description string
- A description of the entitlement.
- Flow
Arn 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.
- Data
Transfer intSubscriber Fee Percent - Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
- Encryption
Flow
Entitlement Encryption Args - The type of encryption that will be used on the output that is associated with this entitlement.
- Entitlement
Status FlowEntitlement Entitlement Status - An indication of whether the entitlement is enabled.
- Name string
- The name of the entitlement.
- description String
- A description of the entitlement.
- flow
Arn 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.
- data
Transfer IntegerSubscriber Fee Percent - Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
- encryption
Flow
Entitlement Encryption - The type of encryption that will be used on the output that is associated with this entitlement.
- entitlement
Status FlowEntitlement Entitlement Status - An indication of whether the entitlement is enabled.
- name String
- The name of the entitlement.
- description string
- A description of the entitlement.
- flow
Arn 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.
- data
Transfer numberSubscriber Fee Percent - Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
- encryption
Flow
Entitlement Encryption - The type of encryption that will be used on the output that is associated with this entitlement.
- entitlement
Status FlowEntitlement Entitlement Status - 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_ intsubscriber_ fee_ percent - Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
- encryption
Flow
Entitlement Encryption Args - The type of encryption that will be used on the output that is associated with this entitlement.
- entitlement_
status FlowEntitlement Entitlement Status - An indication of whether the entitlement is enabled.
- name str
- The name of the entitlement.
- description String
- A description of the entitlement.
- flow
Arn 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.
- data
Transfer NumberSubscriber Fee Percent - 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.
- entitlement
Status "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:
- Entitlement
Arn string - The ARN of the entitlement.
- Id string
- The provider-assigned unique ID for this managed resource.
- Entitlement
Arn string - The ARN of the entitlement.
- Id string
- The provider-assigned unique ID for this managed resource.
- entitlement
Arn String - The ARN of the entitlement.
- id String
- The provider-assigned unique ID for this managed resource.
- entitlement
Arn 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.
- entitlement
Arn String - The ARN of the entitlement.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
FlowEntitlementEncryption, FlowEntitlementEncryptionArgs
- Algorithm
Pulumi.
Aws Native. Media Connect. Flow Entitlement Encryption Algorithm - The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
- Role
Arn string - The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
- Constant
Initialization stringVector - 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 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.
- Key
Type Pulumi.Aws Native. Media Connect. Flow Entitlement Encryption Key Type - 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.
- Resource
Id 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.
- Secret
Arn 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
Flow
Entitlement Encryption Algorithm - The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
- Role
Arn string - The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
- Constant
Initialization stringVector - 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 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.
- Key
Type FlowEntitlement Encryption Key Type - 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.
- Resource
Id 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.
- Secret
Arn 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
Flow
Entitlement Encryption Algorithm - The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
- role
Arn String - The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
- constant
Initialization StringVector - 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 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.
- key
Type FlowEntitlement Encryption Key Type - 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.
- resource
Id 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.
- secret
Arn 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
Flow
Entitlement Encryption Algorithm - The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
- role
Arn string - The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
- constant
Initialization stringVector - 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 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.
- key
Type FlowEntitlement Encryption Key Type - 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.
- resource
Id 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.
- secret
Arn 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
Flow
Entitlement Encryption Algorithm - 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_ strvector - 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 FlowEntitlement Encryption Key Type - 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).
- role
Arn String - The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
- constant
Initialization StringVector - 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 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.
- key
Type "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.
- resource
Id 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.
- secret
Arn 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, FlowEntitlementEncryptionAlgorithmArgs
- Aes128
- aes128
- Aes192
- aes192
- Aes256
- aes256
- Flow
Entitlement Encryption Algorithm Aes128 - aes128
- Flow
Entitlement Encryption Algorithm Aes192 - aes192
- Flow
Entitlement Encryption Algorithm Aes256 - 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, FlowEntitlementEncryptionKeyTypeArgs
- Speke
- speke
- Static
Key - static-key
- Flow
Entitlement Encryption Key Type Speke - speke
- Flow
Entitlement Encryption Key Type Static Key - static-key
- Speke
- speke
- Static
Key - static-key
- Speke
- speke
- Static
Key - static-key
- SPEKE
- speke
- STATIC_KEY
- static-key
- "speke"
- speke
- "static-key"
- static-key
FlowEntitlementEntitlementStatus, FlowEntitlementEntitlementStatusArgs
- Enabled
- ENABLED
- Disabled
- DISABLED
- Flow
Entitlement Entitlement Status Enabled - ENABLED
- Flow
Entitlement Entitlement Status Disabled - DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.