Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. mediaconnect
  5. getFlowEntitlement

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.mediaconnect.getFlowEntitlement

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

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.

function getFlowEntitlement(args: GetFlowEntitlementArgs, opts?: InvokeOptions): Promise<GetFlowEntitlementResult>
function getFlowEntitlementOutput(args: GetFlowEntitlementOutputArgs, opts?: InvokeOptions): Output<GetFlowEntitlementResult>
Copy
def get_flow_entitlement(entitlement_arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetFlowEntitlementResult
def get_flow_entitlement_output(entitlement_arn: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetFlowEntitlementResult]
Copy
func LookupFlowEntitlement(ctx *Context, args *LookupFlowEntitlementArgs, opts ...InvokeOption) (*LookupFlowEntitlementResult, error)
func LookupFlowEntitlementOutput(ctx *Context, args *LookupFlowEntitlementOutputArgs, opts ...InvokeOption) LookupFlowEntitlementResultOutput
Copy

> Note: This function is named LookupFlowEntitlement in the Go SDK.

public static class GetFlowEntitlement 
{
    public static Task<GetFlowEntitlementResult> InvokeAsync(GetFlowEntitlementArgs args, InvokeOptions? opts = null)
    public static Output<GetFlowEntitlementResult> Invoke(GetFlowEntitlementInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFlowEntitlementResult> getFlowEntitlement(GetFlowEntitlementArgs args, InvokeOptions options)
public static Output<GetFlowEntitlementResult> getFlowEntitlement(GetFlowEntitlementArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:mediaconnect:getFlowEntitlement
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EntitlementArn This property is required. string
The ARN of the entitlement.
EntitlementArn This property is required. string
The ARN of the entitlement.
entitlementArn This property is required. String
The ARN of the entitlement.
entitlementArn This property is required. string
The ARN of the entitlement.
entitlement_arn This property is required. str
The ARN of the entitlement.
entitlementArn This property is required. String
The ARN of the entitlement.

getFlowEntitlement Result

The following output properties are available:

Description string
A description of the entitlement.
Encryption Pulumi.AwsNative.MediaConnect.Outputs.FlowEntitlementEncryption
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 Pulumi.AwsNative.MediaConnect.FlowEntitlementEntitlementStatus
An indication of whether the entitlement is enabled.
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.
Description string
A description of the entitlement.
Encryption FlowEntitlementEncryption
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 FlowEntitlementEntitlementStatus
An indication of whether the entitlement is enabled.
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.
description String
A description of the entitlement.
encryption FlowEntitlementEncryption
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 FlowEntitlementEntitlementStatus
An indication of whether the entitlement is enabled.
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.
description string
A description of the entitlement.
encryption FlowEntitlementEncryption
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 FlowEntitlementEntitlementStatus
An indication of whether the entitlement is enabled.
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.
description str
A description of the entitlement.
encryption FlowEntitlementEncryption
The type of encryption that will be used on the output that is associated with this entitlement.
entitlement_arn str
The ARN of the entitlement.
entitlement_status FlowEntitlementEntitlementStatus
An indication of whether the entitlement is enabled.
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.
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.
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.

Supporting Types

FlowEntitlementEncryption

Algorithm This property is required. Pulumi.AwsNative.MediaConnect.FlowEntitlementEncryptionAlgorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
RoleArn This property is required. 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 This property is required. FlowEntitlementEncryptionAlgorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
RoleArn This property is required. 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 This property is required. FlowEntitlementEncryptionAlgorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
roleArn This property is required. 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 This property is required. FlowEntitlementEncryptionAlgorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
roleArn This property is required. 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 This property is required. FlowEntitlementEncryptionAlgorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
role_arn This property is required. 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 This property is required. "aes128" | "aes192" | "aes256"
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
roleArn This property is required. 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

FlowEntitlementEncryptionKeyType

FlowEntitlementEntitlementStatus

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native