AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::MediaConnect::Types::AddOutputRequest

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 AddOutputRequest data as a hash:

{
  cidr_allow_list: ["__string"],
  description: "__string",
  destination: "__string",
  encryption: {
    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",
  },
  max_latency: 1,
  media_stream_output_configurations: [
    {
      destination_configurations: [
        {
          destination_ip: "__string", # required
          destination_port: 1, # required
          interface: { # required
            name: "__string", # required
          },
        },
      ],
      encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
      encoding_parameters: {
        compression_factor: 1.0, # required
        encoder_profile: "main", # required, accepts main, high
      },
      media_stream_name: "__string", # required
    },
  ],
  min_latency: 1,
  name: "__string",
  port: 1,
  protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener
  remote_id: "__string",
  smoothing_latency: 1,
  stream_id: "__string",
  vpc_interface_attachment: {
    vpc_interface_name: "__string",
  },
}

The output that you want to add to this flow.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cidr_allow_listArray<String>

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.

Returns:

  • (Array<String>)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#destinationString

The IP address from which video will be sent to output destinations.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#encryptionTypes::Encryption

The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Returns:



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#max_latencyInteger

The maximum latency in milliseconds for Zixi-based streams.

Returns:

  • (Integer)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#media_stream_output_configurationsArray<Types::MediaStreamOutputConfigurationRequest>

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



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  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)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the output. This value must be unique within the current flow.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

The port to use when content is distributed to this output.

Returns:

  • (Integer)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#protocolString

The protocol to use for the output.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#remote_idString

The remote ID for the Zixi-pull output stream.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#smoothing_latencyInteger

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

Returns:

  • (Integer)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  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)


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_interface_attachmentTypes::VpcInterfaceAttachment

The name of the VPC interface attachment to use for this output.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 525

class AddOutputRequest < Struct.new(
  :cidr_allow_list,
  :description,
  :destination,
  :encryption,
  :max_latency,
  :media_stream_output_configurations,
  :min_latency,
  :name,
  :port,
  :protocol,
  :remote_id,
  :smoothing_latency,
  :stream_id,
  :vpc_interface_attachment)
  SENSITIVE = []
  include Aws::Structure
end