Resource schema for AWS::MediaConnect::FlowEntitlement
Using getFlowEntitlement
Two invocation forms are available. The direct form accepts plain
arguments and either blocks until the result value is available, or
returns a Promise-wrapped result. The output form accepts
Input-wrapped arguments and returns an Output-wrapped result.
def get_flow_entitlement(entitlement_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFlowEntitlementResult
def get_flow_entitlement_output(entitlement_arn: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetFlowEntitlementResult]
> Note: This function is named LookupFlowEntitlement in the Go SDK.
public static CompletableFuture<GetFlowEntitlementResult> getFlowEntitlement(GetFlowEntitlementArgs args, InvokeOptions options)
public static Output<GetFlowEntitlementResult> getFlowEntitlement(GetFlowEntitlementArgs args, InvokeOptions options)
public static Output<GetFlowEntitlementResult> getFlowEntitlement(GetFlowEntitlementArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:mediaconnect:getFlowEntitlement
arguments:
# arguments dictionary
data "aws-native_mediaconnect_get_flow_entitlement" "name" {
# arguments
}
The following arguments are supported:
getFlowEntitlement Result
The following output properties are available:
- description
string
- A description of the entitlement.
- encryption
object
- The type of encryption that will be used on the output that is associated with this entitlement.
- entitlement_arn
string
- The ARN of the entitlement.
- entitlement_status
"ENABLED" | "DISABLED"
- An indication of whether the entitlement is enabled.
- 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.
- tags
list(object)
- Key-value pairs that can be used to tag and organize this flow entitlement.
- description
String
- A description of the entitlement.
- encryption
Property Map
- The type of encryption that will be used on the output that is associated with this entitlement.
- entitlementArn
String
- The ARN of the entitlement.
- entitlementStatus
"ENABLED" | "DISABLED"
- An indication of whether the entitlement is enabled.
- 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.
- tags
List<Property Map>
- Key-value pairs that can be used to tag and organize this flow entitlement.
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
"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
| 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
| 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
| 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
- 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