awscc.mediaconnect_flow¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - mediaconnect:DescribeFlow, mediaconnect:DeleteFlow
update¶
Parent base class for filters and actions.
definitions:
Encryption:
additionalProperties: false
description: Information about the encryption of the flow.
properties:
Algorithm:
description: The type of algorithm that is used for the encryption (such as
aes128, aes192, or aes256).
enum:
- aes128
- aes192
- aes256
type: string
ConstantInitializationVector:
description: 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.
type: string
DeviceId:
description: 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.
type: string
KeyType:
default: static-key
description: The type of key that is used for the encryption. If no keyType
is provided, the service will use the default setting (static-key).
enum:
- speke
- static-key
- srt-password
type: string
Region:
description: 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.
type: string
ResourceId:
description: 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.
type: string
RoleArn:
description: The ARN of the role that you created during setup (when you set
up AWS Elemental MediaConnect as a trusted entity).
type: string
SecretArn:
description: ' 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.'
type: string
Url:
description: 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.
type: string
required:
- RoleArn
type: object
FailoverConfig:
additionalProperties: false
description: The settings for source failover
properties:
RecoveryWindow:
description: Search window time to look for dash-7 packets
type: integer
State:
enum:
- ENABLED
- DISABLED
type: string
type: object
Source:
additionalProperties: false
description: The settings for the source of the flow.
properties:
Decryption:
additionalProperties: false
description: Information about the encryption of the flow.
properties:
Algorithm:
description: The type of algorithm that is used for the encryption (such
as aes128, aes192, or aes256).
enum:
- aes128
- aes192
- aes256
type: string
ConstantInitializationVector:
description: 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.
type: string
DeviceId:
description: 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.
type: string
KeyType:
default: static-key
description: The type of key that is used for the encryption. If no keyType
is provided, the service will use the default setting (static-key).
enum:
- speke
- static-key
- srt-password
type: string
Region:
description: 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.
type: string
ResourceId:
description: 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.
type: string
RoleArn:
description: The ARN of the role that you created during setup (when you
set up AWS Elemental MediaConnect as a trusted entity).
type: string
SecretArn:
description: ' 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.'
type: string
Url:
description: 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.
type: string
required:
- RoleArn
type: object
Description:
description: A description for the source. This value is not used or seen
outside of the current AWS Elemental MediaConnect account.
type: string
EntitlementArn:
description: The ARN of the entitlement that allows you to subscribe to content
that comes from another AWS account. The entitlement is set by the content
originator and the ARN is generated as part of the originator's flow.
type: string
IngestIp:
description: The IP address that the flow will be listening on for incoming
content.
type: string
IngestPort:
description: The port that the flow will be listening on for incoming content.
type: integer
MaxBitrate:
description: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
type: integer
MaxLatency:
default: 2000
description: The maximum latency in milliseconds. This parameter applies only
to RIST-based and Zixi-based streams.
type: integer
MinLatency:
default: 2000
description: The minimum latency in milliseconds.
type: integer
Name:
description: The name of the source.
type: string
Protocol:
description: The protocol that is used by the source or output.
enum:
- zixi-push
- rtp-fec
- rtp
- rist
- srt-listener
type: string
SourceArn:
description: The ARN of the source.
type: string
SourceIngestPort:
description: The port that the flow will be listening on for incoming content.(ReadOnly)
type: string
StreamId:
description: The stream ID that you want to use for this transport. This parameter
applies only to Zixi-based streams.
type: string
VpcInterfaceName:
description: The name of the VPC Interface this Source is configured with.
type: string
WhitelistCidr:
description: The range of IP addresses that should be allowed to contribute
content to your source. These IP addresses should be in the form of a Classless
Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
type: string
type: object
properties:
Source:
additionalProperties: false
description: The settings for the source of the flow.
properties:
Decryption:
additionalProperties: false
description: Information about the encryption of the flow.
properties:
Algorithm:
description: The type of algorithm that is used for the encryption (such
as aes128, aes192, or aes256).
enum:
- aes128
- aes192
- aes256
type: string
ConstantInitializationVector:
description: 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.
type: string
DeviceId:
description: 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.
type: string
KeyType:
default: static-key
description: The type of key that is used for the encryption. If no keyType
is provided, the service will use the default setting (static-key).
enum:
- speke
- static-key
- srt-password
type: string
Region:
description: 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.
type: string
ResourceId:
description: 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.
type: string
RoleArn:
description: The ARN of the role that you created during setup (when you
set up AWS Elemental MediaConnect as a trusted entity).
type: string
SecretArn:
description: ' 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.'
type: string
Url:
description: 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.
type: string
required:
- RoleArn
type: object
Description:
description: A description for the source. This value is not used or seen
outside of the current AWS Elemental MediaConnect account.
type: string
EntitlementArn:
description: The ARN of the entitlement that allows you to subscribe to content
that comes from another AWS account. The entitlement is set by the content
originator and the ARN is generated as part of the originator's flow.
type: string
IngestIp:
description: The IP address that the flow will be listening on for incoming
content.
type: string
IngestPort:
description: The port that the flow will be listening on for incoming content.
type: integer
MaxBitrate:
description: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
type: integer
MaxLatency:
default: 2000
description: The maximum latency in milliseconds. This parameter applies only
to RIST-based and Zixi-based streams.
type: integer
MinLatency:
default: 2000
description: The minimum latency in milliseconds.
type: integer
Name:
description: The name of the source.
type: string
Protocol:
description: The protocol that is used by the source or output.
enum:
- zixi-push
- rtp-fec
- rtp
- rist
- srt-listener
type: string
SourceArn:
description: The ARN of the source.
type: string
SourceIngestPort:
description: The port that the flow will be listening on for incoming content.(ReadOnly)
type: string
StreamId:
description: The stream ID that you want to use for this transport. This parameter
applies only to Zixi-based streams.
type: string
VpcInterfaceName:
description: The name of the VPC Interface this Source is configured with.
type: string
WhitelistCidr:
description: The range of IP addresses that should be allowed to contribute
content to your source. These IP addresses should be in the form of a Classless
Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
type: string
type: object
SourceFailoverConfig:
additionalProperties: false
description: The settings for source failover
properties:
RecoveryWindow:
description: Search window time to look for dash-7 packets
type: integer
State:
enum:
- ENABLED
- DISABLED
type: string
type: object
type:
enum:
- update
Permissions - mediaconnect:DescribeFlow, mediaconnect:UpdateFlow, mediaconnect:UpdateFlowSource