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
@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,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
type: aws-native:mediaconnect:FlowEntitlement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_mediaconnect_flow_entitlement" "name" {
# resource properties
}
Parameters
- 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.
- 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.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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_subscriber_fee_percent
number
- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
- encryption
object
- 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.
- tags
list(object)
- Key-value pairs that can be used to tag and organize this flow 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.
- tags
List<Property Map>
- Key-value pairs that can be used to tag and organize this flow 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.
- entitlement_arn
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.
Look up Existing FlowEntitlement Resource
Get an existing FlowEntitlement resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
func GetFlowEntitlement(ctx *Context, name string, id IDInput, state *FlowEntitlementState, opts ...ResourceOption) (*FlowEntitlement, error)
public static FlowEntitlement get(String name, Output<String> id, CustomResourceOptions options)
resources: existingFlowEntitlement: type: aws-native:mediaconnect:FlowEntitlement get: id: ${id}
import {
to = aws-native_mediaconnect_flow_entitlement.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
FlowEntitlementState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
FlowEntitlementEncryption, FlowEntitlementEncryptionArgs
Information about the encryption of the flow.
- 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
"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_vector
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.
- 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.
- 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
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
| Name | Value |
|---|
| Aes128 | aes128 |
| Aes192 | aes192 |
| Aes256 | aes256 |
| Name | Value |
|---|
| FlowEntitlementEncryptionAlgorithmAes128 | aes128 |
| FlowEntitlementEncryptionAlgorithmAes192 | aes192 |
| FlowEntitlementEncryptionAlgorithmAes256 | aes256 |
| Name | Value |
|---|
| Aes128 | aes128 |
| Aes192 | aes192 |
| Aes256 | aes256 |
| Name | Value |
|---|
| Aes128 | aes128 |
| Aes192 | aes192 |
| Aes256 | aes256 |
| Name | Value |
|---|
| AES128 | aes128 |
| AES192 | aes192 |
| AES256 | aes256 |
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).
| Name | Value |
|---|
| Speke | speke |
| StaticKey | static-key |
| Name | Value |
|---|
| FlowEntitlementEncryptionKeyTypeSpeke | speke |
| FlowEntitlementEncryptionKeyTypeStaticKey | static-key |
| Name | Value |
|---|
| Speke | speke |
| StaticKey | static-key |
| Name | Value |
|---|
| Speke | speke |
| StaticKey | static-key |
| Name | Value |
|---|
| SPEKE | speke |
| STATIC_KEY | static-key |
FlowEntitlementEntitlementStatus
An indication of whether the entitlement is enabled.
| Name | Value |
|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|
| FlowEntitlementEntitlementStatusEnabled | ENABLED |
| FlowEntitlementEntitlementStatusDisabled | DISABLED |
| Name | Value |
|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|
| ENABLED | ENABLED |
| DISABLED | DISABLED |
Tag, TagArgs
A set of tags to apply to the resource.
- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
str
- The key name of the tag
- value
str
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0