Class: Aws::MediaConnect::Types::SetSourceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb

Overview

Note:

When making an API call, you may pass SetSourceRequest data as a hash:

{
  decryption: {
    algorithm: "aes128", # accepts aes128, aes192, aes256
    constant_initialization_vector: "__string",
    device_id: "__string",
    key_type: "speke", # accepts speke, static-key, srt-password
    region: "__string",
    resource_id: "__string",
    role_arn: "__string", # required
    secret_arn: "__string",
    url: "__string",
  },
  description: "__string",
  entitlement_arn: "__string",
  ingest_port: 1,
  max_bitrate: 1,
  max_latency: 1,
  max_sync_buffer: 1,
  media_stream_source_configurations: [
    {
      encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
      input_configurations: [
        {
          input_port: 1, # required
          interface: { # required
            name: "__string", # required
          },
        },
      ],
      media_stream_name: "__string", # required
    },
  ],
  min_latency: 1,
  name: "__string",
  protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, fujitsu-qos
  sender_control_port: 1,
  sender_ip_address: "__string",
  stream_id: "__string",
  vpc_interface_name: "__string",
  whitelist_cidr: "__string",
}

The settings for the source of the flow.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#decryptionTypes::Encryption

The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.

Returns:



3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#entitlement_arnString

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.

Returns:

  • (String)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#ingest_portInteger

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

Returns:

  • (Integer)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#max_bitrateInteger

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

Returns:

  • (Integer)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#max_latencyInteger

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

Returns:

  • (Integer)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#max_sync_bufferInteger

The size of the buffer (in milliseconds) to use to sync incoming source data.

Returns:

  • (Integer)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#media_stream_source_configurationsArray<Types::MediaStreamSourceConfigurationRequest>

The media streams that are associated with the source, and the parameters for those associations.



3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#min_latencyInteger

The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

Returns:

  • (Integer)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the source.

Returns:

  • (String)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#protocolString

The protocol that is used by the source.

Returns:

  • (String)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#sender_control_portInteger

The port that the flow uses to send outbound requests to initiate connection with the sender.

Returns:

  • (Integer)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#sender_ip_addressString

The IP address that the flow communicates with to initiate connection with the sender.

Returns:

  • (String)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#stream_idString

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

Returns:

  • (String)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_interface_nameString

The name of the VPC interface to use for this source.

Returns:

  • (String)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end

#whitelist_cidrString

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.

Returns:

  • (String)


3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3105

class SetSourceRequest < Struct.new(
  :decryption,
  :description,
  :entitlement_arn,
  :ingest_port,
  :max_bitrate,
  :max_latency,
  :max_sync_buffer,
  :media_stream_source_configurations,
  :min_latency,
  :name,
  :protocol,
  :sender_control_port,
  :sender_ip_address,
  :stream_id,
  :vpc_interface_name,
  :whitelist_cidr)
  SENSITIVE = []
  include Aws::Structure
end