update-flow-source¶

Description¶

Updates the source of a flow.

Synopsis¶

  update-flow-source
[--decryption <value>]
[--description <value>]
[--entitlement-arn <value>]
--flow-arn <value>
[--ingest-port <value>]
[--max-bitrate <value>]
[--max-latency <value>]
[--protocol <value>]
--source-arn <value>
[--stream-id <value>]
[--vpc-interface-name <value>]
[--whitelist-cidr <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--decryption (structure) The type of encryption used on the content ingested from this source.Algorithm -> (string)

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

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 -> (string)

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.

RoleArn -> (string)

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

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.

Shorthand Syntax:

Algorithm=string,ConstantInitializationVector=string,DeviceId=string,KeyType=string,Region=string,ResourceId=string,RoleArn=string,SecretArn=string,Url=string

JSON Syntax:

{
  "Algorithm": "aes128"|"aes192"|"aes256",
  "ConstantInitializationVector": "string",
  "DeviceId": "string",
  "KeyType": "speke"|"static-key",
  "Region": "string",
  "ResourceId": "string",
  "RoleArn": "string",
  "SecretArn": "string",
  "Url": "string"
}

--description (string) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

--entitlement-arn (string) The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator’s flow.

--flow-arn (string) The flow that is associated with the source that you want to update.

--ingest-port (integer) The port that the flow will be listening on for incoming content.

--max-bitrate (integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.

--max-latency (integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.

--protocol (string) The protocol that is used by the source.

Possible values:

zixi-push

rtp-fec

rtp

zixi-pull

rist

--source-arn (string) The ARN of the source that you want to update.

--stream-id (string) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

--vpc-interface-name (string) The name of the VPC Interface to configure this Source with.

--whitelist-cidr (string) 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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To update the source of an existing flow

The following update-flow-source example updates the source of an existing flow.

aws mediaconnect update-flow-source \
    --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow \
    --source-arn arn:aws:mediaconnect:us-east-1:111122223333:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource \
    --description 'Friday night show' \
    --ingest-port 3344 \
    --protocol rtp-fec \
    --whitelist-cidr 10.24.34.0/23

Output:

{
    "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow",
    "Source": {
        "IngestIp": "34.210.136.56",
        "WhitelistCidr": "10.24.34.0/23",
        "Transport": {
            "Protocol": "rtp-fec"
        },
        "IngestPort": 3344,
        "Name": "ShowSource",
        "Description": "Friday night show",
        "SourceArn": "arn:aws:mediaconnect:us-east-1:111122223333:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource"
    }
}

For more information, see Updating the Source of a Flow in the AWS Elemental MediaConnect User Guide.

Output¶

FlowArn -> (string)

The ARN of the flow that you want to update.

Source -> (structure)

The settings for the source of the flow.

DataTransferSubscriberFeePercent -> (integer)

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

Decryption -> (structure)

The type of encryption that is used on the content ingested from this source.

Algorithm -> (string)

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

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 -> (string)

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.

RoleArn -> (string)

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

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.

Description -> (string)

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

EntitlementArn -> (string)

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.

IngestIp -> (string)

The IP address that the flow will be listening on for incoming content.

IngestPort -> (integer)

The port that the flow will be listening on for incoming content.

Name -> (string)

The name of the source.

SourceArn -> (string)

The ARN of the source.

Transport -> (structure)

Attributes related to the transport stream that are used in the source.

CidrAllowList -> (list)

The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

(string)

MaxBitrate -> (integer)

The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.

MaxLatency -> (integer)

The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.

Protocol -> (string)

The protocol that is used by the source or output.

RemoteId -> (string)

The remote ID for the Zixi-pull stream.

SmoothingLatency -> (integer)

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

StreamId -> (string)

The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

VpcInterfaceName -> (string)

The name of the VPC Interface this Source is configured with.

WhitelistCidr -> (string)

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.

Table of Contents

Feedback

User Guide